You are here: Home > CLI Commands > Just_CLI_Topics > phonehome

phonehome

phonehome

auto-report

disable

enable

https <from_addr>

now

smtp <a.b.c.d> <from_addr> [port <port_num>] {size <max_size>] [user <username> pass <password>]

Description

This command configures the PhoneHome auto reporting feature.

Syntax

Parameter

Description

auto-report

The managed device will periodically contact Aruba support once a week to report any errors or changes to the managed device configuration or inventory. If the managed device has not reported any errors and its configuration file has not changed, no report will be sent.

NOTE: Before you enable auto-reporting, you must first enable the PhoneHome feature using the command phonehome enable.

disable

This parameter disables the PhoneHome feature. Phonehome automatic reporting is disabled by default.

enable

This parameter enables the PhoneHome feature.

now

Issue the phonehome now command in enable mode to immediately create and send a report from the managed device to Aruba support.

NOTE: Before you use the phonehome now command to create and send a report, you must first access the CLICommand-Line Interface. A console interface with a command line shell that allows users to execute text input as commands and convert these commands to appropriate functions. in config mode and issue the command phonehome enable to enable this feature.

https <from_addr>

Configure managed device to send PhoneHome reports to an Activate server using HTTPSHypertext Transfer Protocol Secure. HTTPS is a variant of the HTTP that adds a layer of security on the data in transit through a secure socket layer or transport layer security protocol connection.. The <from-addr> email address is used to properly identify the user sending the report.

smtp

Configure the SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server that will send email messages from the managed device to Aruba support.

<a.b.c.d>

IP address of the SMPT server

<from_addr>

Local email address from which the auto reporting messages will be sent. For example, admin@mycorp.com.

port <port_num>

(Optional) Port number from which the SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server will send auto reporting emails.

Default port number: 25.

size <max_size>

(Optional) If your SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server has a restriction on the size of the emails it can send, use this parameter to specify the maximum size limit. Any reports larger than this limit will be divided into multiple smaller emails.

user <username> pass <password>

(Optional) If your SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server requires user authentication before it can send an email message, enter the username and password for a valid user on your network.

Usage Guidelines

By default, managed device send PhoneHome reports to the Activate server using HTTPSHypertext Transfer Protocol Secure. HTTPS is a variant of the HTTP that adds a layer of security on the data in transit through a secure socket layer or transport layer security protocol connection..

Most deployments should retain the default behavior send PhoneHome reports via Activate. However, if the managed device is behind proxy server and does not have direct access to Internet, PhoneHome should be configured to send reports using SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission.. The following section of this document describes the benefits of each of these configurations options.

Sending Phonehome Reports using Activate

PhoneHome integration with Activate offers following benefits:

Simpler configuration. Phonehome only requires you to configure the email ID of the network administrator managing the device. as Activate already has information to accurately identify your managed device. If a DNSDomain Name System. A DNS server functions as a phone book for the intranet and Internet users. It converts human-readable computer host names into IP addresses and IP addresses into host names. It stores several records for a domain name such as an address 'A' record, name server (NS), and mail exchanger (MX) records. The Address 'A' record is the most important record that is stored in a DNS server, because it provides the required IP address for a network peripheral or element. server is not configured on the managed device, PhoneHome will query the public DNSDomain Name System. A DNS server functions as a phone book for the intranet and Internet users. It converts human-readable computer host names into IP addresses and IP addresses into host names. It stores several records for a domain name such as an address 'A' record, name server (NS), and mail exchanger (MX) records. The Address 'A' record is the most important record that is stored in a DNS server, because it provides the required IP address for a network peripheral or element. service (8.8.8.8) to resolve the Activate server IP address.

Smaller bandwidth requirements. When the PhoneHome feature sends the report to the Activate server, the PhoneHome report is zipped into a smaller package, then divided into smaller 1MB pieces before being sent to the server using secure HTTPSHypertext Transfer Protocol Secure. HTTPS is a variant of the HTTP that adds a layer of security on the data in transit through a secure socket layer or transport layer security protocol connection.. Only reports sent to Activate are zipped before they are sent, so reports sent to Activate use less bandwidth than a report sent to a SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server.

Enhanced  error management. If any individual portion of the report is not successfully received by the Activate server, PhoneHome makes up to three attempts to resend just that portion of the file, rather than resending the entire report. Reports sent via SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. must be resent in their entirety if any portion is not received by the SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server.

Automatic removal of old reports. Once the entire report has been sent to the Activate server, Activate sends an acknowledgment to the managed device, prompting the managed device to delete its local copy of the report.

Sending Reports using SMTP

If you configure the PhoneHome feature to use SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission., the PhoneHome status reports is sent in an email. When the managed device generates the report email with the PhoneHome data file attachment, it forwards the email to the local SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server configured on your local network, which then relays the message to Aruba technical support. If your email server requires the sender to be authenticated before message delivery, the managed device can connect to the SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server by supplying the sender’s user name and password.

When PhoneHome reports are sent using SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission., the PhoneHome report attachment is encrypted before it is transmitted to the SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server, and is decrypted by Aruba support the report it is received. If the PhoneHome status report email is larger than the maximum email size supported by your SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server, the managed device divides the PhoneHome attachment into multiple smaller attachments and sends the report to Aruba in multiple emails. If any individual portion of the report is not successfully received by the SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server, PhoneHome resends the entire report.

Example

The following command turns on the PhoneHome feature, enables weekly auto-reports, and identifies the SMTPSimple Mail Transfer Protocol. SMTP is an Internet standard protocol for electronic mail transmission. server to be used by this feature:

(host) [mynode] (config) #phonehome enable auto-report smtp 172.21.18.170 admin@mycorp.com

Command History

Release

Description

ArubaOS 8.0.0.0

Command Introduced.

Command Information

Platforms

License

Command Mode

All platforms

Base operating system.

The phonehome now command must be issued in enable mode. All other PhoneHome commands require config mode.

/*]]>*/