stcli services Commands

stcli services Commands

System services related operations.

stcli services [-h] [smtp | dns | ntp | asup | sch | remotesupport | timezone]

Syntax Description

Option

Required or Optional

Description
asup

One of set required.

Commands supported in the autosupport (ASUP) configuration namespace.

dns

One of set required.

Commands supported in the storage DNS configuration namespace.

ntp

One of set required.

Commands supported in the storage NTP configuration namespace.

remotesupport

One of set required.

Commands supported for support remote access.
sch

One of set required.

Commands supported in the Smart Call Home configuration namespace.
smtp

One of set required.

Commands supported in the storage SMTP for autosupport configuration namespace.

timezone

One of set required.

Commands supported in the timezone configuration namespace.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services command with at least one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services asup Commands

This section lists and describes the Cisco Automatic Support (ASUP) commands. ASUP enables you to proactively obtain information about failures and responds immediately. It also helps in planning system performance and capacity.


Note

ASUP relies on SMTP. Before you enable ASUP, ensure that you configure SMTP in your network.

stcli services asup [-h] {enable | disable | show | recipients}

Syntax Description

Option

Required or Optional

Description
disable

One of set required.

Disables ASUP.
enable

One of set required.

Enables ASUP.
recipients

One of set required.

Commands to support ASUP recipients list configuration.
show

One of set required.

Shows the ASUP configuration.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services asup command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services asup disable Command

Disables HX auto support (ASUP) support.

stcli services asup disable [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services asup disable command. 

# stcli services asup disable

stcli services asup enable Command

Enables HX auto support (ASUP) support.

stcli services asup enable [-h]

Command Default

No additional options.

Usage Guidelines

  1. Ensure SMTP is configured. See the stcli services asup smtp command.

  2. Run the stcli services asup enable command. 

# stcli services asup enable

stcli services asup recipients Commands

HX auto support (ASUP) recipient configuration operations.

stcli services asup recipients [-h] {set | clear | add | remove}

Syntax Description

Option

Required or Optional

Description
add

One of set required.

Adds ASUP email recipients to an existing list of ASUP recipients.
clear

One of set required.

Deletes the entire ASUP recipient list. To remove individual recipients, use asup recipients remove.

remove

One of set required.

Deletes the specified ASUP email recipients from an existing list.
set

One of set required.

Sets the ASUP recipient list. Replaces previously set list of recipients. To add recipients to an existing list, use asup recipients add.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services asup recipients command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

  • Use clear option to delete all recipients from an existing list of recipients.

  • Use remove option to delete specific email addresses from the list of recipients.

  • Use add option to add new email addresses to the list of recipients.

  • Use set option to replace the previous list of recipients with a new list of recipients.

stcli services asup recipients add Command

Adds ASUP email recipients to an existing list of ASUP recipients. The existing list can be currently empty. Use this command to add one or more recipients.

stcli services asup recipients add [-h] --recipients RECIPIENTS [RECIPIENTS . . .]

Syntax Description

Option

Required or Optional

Description
--recipients RECIPIENTS [RECIPIENTS . . .]

Required.

Add one or more email addresses to the current list of recipients that receive ASUP notifications.
Command Default

None. At least one recipient is required.

Usage Guidelines

Accompany the stcli services asup recipients add command with at least one recipient. Separate multiple recipients with a space between email addresses. 

# stcli services asup recipients add --recipients user1@mycompany.com user2@mycompany.com

stcli services asup recipients clear Command

Deletes the entire ASUP recipient list. To remove individual recipients, use asup recipients remove.

stcli services asup recipients clear [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services asup recipients clear command to delete all email addresses from the recipient list.

stcli services asup recipient remove Command

Deletes the specified individual email recipients from an existing list of ASUP recipients.

stcli services asup recipients remove [-h] --recipients RECIPIENTS [RECIPIENTS . . .]

Syntax Description

Option

Required or Optional

Description
--recipients RECIPIENTS [RECIPIENTS . . .]

Required.

Delete individual email addresses from the current list of recipients that receive ASUP notifications.
Command Default

None. At least one recipient is required.

Usage Guidelines

Accompany the stcli services asup recipients remove command with at least one recipient. Separate multiple recipients with a space between email addresses. 

# stcli services asup recipients remove --recipients user1@mycompany.com user2@mycompany.com

stcli services asup recipients set Command

Replaces an existing list of ASUP email recipients with a provided list of email addresses. This deletes all recipients on the existing list. To add recipients to an existing list and not deleted the existing recipients, use asup recipients add.

stcli services asup recipients set [-h] --recipients RECIPIENTS [RECIPIENTS . . .]

Syntax Description

Option

Required or Optional

Description
--recipients RECIPIENTS [RECIPIENTS . . .]

Required.

Add one or more email addresses to replace the existing list of recipients to receive ASUP notifications. Separate email recipients with a space.

Command Default

None. At least one recipient is required.

Usage Guidelines

Accompany the stcli services asup recipients set command with at least one recipient. Separate multiple recipients with a space between email addresses. 

# stcli services asup recipients set --recipients user1@mycompany.com user2@mycompany.com

stcli services asup show Command

Shows the ASUP configuration, this includes the ASUP recipient list and whether ASUP is enabled or disabled.

stcli services asup show [-h]

Command Default

No additional options available.

Usage Guidelines

Run the stcli services asup show command to list the applied ASUP settings.

This sample response indicates that ASUP is not enabled and there are no email addresses in the recipient list.

# stcli services asup show
recipientList:
enabled: False

stcli services dns Commands

Domain Name Server (DNS) server configuration operations. DNS is a hierarchical distributed naming system for computers, services, or any resource connected to the Internet or a private network.

stcli services dns [-h] {show | set | add | remove}

Syntax Description

Option

Required or Optional

Description
add

One of set required.

Adds servers to the DNS server list.
set

One of set required.

Replace the DNS server list with this new list.
show

One of set required.

Show the DNS server list.
remove

One of set required.

Delete a server from the DNS server list.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services dns command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services dns add Command

Adds servers to the DNS server list.

stcli services dns add [-h] --dns DNSSERVER [DNSSERVER . . .]

Syntax Description

Option

Required or Optional

Description
--dns DNSSERVER [DNSSERVER . . .]

Required.

List at least one server to add to the list of DNS servers.

Command Default

None. At least one server ID is required.

Usage Guidelines

Accompany the stcli services dns add command with at least one DNS server ID. Separate servers with a space. 

# stcli services dns add --dns 10.60.8.9

stcli services dns remove Command

Removes one or more or all servers from the existing list of servers in the DNS server list.

stcli services dns remove [-h] --dns DNSSERVER [DNSSERVER . . .]

Syntax Description

Option

Required or Optional

Description
--dns DNSSERVER [DNSSERVER . . .]

Optional.

List at least one server to delete from the current list of DNS servers.

Command Default

Default removes all DNS servers from the list.

Usage Guidelines

Accompany the stcli services dns remove command with none, one, or more DNS server IDs. Separate servers with a space. 

# stcli services dns remove --dns 10.60.6.7

stcli services dns set Command

Replaces existing list of servers in the DNS server list. Deletes current list To add servers to an existing list, use dns add.

stcli services dns set [-h] --dns DNSSERVER [DNSSERVER . . .]

Syntax Description

Option

Required or Optional

Description
--dns DNSSERVER [DNSSERVER . . .]

Required.

List at least one server to replace the current list of DNS servers.

Command Default

None. At least one server ID is required.

Usage Guidelines

Accompany the stcli services dns set command with at least one DNS server ID. Separate servers with a space. 

# stcli services dns set --dns 10.60.1.1

stcli services dns show Command

Displays the DNS server list.

stcli services dns show [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services dns show command. 

# stcli services dns show
10.64.1.8
10.64.1.9

stcli services ntp Commands

The HX Data Platform Network Time Protocol (NTP) configuration operations.

NTP is a protocol that is used to synchronize computer clock times in a network of computers so that you can correlate events when you receive system logs and other time-specific events from multiple network devices. NTP uses the User Datagram Protocol (UDP) as its transport protocol. All NTP communications use Coordinated Universal Time (UTC).

stcli services ntp [-h] {add | set | show | remove}

Syntax Description

Option

Required or Optional

Description
add

One of set required.

Add one or more servers to the list of storage NTP servers.

set

One of set required.

Replace the existing list of NTP servers with the listed DNS servers.

show

One of set required.

Display the list of storage NTP servers.
remove

One of set required.

Remove one or more servers from the list of storage NTP servers.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services ntp command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services ntp add Command

Add one or more servers to the list of storage DNS servers.

stcli services ntp add [-h] --ntp NTPSERVER [NTPSERVER . . .]

Syntax Description

Option

Required or Optional

Description
--ntp NTPSERVER [NTPSERVER . . .]

Required.

Add one or more servers to the list of storage NTP servers.

Command Default

None. At least one server ID is required.

Usage Guidelines

Accompany the stcli services ntp add command with at least one server ID. 

# stcli services ntp add --ntp 136.158.1.0

stcli services ntp remove Command

Delete one or more servers from the list of storage DNS servers.

stcli services ntp remove [-h] --ntp NTPSERVER [NTPSERVER . . .]

Syntax Description

Option

Required or Optional

Description
--ntp NTPSERVER [NTPSERVER . . .]

Optional.

Remove one or more servers from the list of storage DNS servers.

Command Default

Default removes all NTP servers from the list of storage NTP servers.

Usage Guidelines

Accompany the stcli services ntp remove command with at least one server ID. 

# stcli services ntp remove --ntp 136.158.1.0

stcli services ntp set Command

Replaces existing list of NTP servers with new list. To add servers to an existing list, use ntp add.

stcli services ntp set [-h] --ntp NTPSERVER [NTPSERVER . . .]

Syntax Description

Option

Required or Optional

Description
--ntp NTPSERVER [NTPSERVER . . .]

Required.

Provide one or more servers to replace the current the list of storage NTP servers.

Command Default

None. At least one server ID is required.

Usage Guidelines

Accompany the stcli services ntp set command with at least one server ID. 

# stcli services ntp set --ntp 10.12.1.1

stcli services ntp show Command

Display the list of storage DNS servers.

stcli services ntp show [-h]

Command Default

No options available.

Usage Guidelines

Run the stcli services ntp show command. 

# stcli services ntp show
0.company.pool.ntp.org
ntp.ubuntu.com

stcli services sch Commands

This section lists and describes the Cisco Smart Call Home (SCH) commands. Smart call home provides continuous monitoring, proactive diagnostics, alerts, service ticket notifications, and remediation recommendations about the HX storage cluster to the designated ASUP customer contacts. It also provides a means to provide the information through HTTPS and a proxy server, if needed.


Note

If your HX storage cluster is behind a firewall, a proxy server is required for access.

The stcli services cli support both HTTP and HTTPS proxy.

stcli services sch [-h] {enable | disable | show | ping | clear | set}

Syntax Description

Option

Required or Optional

Description
clear

One of set required.

Clears the smart call home configuration.
disable

One of set required.

Disables smart call home.
enable

One of set required.

Enables smart call home.
ping

One of set required.

Pings the smart call home endpoint.
set

One of set required.

 Commands for smart call home registration, including proxy server for HTTPS access
show

One of set required.

Shows the smart call home configuration.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services sch command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services sch clear Command

Removes the smart call home email and proxy settings from the storage cluster configuration.

stcli services sch clear [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services sch clear command to remove the smart call home notification email and proxy settings from storage cluster configuration. 

# stcli services sch clear

stcli services sch disable Command

Disables HX smart call home.

stcli services sch disable [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services sch disable command. 

# stcli services sch disable

stcli services sch enable Command

Enables HX smart call home. See stcli services sch set to configure the notification email address.

stcli services sch enable [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services sch enable command. 

# stcli services sch enable

stcli services sch ping Command

Pings the Smart Call Home endpoint.

stcli services sch ping [-h]

Command Default

No options.

Usage Guidelines

Run the stcli services sch ping command.

This example shows :

# stcli services sch ping
ping to callhome endpoint was successful

stcli services sch set Command

Configures the smart call home service required contact and proxy server.


Important

Please enter password when prompted.

The stcli services cli support both HTTP and HTTPS proxy.

stcli services sch set [-h] --email EMAILADDRESS [--proxy-url PROXYURL] [--proxy-port PROXYPORT] [--proxy-user PROXYUSER] [--portal-url PORTALURL] [--enable-proxy ENABLEPROXY]

Syntax Description

Option

Required or Optional

Description
--email EMAILADDRESS

Required.

Add an email address for someone to receive email from Cisco support. Recommendation is to use a distribution list or alias.

--enable-proxy ENABLEPROXY

Optional.

Explicitly enable or disable use of proxy.

--portal-url PORTALURL

Optional.

Specify an alternative Smart Call Home portal URL, if applicable.

--proxy-url PROXYURL

Optional.

Specify the HTTP or HTTPS proxy URL, if applicable.

--proxy-port PROXYPORT

Optional.

Specify the HTTP or HTTPS proxy port, if applicable.

--proxy-user PROXYUSER

Optional.

Specify the HTTP or HTTPS proxy user, if applicable.

Specify the HTTP or HTTPS proxy password, when prompted.

Command Default

None. Email address is required. Proxy server is not configured by default.

Usage Guidelines

Accompany the stcli services sch set command with an email recipient address. Set the proxy server if your HX storage cluster is behind a firewall.

To use the smart call home service, ensure it is enabled. See the stcli services sch show and stcli services sch enable commands. 

# stcli services sch set --email alias@mycompany.com

stcli services sch show Command

Shows the smart call home configuration, this includes configured notification email and proxy settings, and whether smart call home is enabled or disabled.

stcli services sch show [-h]

Command Default

No additional options available.

Usage Guidelines

Run the stcli services sch show command to list the applied smart call home settings.

This sample response indicates that smart call home is enabled, but the email addresses and proxy settings are not configured.

# stcli services sch show
proxyPort: 0
proxyUser: 
enabled: True
proxyPassword: 
cloudEnvironment: production
proxyUrl: 
emailAddress: 
portalUrl: 
cloudAsupEndpoint: https://diag-hyperflex.io/

stcli services remotesupport Commands

This section lists and describes the remote support commands. This command allows Cisco support to access your HX storage cluster to collect information about cluster operations, for example, configured notification email and proxy settings and support triggered support bundles.

This is enabled by default.

stcli services remotesupport [-h] {set | show}

Syntax Description

Option

Required or Optional

Description
set

One of set required.

Commands to configure remote support.
show

One of set required.

Shows the remote support configuration.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services remotesupport command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services remotesupport set Command

Set configuration for remote support access and actions.

stcli services remotesupport set [-h] --enable ENABLE_RS_VALUE [--enable-support-bundle-action ENABLE_RSB_VALUE]

Syntax Description

Option

Required or Optional

Description
--enable ENABLE_RS_VALUE

Required.

Enable or disable remote support. Specify either value true or false.

--enable-support-bundle-action ENABLE_RSB_VALUE

Optional.

Enable or disable support bundle actions. Specify either true or false.

Allows TAC to remotely trigger building a support bundle.

Command Default

Remote support is enabled by default.

Usage Guidelines

Accompany the stcli services remotesupport set command with the required parameter. 

# stcli services remotesupport set --enable false

stcli services remotesupport show Command

Shows the remote support configuration, this includes configured notification email and proxy settings, and whether remote support is enabled or disabled and if support triggered support bundles are enabled or disabled.

stcli services remotesupport show [-h]

Command Default

No additional options available.

Usage Guidelines

Run the stcli services remotesupport show command to list the applied settings.

This sample response indicates that remote access by support and remotely triggering support bundles are enabled.

# stcli services remotesupport show
enableSupportBundleAction: True
enabled: True

stcli services smtp Commands

The HX Data Platform Simple Mail Transfer Protocol (SMTP) configuration options. SMTP is an Internet standard for email transmission. The SMTP servers are used with the HX ASUP feature.

stcli services smtp [-h] {show | set | clear}

Syntax Description

Option

Required or Optional

Description
clear

One of set required.

Removes all SMTP servers from the storage cluster configuration settings.
set

One of set required.

Add all SMTP servers to the storage cluster configuration.
show

One of set required.

Lists all SMTP servers configured for the storage cluster.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services smtp command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services smtp clear Command

Removes all SMTP servers from the storage cluster configuration settings.

stcli services smtp clear [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services smtp clear command to remove all SMTP servers from storage cluster configuration.

To verify the SMTP servers are removed, check that the /etc/msmtprc file is missing. 

# stcli services smtp clear

stcli services smtp set Command

Adds SMTP servers to the storage cluster configuration settings.

stcli services smtp set [-h] --smtp SMTPSERVER --fromaddress FROMADDRESS

Syntax Description

Option

Required or Optional

Description
--smtp SMTPSERVER

Required.

The hosting address of the SMTP server.
--fromaddress FROMADDRESS

Required.

Email address to send Auto Support emails from. The address used by the SMTP server to send email notifications to the recipients.

Command Default

None. Server information is required.

Usage Guidelines

Accompany the stcli services smtp set command with the required parameters.

To verify the SMTP servers are configured, check the /etc/msmtprc file. 

# stcli services smtp set --smtp mailhost.eng.mycompany.com --fromAddress smtpnotice@mycompany.com

stcli services smtp show Command

Displays the storage cluster configured SMTP servers.

stcli services smtp show [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services smtp show command to view all SMTP servers in storage cluster configuration. 

# stcli services smtp show
smtpServer: mailhost.eng.mycompany.com
fromAddress: admin@mycompany.com

stcli services timezone Commands

HX Data Platform timezone configuration operations.

stcli services timezone [-h] {show | set}

Syntax Description

Option

Required or Optional

Description
set

One of set required.

Specifies the time zone for the controller VMs.
show

One of set required.

Displays the system time zone that is currently set.

Command Default

None. One option from the set is required.

Usage Guidelines

Accompany the stcli services timezone command with one of the positional arguments enclosed in { } or optional arguments enclosed in [ ].

stcli services timezone set Command

Specifies the time zone for the controller VMs.

stcli services timezone set [-h] --timezone TIMEZONE

Syntax Description

Option

Required or Optional

Description
--timezone TIMEZONE

Required.

Specify a value for the time zone.

For a list of valid time zone values, go to:

http://manpages.ubuntu.com/manpages/jaunty/ma%20n3/DateTime::TimeZone::Catalog.3pm.html

  • Ensure that you specify a (case-sensitive) value for the time zone only from this list; for example: Europe/Paris or America/Los_Angeles.

  • Any value that is not in this list is invalid.

  • If you specify an invalid time zone, the system reverts to GMT.

Command Default

None. Timezone is required.

Usage Guidelines

Accompany the stcli services timezone set command with a valid timezone. 

# stcli services timezone set --timezone America/Los_Angeles

stcli services timezone show Command

Displays the system time zone that is currently set for the controller VMs.

stcli services timezone show [-h]

Command Default

No additional options.

Usage Guidelines

Run the stcli services timezone show command to view the timezone currently set. 

# stcli services timezone show
America/New_York