--- title: Config-Mode Commands slug: ps/help/en_us/sd/25x/cli/Daj0-config-mode-commands docTags: createdAt: 2026-10-06T15:00:39.541Z --- ### ntp peer key :::Paragraph{indent="1"} Configures an NTP peer with an authentication key ID. ::: ### Syntax ```bash [no] ntp peer host-name | ip-addr key key-id ``` ### Parameters ```bash hostname | ip-addr ``` :::Paragraph{indent="1"} Specify the NTP peer hostname or IP address. ::: ```bash key key-id [key id, ...] ``` :::Paragraph{indent="1"} Specify the key identifier. The key ID values must be in the range 1 - 65534. You can specify multiple key IDs in the same list, separated by commas. When specifying multiple key IDs separated by commas, you must enclose them in quotes. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option removes the authentication key from the NTP peer configuration. ::: :::Paragraph{indent="1"} NTP authentication involves three steps that you can perform in any order: ::: :::Paragraph{listStyleType="disc" indent="2"} Configure a key ID using the **ntp authentication** command. ::: :::Paragraph{listStyleType="disc" indent="2"} Add the configured key ID to the trusted keys list using the **ntp authentication trusted-keys** command. ::: :::Paragraph{listStyleType="disc" indent="2"} Configure the NTP server or peer with the key ID using the **ntp server key** or **ntp peer key** command. ::: ### Examples ```bash amnesiac (config) # ntp peer 10.10.10.1 key 56732 ``` ### Related Commands :::Paragraph{indent="1"} [show ntp](docId\:q-wP5fTzpWO2TO-RsyDPo), [show ntp active-peers](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### ntp server :::Paragraph{indent="1"} Configures an NTP server with the default NTP version number or with a specified version number. ::: ### Syntax ```bash [no] ntp server hostname | ip-addr | [version number] ``` ### Parameters ```bash hostname | ip-addr ``` :::Paragraph{indent="1"} Specify the hostname or IP address of the NTP server to synchronize with. ::: ```bash version number ``` :::Paragraph{indent="1"} Specify the NTP version number of this server. You do not need to specify the version number for the **no ntp server** command. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option removes an NTP server. ::: ### Examples ```bash amnesiac (config) # ntp server 10.10.10.1 ``` ### Related Commands :::Paragraph{indent="1"} [show ntp](docId\:q-wP5fTzpWO2TO-RsyDPo), [show ntp active-peers](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### ntp server enable :::Paragraph{indent="1"} Enables an NTP server. ::: ### Syntax ```bash [no] ntp server [ hostname | ip-addr ] enable ``` ### Parameters ```bash hostname | ip-addr ``` :::Paragraph{indent="1"} Specify the hostname or IP address of the NTP server. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option removes an NTP server. ::: ### Examples ```bash amnesiac (config) # ntp server companyserver enable ``` ### Related Commands :::Paragraph{indent="1"} [show ntp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### ntp server key :::Paragraph{indent="1"} Configures an NTP server with an authentication key ID. ::: ### Syntax ```bash [no] ntp server hostname | ip-addr key key-id ``` ### Parameters ```bash hostname | ip-addr ``` :::Paragraph{indent="1"} Specify the hostname or IP address of the NTP server to authenticate. ::: ```bash key key-id ``` :::Paragraph{indent="1"} Specify the key identifier. The key ID values must be in the range 1 - 65534. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** version of the command removes the authentication key from the NTP server. ::: :::Paragraph{indent="1"} NTP authentication involves three steps that you can perform in any order: ::: :::Paragraph{listStyleType="disc" indent="2"} Configure a key ID using the **ntp authentication** command. ::: :::Paragraph{listStyleType="disc" indent="2"} Add the configured key ID to the trusted keys list using the **ntp authentication trusted-keys** command. ::: :::Paragraph{listStyleType="disc" indent="2"} Configure the NTP server or peer with the key ID using the **ntp server key** or **ntp peer key** command. ::: ### Examples ```bash amnesiac (config) # ntp server companyserver key 56732 ``` ### Related Commands :::Paragraph{indent="1"} [ntp authentication](docId:2rhKUtqx7Iti1A_X79KfL), [ntp authentication trusted keys](docId:2rhKUtqx7Iti1A_X79KfL), [ntp peer key](docId\:Daj0PxouZD3s712K5TKUW), [show ntp authentication](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### papi rest access\_code import :::Paragraph{indent="1"} Imports an existing REST access code. ::: ### Syntax ```bash [no] papi rest access_code import desc description data data ``` ### Parameters ```bash desc description ``` :::Paragraph{indent="1"} Describe how the access code will be used. ::: ```bash data data ``` :::Paragraph{indent="1"} Copy and enter the raw data output generated by the **papi rest access\_code generate** command on a peer appliance. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **papi rest access\_code import** command to import access codes generated by another appliance so that a client can use the same access code to communicate through the REST API to multiple appliances. ::: ### Examples ```bash amnesiac (config) # papi rest access_code import desc cascadeflow data ``` ### Related Commands :::Paragraph{indent="1"} [show papi rest access\_codes](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### remote dhcp :::Paragraph{indent="1"} Enables DHCP on the remote management port. ::: ### Syntax ```bash remote dhcp ``` ### Examples ```bash amnesiac (config) # remote dhcp ``` ### Related Commands :::Paragraph{indent="1"} [show remote ip](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### remote ip address :::Paragraph{indent="1"} Manually sets the IP address of the remote management port. ::: ### Syntax ```bash remote ip address ip-addr ``` ### Parameters ```bash ip-addr ``` :::Paragraph{indent="1"} Specify the IP address to assign to the remote management port. ::: ### Usage Guidelines :::Paragraph{indent="1"} Access to the appliance through the remote port requires the use of the IPMI tool utility. You can download a Linux version at http\://sourceforge.net/projects/ipmitool/files/. You can obtain a Windows version of the IPMI tool on the Document CD that ships with your system or from Ivanti Support. ::: :::Paragraph{indent="1"} This utility must to be run on an administrator's system outside of the appliance to access the remote port functions. Check the man page for IPMItool for a full list of capabilities (although not all the commands are supported on RiOS hardware platforms). ::: :::Paragraph{indent="1"} To configure the remote management port: ::: :::Paragraph{listStyleType="disc" indent="2"} Physically connect the REMOTE port to the network. You cable the remote management port to the Ethernet network in the same manner as the Primary interface. ::: :::Paragraph{listStyleType="disc" indent="2"} Install the IPMItool on the client machine. ::: :::Paragraph{listStyleType="disc" indent="2"} Assuming the IP address is 192.168.100.100, the netmask is 255.255.255.0, and the default gateway is 192.168.100.1, assign an IP address to the remote management port: ::: ```bash amnesiac (config) # remote dhcp - or - amnesiac (config) # remote ip address 192.168.100.100 amnesiac (config) # remote ip netmask 255.255.255.0 amnesiac (config) # remote ip default-gateway 192.168.100.1 ``` :::Paragraph{listStyleType="disc" indent="2"} Verify the IP address is set properly. ::: ```bash amnesiac (config) # show remote ip ``` :::hint{type="info"} Ping the new management IP address from a remote computer, and verify it replies. ::: :::Paragraph{indent="1"} To secure the remote port, assign a password to the port: ::: ```bash amnesiac (config) # remote password ``` :::Paragraph{indent="1"} Set the remote port bit-rate to match the current serial port bitrate. Typically, this value is 9.6. ::: ```bash amnesiac (config) # remote bitrate 9.6 ``` :::Paragraph{indent="1"} To activate the serial connection: ::: ```bash ipmitool -I lanplus -H 192.168.100.100 -P "" sol activate ``` :::Paragraph{indent="1"} Press the Tilde character (\~) to end the serial connection. ::: :::hint{type="info"} While your serial connection is established, the actual serial console is disabled. Ending the remote serial connection cleanly with Tilde (\~) re-enables the real serial port. If you fail to exit cleanly your actual serial port might not reactivate. If your serial port fails to reactivate, reconnect remotely and exit cleanly using Tilde (\~). ::: ### Examples ```bash amnesiac (config) # remote ip address 192.168.100.100 ``` ### Related Commands :::Paragraph{indent="1"} [show remote ip](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### remote ip default-gateway :::Paragraph{indent="1"} Manually sets the default gateway of the remote management port. ::: ### Syntax ```bash remote ip default-gateway ip-addr ``` ### Parameters ```bash ip-addr ``` :::Paragraph{indent="1"} Specify the IP address of default gateway to assign to remote management port. ::: ### Examples ```bash amnesiac (config) # remote ip default-gateway 10.0.0.2 ``` ### Related Commands :::Paragraph{indent="1"} [show remote ip](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### remote ip netmask :::Paragraph{indent="1"} Manually sets the subnet mask of the remote management port. ::: ### Syntax ```bash remote ip netmask netmask ``` ### Parameters ```bash netmask ``` :::Paragraph{indent="1"} Specify the subnet mask to assign to the remote management port. ::: ### Examples ```bash amnesiac (config) # remote ip netmask 255.255.255.0 ``` ### Related Commands :::Paragraph{indent="1"} [show remote ip](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### remote password :::Paragraph{indent="1"} Sets the password to remotely connect to the remote management port. ::: ### Syntax ```bash [no] remote password password ``` ### Parameters ```bash password ``` :::Paragraph{indent="1"} Specify the password to connect to the remote management port. ::: ### Usage Guidelines :::Paragraph{indent="1"} To set a remote management port password: ::: :::Paragraph{listStyleType="disc" indent="2"} On the appliance, assign a password to the remote management port: ::: ```bash amnesiac (config) # remote password TestPassword ``` :::Paragraph{listStyleType="disc" indent="2"} Using the IPMItool on a remote computer, view the power status of the appliance. If you are using the Windows version of IPMItool, replace all references to** ipmitool** with ipmitool.exe. ::: ```bash ipmitool -H -P "testpassword" chassis power status ``` :::Paragraph{indent="1"} The displayed output should state** Chassis Power is on**. ::: :::hint{type="info"} You can download a Linux version at http\://sourceforge.net/projects/ipmitool/files/. You can obtain a Windows version of the IPMI tool on the Document CD that ships with your system or from Ivanti Support. ::: ### Examples ```bash amnesiac (config) # remote password TestPassword ``` ### Related Commands :::Paragraph{indent="1"} [show remote ip](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### resolve host-labels :::Paragraph{indent="1"} Forces the system to resolve host labels immediately. ::: ### Syntax ```bash resolve host-labels ``` ### Usage Guidelines :::Paragraph{indent="1"} You can use the **resolve host-labels** command to force a resolve operation instead of waiting for the daily automatic resolve instance. Every time this command is executed, the next automatic resolve instance is reset to occur 24 hours later. ::: ### Examples ```bash amnesiac # resolve host-labels ``` ### Related Commands :::Paragraph{indent="1"} [host-label](docId:2rhKUtqx7Iti1A_X79KfL), [show host-label](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### secure-vault :::Paragraph{indent="1"} Manages the secure vault password and unlocks the secure vault. ::: ### Syntax ```bash secure vault new-password password | reset-password old-password | unlock password ``` ### Parameters ```bash new-password password ``` :::Paragraph{indent="1"} Specify an initial or new password for the secure vault. ::: ```bash reset-password old-password ``` :::Paragraph{indent="1"} Specify the old secure vault password to reset it. ::: ```bash unlock password ``` :::Paragraph{indent="1"} Specify the current password to unlock the secure vault. ::: ### Usage Guidelines :::Paragraph{indent="1"} The secure vault is an encrypted file system on the appliance where all SSL server settings, other certificates (the CA, peering trusts, and peering certificates) and the peering private key are stored. The secure vault protects your SSL private keys and certificates when the appliance is not powered on. ::: :::Paragraph{indent="1"} You can set a password for the secure vault. The password is used to unlock the secure vault when the appliance is powered on. After rebooting the appliance, SSL traffic is not optimized until the secure vault is unlocked with the **unlock \** parameter. ::: :::Paragraph{indent="1"} Data in the secure vault is always encrypted, whether or not you choose to set a password. The password is used only to unlock the secure vault. ::: :::Paragraph{indent="1"} To change the secure vault password: ::: :::Paragraph{listStyleType="disc" indent="2"} Reset the password with the **reset-password \** parameter. ::: :::Paragraph{listStyleType="disc" indent="2"} Specify a new password with the **new-password \** parameter. ::: ### Examples ```bash amnesiac (config) # secure-vault unlock mypassword ``` ### show ssc access-profile :::Paragraph{indent="1"} Displays details for a specified access profile. An access profile is used for vTM user authentication only. ::: ### Syntax ```bash show ssc access-profile access-profile-name access-profile-name ``` ### Parameters ```bash access-profile-name ``` :::Paragraph{indent="1"} Specify the name of the required access profile. ::: ### Examples ```bash amnesiac (config) # show ssc access-profile access-profile-name "LDAP All" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | LDAP All | | Unique ID | Access-Profile-ZRVA-MXIE-MI92-U787 | | Authenticator | LDAP Server | | Permission Groups | admin | +-------------------+------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc access-profile add-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile create access-profile-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile list](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile update access-profile-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc analytics-profile :::Paragraph{indent="1"} Displays details for a specified analytics profile. This is used for vTM analytics purposes. ::: ### Syntax ```bash show ssc analytics-profile id ``` ### Parameters ```bash id ``` :::Paragraph{indent="1"} Specify a unique identifier for the analytics profile, either its tag or UUID. ::: ### Examples ```bash *** list all analytics profiles *** amnesiac (config) # ssc analytics-profile list +---------------------------------------+----------------+ | ID | Tag | +---------------------------------------+----------------+ | Analytics-Profile-6IQG-F6UQ-8C11-7G8F | Audit + System | | Analytics-Profile-F5V3-S912-G3UP-HPNR | Event | | Analytics-Profile-XNAH-H9J1-0MQM-BK59 | Audit | | Analytics-Profile-I6DJ-RRQV-KQ5Z-HY7J | Event + System | | Analytics-Profile-SXSR-UCDA-JJDS-1Q3K | Audit + Event | | Analytics-Profile-CHM8-D0PC-58BW-I8GI | System | +---------------------------------------+----------------+ *** show details for a specific analytics profile *** amnesiac (config) # show ssc analytics-profile id "Event + System" +---------------------------+----------------------------------------+ | Field | Value | +---------------------------+----------------------------------------+ | tag | Event + System | | enable_transaction_export | True | | vtm_logs_to_export | Event Log, System - authentication log | | analytics_profile_id | Analytics-Profile-I6DJ-RRQV-KQ5Z-HY7J | +---------------------------+----------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc analytics-profile create](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc analytics-profile list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc analytics-profile update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc app-template :::Paragraph{indent="1"} Displays details for a specified application template. ::: ### Syntax ```bash show ssc app-template template-name template-id ``` ### Parameters ```bash template-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the application template, either its tag or UUID. ::: ### Examples ```bash *** list all application templates *** amnesiac (config) # ssc app-template list +----------------------------+ | Templates | +----------------------------+ | Http Service Template__1.0 | +----------------------------+ *** show details for a specific application template *** amnesiac (config) # show ssc app-template template-name "Http Service Template__1.0" +-------------------+-----------------------------------------------------------... | Field | Value +-------------------+-----------------------------------------------------------... | description | Load balance a http service | required_features | [u''] | children | None | name | Http Service Template | parameters | [ | | { | | "name": "Specify the back-end nodes", | | "parameters": [ | | { | | "default": [ | | "127.0.0.1:80", | | "127.0.0.2:80" | | ], | | "description": "Please enter the hostname and ... | | "name": "pool_nodes", | | "type": "array" | | } | | ] | | }, | | { | | "name": "Specify the service", | | "parameters": [ | | { | | "default": "Service Name", | | "description": "A brief name to identify the ... | | "name": "instance_name", | | "type": "string" | | }, | | { | | "default": 80, | | "description": "Please specify a port for the ... | | "name": "public_port", | | "type": "number" | | } | | ] | | } | | ] | author | Nick Davidson and Paul Carroll | min_vtm_version | 18.2 | version | 1.0 | date_created | 2019-03-13 14:13:04 | template_id | Http Service Template__1.0 +-------------------+-----------------------------------------------------------... ``` ### Related Commands :::Paragraph{indent="1"} [show ssc app-template-instance](docId\:Daj0PxouZD3s712K5TKUW), [ssc app-template import](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc app-template-instance :::Paragraph{indent="1"} Displays details for a specified application template instance. ::: ### Syntax ```bash show ssc app-template-instance template-instance-name template_instance-id ``` ### Parameters ```bash template_instance-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the application template instance, either its tag or UUID. ::: ### Examples ```bash *** list all application templates *** amnesiac (config) # ssc app-template-instance list +-------------------------------+---------------------+----------------------------+ | Template Instance | Cluster ID | Template ID + --------------------------------+---------------------+----------------------------+ | Template-Instance-EGSR...GS45 | Cluster-CRCF...Z5WS | Http Service Template__1.0 | +-------------------------------+---------------------+----------------------------+ *** show details for a specific application template instance *** amnesiac (config) # show ssc app-template-instance template-instance-name Template-Instance-EGSR-J5D2-UKIE-GS45 +----------------------+---------------------------------------+ | Field | Value | +----------------------+---------------------------------------+ | template_instance_id | Template-Instance-EGSR-J5D2-UKIE-GS45 | | tag | | | cluster_id | Cluster-CRCF-9WDA-T1HE-Z5WS | | result | None | | children | None | | parameters | { | | | "instance_name": "Web Server", | | | "pool_nodes": [ | | | "127.0.0.1:80", | | | "127.0.0.2:80" | | | ], | | | "public_port": 80 | | | } | | pending_action | None | | template_id | Http Service Template__1.0 | +----------------------+---------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc app-template ](docId\:Daj0PxouZD3s712K5TKUW), [ssc app-template import](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc backup sd-va config :::Paragraph{indent="1"} Displays the configured settings for the Services Director VA backup service. ::: ### Syntax ```bash show ssc backup sd-va config ``` ### Usage Guidelines :::Paragraph{indent="1"} The command returns the following values: ::: :::Paragraph{listStyleType="disc" indent="2"} remote-sys: IP address of the remote system. ::: :::Paragraph{listStyleType="disc" indent="2"} remote-sync-freq: The synchronization frequency (local to remote), expressed as a number of units. Units are days (d), hours (h) and minutes (m). For example, "2d" represents two days. ::: :::Paragraph{listStyleType="disc" indent="2"} backup-data-trans: The protocol to perform the remote transfer ("scp" or "ftp"). 2 ::: :::Paragraph{listStyleType="disc" indent="2"} remote-sys-user: Remote username. ::: :::Paragraph{listStyleType="disc" indent="2"} backup-retain: The number of local backup files to be retained. For example, 3. ::: :::Paragraph{listStyleType="disc" indent="2"} remote-sys-path: Remote directory for backup files. For example, "/var/home/root". ::: :::Paragraph{listStyleType="disc" indent="2"} backup-freq: The backup frequency (to local), expressed as a number of units. Units are days (d), hours (h) and minutes (m). For example, "6h" represents six hours. ::: :::Paragraph{listStyleType="disc" indent="2"} remote-sys-pass: Password for the remote user. ::: :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc backup sd-va sd-va config +-------------------+-----------------------------------------------------+ | Field | Value | +-------------------+-----------------------------------------------------+ | remote-sys | 10.62.166.206 | | remote-sync-freq | 5m | | backup-data-trans | scp | | remote-sys-user | sd-backup | | backup-retain | 10 | | remote-sys-path | /space/sd-backup/sd-backup-test/gold-silver-backups | | backup-freq | 1m | | remote-sys-pass | ****** | +-------------------+-----------------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc backup sd-va local :::Paragraph{indent="1"} Lists local backups produced by the Services Director VA backup service. ::: ### Syntax ```bash show ssc backup sd-va local ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc backup sd-va local +----------------------------------------------+---------------------+ | Local Backup files | Creation time | +----------------------------------------------+---------------------+ | backup_10.62.167.199_2015-09-08_16-53-02.zip | 2015-09-08 16:53:03 | | backup_10.62.167.199_2015-09-08_16-54-01.zip | 2015-09-08 16:54:03 | | backup_10.62.167.199_2015-09-08_16-55-01.zip | 2015-09-08 16:55:02 | | backup_10.62.167.199_2015-09-08_16-56-01.zip | 2015-09-08 16:56:03 | +----------------------------------------------+---------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup sd-va restore remotecfg](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc backup sd-va restore remotecfg :::Paragraph{indent="1"} Lists remote backups produced by the Services Director VA backup service. ::: ### Syntax ```bash show ssc backup sd-va restore remotecfg ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc backup sd-va restore remotecfg +-------------------+-----------------------------------------------------+ | Field | Value | +-------------------+-----------------------------------------------------+ | remote-sys-user | sd-backup | | backup-data-trans | scp | | remote-sys-path | /space/sd-backup/sd-backup-test/gold-silver-backups | | remote-sys-pass | ****** | | remote-sys | 10.62.166.206 | +-------------------+-----------------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup sd-va local](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc backup vtm-cluster cluster-name backup-name :::Paragraph{indent="1"} Displays full details for the specified backup. ::: ### Syntax ```bash show ssc backup vtm-cluster cluster-name cluster-id backup-name backup_id ``` ### Parameters ```bash cluster-id ``` :::Paragraph{indent="1"} Specify the required cluster. ::: ```bash backup_id ``` :::Paragraph{indent="1"} Specify the required backup schedule. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **show ssc backup vtm-cluster cluster-name \** backups command to view all backups for a specified cluster. ::: :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster cluster-name \ backup-name \** command to delete the specified backup. ::: ### Examples ```bash *** display all backups *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backups +----------------------------+-------------------------------+ | Backups | Description | +----------------------------+-------------------------------+ | Backup-2JXH-D3BT-PK72-0SLH | Cluster-AQJE-R4HV-QYR1-9F4O#2 | | Backup-Y33H-XR2Z-128P-2M0T | Cluster-AQJE-R4HV-QYR1-9F4O#1 | +----------------------------+-------------------------------+ *** display details for a backup *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backup-name Backup-2JXH-D3BT-PK72-0SLH +--------------+-------------------------------+ | Field | Value | +--------------+-------------------------------+ | backup_id | Backup-2JXH-D3BT-PK72-0SLH | | description | Cluster-AQJE-R4HV-QYR1-9F4O#2 | | date | 2016-06-29 15:05 | | tag | Backup-2JXH-D3BT-PK72-0SLH | | cluster_id | Cluster-AQJE-R4HV-QYR1-9F4O | | size | 133120 | | sequence_num | 2 | | retain | False | +--------------+-------------------------------+ *** delete a backup *** amnesiac (config) # no ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backup-name Backup-2JXH-D3BT-PK72-0SLH +--------+----------------+ | Field | Value | +--------+----------------+ | Action | Deleted backup | +--------+----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name task](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name tasks](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedule](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc backup vtm-cluster cluster-name backups :::Paragraph{indent="1"} Displays all backups for a specified cluster. ::: ### Syntax ```bash [no] show ssc backup vtm-cluster cluster-name cluster-id backups ``` ### Parameters ```bash cluster-id ``` :::Paragraph{indent="1"} Specify the ID of the required cluster. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **show backup vtm-cluster cluster-name \ backup \ **command to view all backups for a specified cluster. ::: :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster cluster-name \ backup-name \** command to delete the specified backup. ::: ### Examples ```bash *** display all backups *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backups +----------------------------+-------------------------------+ | Backups | Description | +----------------------------+-------------------------------+ | Backup-2JXH-D3BT-PK72-0SLH | Cluster-AQJE-R4HV-QYR1-9F4O#2 | | Backup-Y33H-XR2Z-128P-2M0T | Cluster-AQJE-R4HV-QYR1-9F4O#1 | +----------------------------+-------------------------------+ *** display details for a backup *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backup-name Backup-2JXH-D3BT-PK72-0SLH +--------------+-------------------------------+ | Field | Value | +--------------+-------------------------------+ | backup_id | Backup-2JXH-D3BT-PK72-0SLH | | description | Cluster-AQJE-R4HV-QYR1-9F4O#2 | | date | 2016-06-29 15:05 | | tag | Backup-2JXH-D3BT-PK72-0SLH | | cluster_id | Cluster-AQJE-R4HV-QYR1-9F4O | | size | 133120 | | sequence_num | 2 | | retain | False | +--------------+-------------------------------+ *** delete a backup *** amnesiac (config) # no ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backup-name Backup-2JXH-D3BT-PK72-0SLH +--------+----------------+ | Field | Value | +--------+----------------+ | Action | Deleted backup | +--------+----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backup-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name task](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name tasks](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedule](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc backup vtm-cluster cluster-name task :::Paragraph{indent="1"} Displays full details for the specified backup task. ::: ### Syntax ```bash show ssc backup vtm-cluster cluster-name cluster-id task task_id ``` ### Parameters ```bash cluster-id ``` :::Paragraph{indent="1"} Specify the required cluster. ::: ```bash task_id ``` :::Paragraph{indent="1"} Specify the required backup task. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **show ssc backup vtm-cluster cluster-name \ tasks** command to view all tasks for a specified cluster. ::: :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster cluster-name \ task \** command to delete the specified task. ::: ### Examples ```bash *** display all tasks *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O tasks +---------------------------------------+ | Backup Tasks | +---------------------------------------+ | BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI | | BackupRestoreTask-BAWB-6JKQ-CPB3-R56B | +---------------------------------------+ *** display a specified task *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O task BackupRestoreTask-BAWB-6JKQ-CPB3-R56B +---------------+---------------------------------------+ | Field | Value | +---------------+---------------------------------------+ | status | complete | | backup_id | | | creation_date | 2016-06-29 15:01:26 | | task_subtype | backup now | | manager | 10.62.169.160 | | cluster_id | Cluster-AQJE-R4HV-QYR1-9F4O | | error_info | None | | task_type | backup restore | | task_id | BackupRestoreTask-BAWB-6JKQ-CPB3-R56B | | instance_id | | | cluster_tag | | +---------------+---------------------------------------+ *** delete a specified task from a specified cluster *** amnesiac (config) # no ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O task BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI +-------+--------------+ | Field | Value | +-------+--------------+ | Task | Deleted task | +-------+--------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backup-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name tasks](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedule](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc backup vtm-cluster cluster-name tasks :::Paragraph{indent="1"} Displays all tasks for a specified cluster. ::: ### Syntax ```bash show ssc backup vtm-cluster cluster-name cluster-id tasks ``` ### Parameters ```bash cluster-id ``` :::Paragraph{indent="1"} Specify the name of required cluster. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **show ssc backup vtm-cluster cluster-name \ task \** command to view all tasks for a specified cluster. ::: :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster cluster-name \ task \** command to delete the specified task. ::: ### Examples ```bash *** display all tasks *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O tasks +---------------------------------------+ | Backup Tasks | +---------------------------------------+ | BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI | | BackupRestoreTask-BAWB-6JKQ-CPB3-R56B | +---------------------------------------+ *** display a specified task *** amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O task BackupRestoreTask-BAWB-6JKQ-CPB3-R56B +---------------+---------------------------------------+ | Field | Value | +---------------+---------------------------------------+ | status | complete | | backup_id | | | creation_date | 2016-06-29 15:01:26 | | task_subtype | backup now | | manager | 10.62.169.160 | | cluster_id | Cluster-AQJE-R4HV-QYR1-9F4O | | error_info | None | | task_type | backup restore | | task_id | BackupRestoreTask-BAWB-6JKQ-CPB3-R56B | | instance_id | | | cluster_tag | | +---------------+---------------------------------------+ *** delete a specified task from a specified cluster *** amnesiac (config) # no ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O task BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI +-------+--------------+ | Field | Value | +-------+--------------+ | Task | Deleted task | +-------+--------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backup-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name task](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedule](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc backup vtm-cluster schedule :::Paragraph{indent="1"} Display full details for a specified backup schedule. ::: ### Syntax ```bash show ssc backup vtm-cluster schedule schedule-id ``` ### Parameters ```bash schedule-id ``` :::Paragraph{indent="1"} Specify the required backup schedule. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster schedule** command to delete the specified schedule. ::: ### Examples ```bash amnesiac (config) # show ssc backup vtm-cluster schedule sched-monthly-02 +-------------+------------------------------------+ | Field | Value | +-------------+------------------------------------+ | info | Monthly (26th) backup schedule | | schedule_id | BackupSchedule-HA16-ROZQ-T2PT-B3HG | | tag | sched-monthly-02 | | frequency | monthly | | backup_time | 11:30 | | offset | 26 | +-------------+------------------------------------+ amnesiac (config) # show ssc backup vtm-cluster schedule sched-daily-01 +-------------+------------------------------------+ | Field | Value | +-------------+------------------------------------+ | info | Daily backup schedule | | schedule_id | BackupSchedule-MF06-31XX-0JWF-55R1 | | tag | sched-daily-01 | | frequency | daily | | backup_time | 10:10 | | offset | 100 | +-------------+------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backup-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name task](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name tasks](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc backup vtm-cluster schedules :::Paragraph{indent="1"} Displays a list of all defined backup schedules. ::: ### Syntax ```bash show ssc backup vtm-cluster schedules ``` ### Examples ```bash amnesiac (config) # show ssc backup vtm-cluster schedules +---------------------+ | Backup Schedules | +---------------------+ | schedule-hourly-01 | | schedule-monthly-02 | | schedule-weekly-01 | | schedule-monthly-01 | | schedule-daily-01 | +---------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backup-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name task](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster cluster-name tasks](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedule](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc certificate :::Paragraph{indent="1"} Displays Services Director SSL certificate in text format. ::: ### Syntax ```bash show ssc certificate ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc certificate Certificate: Data: Version: 3 (0x2) Serial Number: Signature Algorithm: Issuer: Validity Not Before: May 29 13:56:14 2013 GMT Not After : May 29 13:56:14 2015 GMT Subject: Subject Public Key Info: Public Key Algorithm: rsaEncryption Public-Key: (1024 bit) Modulus: *** a partial listing *** ``` ### show ssc cloud-reg :::Paragraph{indent="1"} Displays details for a specified cloud registration resource. ::: ### Syntax ```bash show ssc cloud-reg id name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique identifier for the cloud registration, either its tag or UUID. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command does not display the user data required for cloud registration. The **show ssc cloud-reg user-data** command displays this user data. ::: ### Examples ```bash amnesiac (config) # show ssc cloud-reg id jk-cloud-reg-01 +---------------------+------------------------------+ | Field | Value | +---------------------+------------------------------+ | tag | jk-cloud-reg-01 | | owner | Owner-S5HZ-52G9-HZS2-KIAO | | email_address | | | children | None | | registration_policy | Policy-SH1M-L5BD-5L9L-YFKK | | date_created | 2016-09-07 13:34:32 | | user_data_id | UserData-Z28S-AXW9-PAVA-3YE3 | +---------------------+------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc cloud-reg user-data id](docId\:Daj0PxouZD3s712K5TKUW), [ssc cloud-reg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cloud-reg delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cloud-reg list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc cloud-reg user-data id :::Paragraph{indent="1"} Displays the user-data for a specified cloud registration resource. ::: ### Syntax ```bash show ssc cloud-reg user-data id name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique identifier for the cloud registration resource, either its tag or UUID. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command does not display the general properties for the cloud registration. The show ssc cloud-reg id command displays this information. ::: :::Paragraph{indent="1"} It is intended that you copy the output of this command to the clipboard, and then paste it into the Amazon Web Services (AWS) EC2 instance creation wizard when you create the first cloud-based vTM in a cluster. See the Services Director Getting Started Guide for full details of this process. ::: :::Paragraph{indent="1"} This text is always displayed in base64 format. ::: ### Examples ```bash amnesiac (config) # show ssc cloud-reg user-data id jk-cloud-reg-01 dGltZXpvbmU9RXVyb3BlL0xvbmRvbgphY2NlcHRfbGljZW5zZT1ZZXMKYWNjZXNzX2tleV9pZD08aW 5zZXJ0IGtleSBoZXJlPgpzZWNyZXRfYWNjZXNzX2tleV9pZD08aW5zZXJ0IGtleSBoZXJlPgpwYXNz d29yZD1LMnY0OU5GUkoKb3duZXI9T3duZXItUzVIWi01Mkc5LUhaUzItS0lBTwpvd25lcl9zZWNyZX Q9cGFzc3dvcmQKc2RfYWRkcmVzcz0xMC42Mi4xNjkuMTYyOjgxMDAKc2RfY2VydD1NSUlDV0RDQ0Fj R2dBd0lCQWdJSkFPbUt1L0pRUXB3bk1BMEdDU3FHU0liM0RRRUJDd1VBTUVVeEN6QUpCZ05WQkFZVE FrRlZNUk13RVFZRFZRUUlEQXBUYjIxbExWTjBZWFJsTVNFd0h3WURWUVFLREJoSmJuUmxjbTVsZENC WGFXUm5hWFJ6SUZCMGVTQk1kR1F3SGhjTk1UVXdOVEk1TVRVek9EVXlXaGNOTVRjd05USTRNVFV6T0 RVeVdqQkZNUXN3Q1FZRFZRUUdFd0pCVlRFVE1CRUdBMVVFQ0F3S1UyOXRaUzFUZEdGMFpURWhNQjhH VCQVFVQUE0R05BRENCaVFLQmdRRGw5S25CRjVYR2pqeWZOaTdKUnpxb1JlRjZGKzJydVJYdUFVdG9l QTFVRUNnd1lTVzUwWlhKdVpYUWdWMmxrWjJsMGN5QlFkSGtnVEhSa01JR2ZNQTBHQ1NxR1NJYjNEUU eVdwdFJlYnZCdmtOS1NXdXlGc1IvdTR0ekJlWUVzTU5aeXZLTGhodFVxcnRhc0dNam90MnRoaXlITG 9KdUlyZjR4NUZNbTNsbHFNK1c1WGlmUnhJU0F0dW5TMjJnYWI4Ri9QSW5SV01QUVlyeGZ2K3JUQW9S VHAwK0VSeWNScTMxZ2ZMd0lEQVFBQm8xQXdUakFkQmdOVkhRNEVGZ1FVL2pHVzFnRVVmamd5Rk1uU1 RFZSMFRCQVV3QXdFQi96QU5CZ2txaGtpRzl3MEJBUXNGQUFPQmdRQnB4Y1k5UURRN05tQnlDR2RDVW VFclZ4T29YdGxzd0h3WURWUjBqQkJnd0ZvQVUvakdXMWdFVWZqZ3lGTW5TVUVyVnhPb1h0bHN3REFZ hTTHBsS0hpS3A2TktaS2V3TENKeU9WU1FCUXk4eEdSQnhkTUpJaTMxbkRud3lhOUVTVVhGOW9STFNp c3NaQStwWEplNGtVVDdSMDFqcENXV2QwRzR2NURsK1Vhb2VzYmJmc241cUtnbkpvTUZVUTJ3YmtPdH E2OWlYcG5hc0ZwNWZsSWloQUFkNFZMR1R3QzRjTm83YXgrUT09CnJlZ2lzdHJhdGlvbl9wb2xpY3k9 UG9saWN5LVNIMU0tTDVCRC01TDlMLVlGS0s= ``` ### Related Commands :::Paragraph{indent="1"} [show ssc cloud-reg](docId\:Daj0PxouZD3s712K5TKUW), [ssc cloud-reg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cloud-reg delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cloud-reg list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc cluster cluster-name :::Paragraph{indent="1"} Displays Services Director cluster details. ::: ### Syntax ```bash show ssc cluster cluster-name cluster_id ``` ### Parameters ```bash cluster_id ``` :::Paragraph{indent="1"} Specify the name of the cluster. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **user\_data** property is only populated when a cluster is used for cloud-based vTMs, such as those deployed using Amazon Web Services (AWS) EC2 platform. This property is required when deploying the second cloud-based vTM in a cluster, replacing the AWS user data from the cloud registration. See the Services Director Getting Started Guide for full details of this process. ::: ### Examples ```bash *** show details for a cluster containing an externally-deployed vTM *** show ssc cluster cluster-name Cerulean +----------------------+-----------------------------------+ | Field | Value | +----------------------+-----------------------------------+ | status | Active | | next_backup_time | None | | share_tips | True | | cluster_port_offset | None | | in_use | True | | cluster_type | Discovered | | user_data | None | | task | None | | number_backups | 5 | | schedule_id | None | | tag | Cerulean | | members | [u'Instance-92Y7-JVCE-00TW-UY1N'] | | owner | Owner-F4MQ-6X5X-S07W-B0RI | | children | None | | analytics_profile_id | None | +----------------------+-----------------------------------+ *** show details for a cluster containing a cloud-based vTM *** platinum-01 (config) # show ssc cluster cluster-name AWS-cluster-01 +-----------------------------+-------------------------------------------------- | Field | Value +-----------------------------+-------------------------------------------------- | backup_success_sequence_num | None | backup_failure_count | None | schedule_id | None | tag | AWS-cluster-01 | owner | Owner-F95M-3Y0R-FGQA-1DIK | backup_next_sequence_num | None | children | None | analytics_profile_id | None | share_tips | True | restore_backup_name | None | cluster_port_offset | None | last_success_backup | None | cluster_type | Discovered | last_backup_time | None | status | Active | in_use | True | user_data | Y2x1c3Rlcl9ob3N0PTEwLjguMi4xMDgKY2x1c3Rlcl... | number_backups | 5 | members | [u'Instance-CIOL-A2FM-3C7O-N9A1'] | last_failed_backup | None | restore_backup_status | None | next_backup_time | None | task | None | restore_backup_time | None | last_backup_status | None +-----------------------------+-------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW), ssc cluster create cluster-name ::: ### show ssc collection-endpoint :::Paragraph{indent="1"} Displays details for a specified Collection Endpoint resource. This endpoint is used as a destination for analytics data on your chosen Analytics System. ::: ### Syntax ```bash show ssc collection-endpoint name endpoint-id ``` ### Parameters ```bash name endpoint-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the collection endpoint, either its tag or UUID. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command. ::: ### Examples ```bash *** list all collection endpoints *** amnesiac (config) # ssc collection-endpoint list +-----------------------------------------+------------------+ | ID | Tag | +-----------------------------------------+------------------+ | Collection-Endpoint-4N4H-0NL1-T02T-PZZ7 | JK-Collection-04 | | Collection-Endpoint-9D37-B16X-75XG-3K8W | JK-Collection-01 | | Collection-Endpoint-1EGK-KLKN-R6RB-JDLK | JK-Collection-02 | | Collection-Endpoint-U3FX-MTKU-WSY6-WZ99 | JK-Collection-03 | +-----------------------------------------+------------------+ *** show details for a specific collection endpoint *** amnesiac (config) # show ssc collection-endpoint name JK-Collection-01 +----------------------------------+-----------------------------------------+ | Field | Value | +----------------------------------+-----------------------------------------+ | transaction_tls_verify | False | | auth_type | none | | transaction_export_address | demo.com:9999 | | log_export_address | https://demo.com:8080/logs/collector | | auth_token | | | collection_endpoint_id | Collection-Endpoint-9D37-B16X-75XG-3K8W | | transaction_endpoint_certificate | | | transaction_export_tls | False | | log_endpoint_certificate | | | tag | JK-Collection-01 | | log_tls_verify | False | | auth_password | | | auth_username | | +----------------------------------+-----------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc collection-endpoint create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc dashboard :::Paragraph{indent="1"} Displays the dashboard resource for the Services Director. This is a summary of certain Services Director functions. ::: ### Syntax ```bash show ssc dashboard ``` ### Usage Guidelines :::Paragraph{indent="1"} Currently, the dashboard only includes a summary of the state of metering on the Services Director. ::: :::Paragraph{indent="1"} To investigate this summary information, see [ssc owner create](docId\:H010mqCIZJAevKMkPzNkS) and [show ssc owner](docId\:Daj0PxouZD3s712K5TKUW). ::: ### Examples ```bash amnesiac (config) # show ssc dashboard +------------------------------------+--------------------------------------------- | Property | Value +------------------------------------+--------------------------------------------- | metering_health > alert_reason | Possible under-accounting or over-accounting | metering_health > alert_level | 3 | metering_health > alert_..._short | Warning +------------------------------------+--------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc metering warning instance-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc settings metering](docId\:Daj0PxouZD3s712K5TKUW), [ssc metering warning list](docId\:H010mqCIZJAevKMkPzNkS), [ssc settings metering update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc database local :::Paragraph{indent="1"} Displays settings for local MySQL database. ::: ### Syntax ```bash show ssc database local ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc database local Use Local Database: yes MySQL Port Number: 3306 MySQL Bind Address: 127.0.0.1 ``` ### Related Commands :::Paragraph{indent="1"} [ssc database use-local](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc database local credentials :::Paragraph{indent="1"} Displays local MySQL database credentials. ::: ### Syntax ```bash show ssc database local db-file credentials ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc database local credentials +-------------+-------------+ | DB Username | DB Password | +-------------+-------------+ | ssc | my_db_pass | +-------------+-------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc database use-local](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc database local db-file :::Paragraph{indent="1"} Displays available backups for local MySQL database. ::: ### Syntax ```bash show ssc database local db-file ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc database local db-file ``` ### Related Commands :::Paragraph{indent="1"} [ssc database use-local](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc database local max-connections :::Paragraph{indent="1"} Displays local MySQL database maximum connections. ::: ### Syntax ```bash show ssc database local max-connections ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc database local max-connections Maximum number of connections to local MySQL DB: 151 ``` ### Related Commands :::Paragraph{indent="1"} [ssc database use-local](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc database remote :::Paragraph{indent="1"} Displays settings for remote database used by the Services Director. ::: ### Syntax ```bash show ssc database remote [db-user-name name] | [ip-address ip-addr] | [port port] ``` ### Parameters ```bash db-user-name name ``` :::Paragraph{indent="1"} Displays the user for the remote database used by the Services Director. ::: ```bash ip-address ip-addr ``` :::Paragraph{indent="1"} Displays the IP address for remote database used by Services Director. ::: ```bash port port ``` :::Paragraph{indent="1"} Displays the port number for remote database used by Services Director. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc database remote db-user-name test Remote Database Port: ssc ``` ### Related Commands :::Paragraph{indent="1"} [ssc database remote address](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc database use-local :::Paragraph{indent="1"} Displays whether to use local MySQL database for Services Director. ::: ### Syntax ```bash show ssc database use-local ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc database use-local Use local MySQL database: yes ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database use-local](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc feature-pack fpname :::Paragraph{indent="1"} Displays feature pack details. ::: ### Syntax ```bash show ssc feature-pack fpname name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the feature pack. ::: ### Examples ```bash amnesiac (config) # show ssc feature-pack fpname ENT-ENTERPRISE_full +-------------+----------------+ | Field | Value | +-------------+----------------+ | info | | | status | Active | | stm_sku | ENT-ENTERPRISE | | add_on_skus | [] | | excluded | | | skus | ENT-ENTERPRISE | +-------------+----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc feature-pack fpname](docId\:Daj0PxouZD3s712K5TKUW), [ssc feature-pack create fpname](docId\:LLjz7el7U_q1thWAbTl0A), [ssc feature-pack list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc feature-pack update fpname](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc high-avail certificate :::Paragraph{indent="1"} Displays the high availability certificate for a high availability node. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is identical to [ssc high-avail file-replication reset](docId\:LLjz7el7U_q1thWAbTl0A). ::: ### show ssc high-avail list :::Paragraph{indent="1"} Displays a list of nodes in the current HA pair. ::: :::Paragraph{indent="1"} This command is identical to [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A). ::: ### show ssc host host-name :::Paragraph{indent="1"} Displays vTM instance host details. ::: ### Syntax ```bash show ssc host host-name name dns [ status-check [true | false]] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the host. ::: ```bash status-check [true | false] ``` :::Paragraph{indent="1"} Specify true or false to display host status check information. ::: ### Examples ```bash amnesiac (config) # show ssc host host-name demo-01.cam.demo.com status-check true +------------------------+----------------------+ | Field | Value | +------------------------+----------------------+ | install_root | /root/install | | username | root | | retained_info_dir | None | | va_management_user | | | hw_cluster_node | None | | work_location | /var/cache/ssc | | cpu_cores | None | | status_check | {} | | info | demo | | status | Active | | va_management_password | | | usage_info | | | host_id | demo-01.cam.demo.com | | hw_slot_number | None | | size | None | +------------------------+----------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc host add host-name](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### show ssc instance instance-name :::Paragraph{indent="1"} Displays vTM instance details. ::: ### Syntax ```bash show ssc instance instance-name name [status-check [true | false] ] [show-passwords [true | false]] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager instance. ::: ```bash status-check ``` :::Paragraph{indent="1"} Specify **true** or **false** to display a status check of the (deployed) instance. ::: ```bash show-passwords ``` :::Paragraph{indent="1"} Specify **true** or **false** to display the administration password. ::: ### Examples ```bash amnesiac (config) # show ssc instance instance-name violet-01 show-passwords true +------------------------------+-----------------------------+ | Field | Value | +------------------------------+-----------------------------+ | status | Active | | metrics_date | None | | cpu_usage | | | managed | False | | metrics_peak_RPS | None | | license_name | universal_v3 | | rest_address | 10.62.169.165:9070 | | tag | violet-01 | | snmp_address | 10.62.169.165:161 | | creation_date | 2015-12-29 10:08:34 | . . . | admin_password | password | | management_address | 10.62.169.165 | | container_configuration | | | rest_enabled | True | | ui_address | 10.62.169.165:9090 | | metrics_peak_SSL_TPS | None | | host_name | | +------------------------------+-----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc instance create instance-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc kpti :::Paragraph{indent="1"} Displays Kernel Page-Table Isolation (KPTI) settings for the Services Director. ::: ### Syntax ```bash show ssc kpti ``` ### Examples ```bash *** KPTI is enabled *** amnesiac (config) # show ssc kpti KPTI is currently enabled, and will remain enabled after a reboot. *** KPTI is enabled now but will change state at the next reboot *** amnesiac (config) # show ssc kpti KPTI is currently enabled, but will be disabled after a reboot. *** KPTI is disabled now but will change state at the next reboot *** amnesiac (config) # show ssc kpti KPTI is currently disabled, but will be enabled after a reboot. *** KPTI is disabled *** amnesiac (config) # show ssc kpti KPTI is currently disabled, and will remain disabled after a reboot. ``` ### Related Commands :::Paragraph{indent="1"} [ssc kpti](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc license enterprise :::Paragraph{indent="1"} Displays Services Director enterprise license details. ::: ### Syntax ```bash show ssc license enterprise [add-on key | bandwidth key | controller key | resource-pack key] ``` ### Parameters ```bash add-on key ``` :::Paragraph{indent="1"} Specify the (older) add-on license key. ::: ```bash bandwidth key ``` :::Paragraph{indent="1"} Specify the bandwidth license key. ::: ```bash controller key ``` :::Paragraph{indent="1"} Specify the name of the controller license key. ::: ```bash resource-pack key ``` :::Paragraph{indent="1"} Specify the name of the (newer) resource pack key. ::: ### Usage Guidelines :::Paragraph{indent="1"} Add-on licenses are used with older controller licenses. Resource pack licenses are used with newer controller licenses. ::: ### Examples ```bash amnesiac (config) # show ssc license enterprise bandwidth 3420186a93f3c58857e21f1cf +---------------------------+------------------------------------------------------- | Field | Value +---------------------------+------------------------------------------------------- | status | Active | valid_until | 2016-10-07 | timestamp | 2016-09-27T21:37:13.1475037433 | controller_license | ERSSC381243-0000-42B9 | bandwidth | 5000.0 | valid_from | Perpetual | serial | 342005 | license_key | LK1-ERSSCTPSTM_B_400:5:342015:20160927T2137131475... | controller_license_serial | 381243 | stm_sku | STM-400 | valid | True +---------------------------+------------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license license-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc license-file](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc license license-name :::Paragraph{indent="1"} Displays the details for the named license. ::: ### Syntax ```bash show ssc license license-name unique-name ``` ### Parameters ```bash unique-name ``` :::Paragraph{indent="1"} Specify the unique name of the license. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash *** check available licenses *** amnesiac (config) # ssc license list +--------------+ | License | +--------------+ | universal_v4 | | legacy_9.3 | +--------------+ *** show the legacy license *** amnesiac (config) # show ssc license license-name legacy_9.3 +------------------------+-------------+ | Field | Value | +------------------------+-------------+ | status | Active | | health_check_results | [] | | info | | | last_health_check_time | None | | default | True | | health_check_status | Not yet run | | generic_errors | None | | type | legacy | +------------------------+-------------+ *** show the universal license *** amnesiac (config) # show ssc license license-name universal_v4 +------------------------+---------------------------------------------------------- | Field | Value +------------------------+---------------------------------------------------------- | status | Active | health_check_results | [] | info | Universal license, installed with vX.X of Services Dir... | last_health_check_time | None | default | True | health_check_status | Not yet run | generic_errors | None | type | universal +------------------------+---------------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [show ssc license-file](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc license-file :::Paragraph{indent="1"} Displays the Services Director license key. ::: ### Syntax ```bash show ssc license-file ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc license-file LK1-ERSSC563111-0000-41FD-5-954B-E6F7-85B1 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [show ssc license license-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### show ssc log-export :::Paragraph{indent="1"} Displays details for a specified log-export resource. This is used for vTM analytics purposes. ::: ### Syntax ```bash show ssc log-export id profile-id ``` ### Parameters ```bash id profile-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the log-export resource, either its tag or UUID. ::: ### Examples ```bash *** list all log-export resources *** amnesiac (config) # ssc log-export list +-----------------------------+-----------------------------+ | ID | Tag | +-----------------------------+-----------------------------+ | Audit Log | Audit Log | | Application Firewall | Application Firewall | | Process Monitor | Process Monitor | | Admin Server Access | Admin Server Access | | System - syslog | System - syslog | | Event Log | Event Log | | Routing Software | Routing Software | | Data Plane Acceleration | Data Plane Acceleration | | System - authentication log | System - authentication log | +-----------------------------+-----------------------------+ *** show details for a specific log-export resource *** amnesiac (config) # show ssc log-export id "Audit Log" +----------------+----------------------------+ | Field | Value | +----------------+----------------------------+ | files | %ZEUSHOME%/zxtm/log/audit* | | tag | Audit Log | | appliance_only | False | | built_in | True | | log_export_id | Audit Log | | children | None | | history | none | +----------------+----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc log-export create](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export list](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc manager manager-name :::Paragraph{indent="1"} Displays Services Director manager details. ::: ### Syntax ```bash show ssc manager manager-name name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the Services Director manager. ::: ### Examples ```bash amnesiac (config) # show ssc manager manager-name amnesiac +------------+---------+ | Field | Value | +------------+---------+ | management | enabled | | monitoring | shared | | metering | all | | licensing | enabled | +------------+---------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc manager list](docId\:H010mqCIZJAevKMkPzNkS), [ssc manager update manager-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc metering warning instance-name :::Paragraph{indent="1"} Displays metering warning information for a specified Traffic Manager instance. ::: ### Syntax ```bash show ssc metering warning instance-name name ``` ### Parameters ```bash instance-name name ``` :::Paragraph{indent="1"} Specify the name of the required Traffic Manager instance. ::: ### Usage Guidelines :::Paragraph{indent="1"} Any current instance can be specified. Where no warning exists, this is indicated. ::: :::Paragraph{indent="1"} To identify all instances with a warning, see [ssc owner create](docId\:H010mqCIZJAevKMkPzNkS). ::: ### Examples ```bash *** list all instances with a warning raised *** amnesiac (config) # ssc metering warning list +-----------+ | Instance | +-----------+ | cerise-02 | | sienna-01 | +-----------+ *** show warning details for first failed instance (over-accounting example) *** amnesiac (config) # show ssc metering warning instance-name cerise-02 +------------------------+----------------------------------------------+ | Field | Value | +------------------------+----------------------------------------------+ | alert_reason | Possible uptime over-accounting | | alert_level | 3 | | alert_level_short_text | Warning | | alert_resolution_text | Mark instance as deleted if no longer in use | | name | Instance-3ZXD-61IX-KZEC-6IO6 | | tag | cerise-02 | | monitor_date | 2016-06-22 14:33:11 | | licensed_date | 2016-06-20 14:27:09 | | metrics_date | None | +------------------------+----------------------------------------------+ *** show warning details for second failed instance (under-accounting example) *** amnesiac (config) # show ssc metering warning instance-name sienna-01 +------------------------+----------------------------------------------------+ | Field | Value | +------------------------+----------------------------------------------------+ | alert_reason | Possible under-accounting | | alert_level | 3 | | alert_level_short_text | Warning | | alert_resolution_text | Enable REST or SNMP connectivity for this instance | | name | Instance-NPIS-A6ZB-MSA3-680Q | | tag | sienna-01 | | monitor_date | 2016-06-22 14:33:10 | | licensed_date | 2016-06-20 14:27:48 | | metrics_date | None | +------------------------+----------------------------------------------------+ *** show instance with no warning raised amnesiac (config) # show ssc metering warning instance-name violet-01 +------------------------+------------------------------+ | Field | Value | +------------------------+------------------------------+ | alert_level | 1 | | alert_level_short_text | OK | | name | Instance-6BT2-ALAX-KN14-32RA | | tag | violet-01 | | monitor_date | 2016-06-22 14:59:11 | | licensed_date | None | | metrics_date | None | +------------------------+------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc dashboard](docId\:Daj0PxouZD3s712K5TKUW), [show ssc settings metering](docId\:Daj0PxouZD3s712K5TKUW), [ssc metering warning list](docId\:H010mqCIZJAevKMkPzNkS), [ssc settings metering update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc owner :::Paragraph{indent="1"} Displays a specified owner. ::: ### Syntax ```bash show ssc owner name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the owner. ::: ### Examples ```bash *** list all owners *** amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-WUPO-RLBZ-SAPQ-RAM3 | JK | | Owner-58I2-2N4F-IXG0-8084 | TK | | Owner-JJM6-0UII-JUAH-R979 | JRRT | +---------------------------+------+ *** list details for listed owner 'HC' *** amnesiac (config) # show ssc owner owner-id JK +---------------+------------------------------------+ | Field | Value | +---------------+------------------------------------+ | instances | [u'cerulean-01'], [u'cerulean-02'] | | tag | JK | | timezone | Etc/GMT | | email_address | | | children | None | | secret | banana | | clusters | [u'Cerulean-Cluster'] | | owner_id | Owner-WUPO-RLBZ-SAPQ-RAM3 | +---------------+------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc owner create](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner list](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc registration :::Paragraph{indent="1"} Displays details for a specified self-registration request. ::: ### Syntax ```bash show ssc registration registration-id ``` ### Parameters ```bash registration-id ``` :::Paragraph{indent="1"} Specify the ID for the self-registration request. ::: ### Usage Guidelines :::Paragraph{indent="1"} Some fields will only be populated once the request is Accepted: ::: :::Paragraph{listStyleType="disc" indent="2"} instance\_name ::: :::Paragraph{listStyleType="disc" indent="2"} feature\_pack ::: :::Paragraph{listStyleType="disc" indent="2"} bandwidth ::: :::Paragraph{listStyleType="disc" indent="2"} owner ::: :::Paragraph{listStyleType="disc" indent="2"} access\_profile (optional). ::: ### Examples ```bash *** show registration request for Pending request *** amnesiac (config) # show ssc registrations registration-id Reg-QG91-KJMS-DK4T-2FWY +----------------------+--------------------------------------+ | Field | Value | +----------------------+--------------------------------------+ | snmp_address | 10.62.169.167:161 | | registration_message | Cerise 10.4 registration | | bandwidth | None | | owner | None | | email_address | jkilby@demo.com | | instance_name | None | | uuid | 1013592c-a9bb-3301-9675-005056a643af | | hostname | 10.62.169.167 | | declined_reason | None | | instance_version | 10.4a1 | | status | Pending | | snmp_community | public | | admin_address | 10.62.169.167:9090 | | rest_address | 10.62.169.167:9070 | | feature_pack | None | | cluster_identifier | Cluster-C21U-O3MQ-EE3G-BUIZ | | registration_time | 2016-03-20 15:36:14 | | instance_id | None | | management_ip | 10.62.169.167 | | pending_time | 2016-03-20 15:36:14 | | access_profile | None | +----------------------+--------------------------------------+ *** show registration request for Accepted request *** amnesiac (config) # show ssc registrations registration-id Reg-QG91-KJMS-DK4T-2FWY +----------------------+--------------------------------------+ | Field | Value | +----------------------+--------------------------------------+ | snmp_address | 10.62.169.167:161 | | registration_message | Cerise 10.4 registration | | bandwidth | 100 | | owner | JK | | email_address | jkilby@demo.com | | instance_name | cerise-01 | | uuid | 1013592c-a9bb-3301-9675-005056a643af | | hostname | 10.62.169.167 | | declined_reason | None | | instance_version | 10.4a1 | | status | Accepted | | snmp_community | public | | admin_address | 10.62.169.167:9090 | | rest_address | 10.62.169.167:9070 | | feature_pack | STM-400_full | | cluster_identifier | Cluster-C21U-O3MQ-EE3G-BUIZ | | registration_time | 2016-03-20 15:36:14 | | instance_id | None | | management_ip | 10.62.169.167 | | pending_time | 2016-03-20 15:36:14 | | access_profile | TAC | +----------------------+--------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc registration delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc registration list](docId\:H010mqCIZJAevKMkPzNkS), [ssc registration update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc reg-policy :::Paragraph{indent="1"} Displays a specified registration policy. ::: ### Syntax ```bash show ssc reg-policy name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the registration policy. ::: ### Examples ```bash *** list all self-reg policies *** amnesiac (config) # ssc reg-policy list +----------------------------+----------------+ | Policy ID | Tag | +----------------------------+----------------+ | Policy-MHM8-AB62-SI2J-DNUX | jk-self-reg-01 | | Policy-I7A7-3DN2-6IEB-QF96 | jk-self-reg-02 | | Policy-8QU3-ZERY-8IW6-3W6J | self-reg-01 | +----------------------------+----------------+ *** display all details for a listed self-reg policy *** amnesiac (config) # show ssc reg-policy policy-id tk-reg-policy-01 +-----------------------------+----------------------------+ | Field | Value | +-----------------------------+----------------------------+ | instance_version_range_low | 10.0 | | bandwidth | 100 | | tag | tk-reg-policy-01 | | children | None | | management_ip_subnet | 10.62.128.0/18 | | feature_pack | STM-400_full | | access_profile | None | | instance_version_range_high | 11.0 | | policy_id | Policy-XI6P-5JLU-QQUL-9BR7 | +-----------------------------+----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc reg-policy create](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy list](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc sd-admin-ca :::Paragraph{indent="1"} Displays full details of a specified Services Director CA certificate. This certificate is required to enable communications with a secure LDAP authentication server. ::: ### Syntax ```bash show ssc sd-admin-ca admin-ca-name ca-certificate-name ``` ### Parameters ```bash admin-ca-name ca-ertificate-name ``` :::Paragraph{indent="1"} Specify the name or ID of a CA certificate present on Services Director. ::: ### Examples ```bash *** List all CA certificates on Services Director *** amnesiac (config) # ssc sd-admin-ca list +------+------------------------------+ | Name | Unique ID | +------+------------------------------+ | CA-1 | Admin-CA-5XJ0-HP0Y-YQAX-69O2 | | CA-2 | Admin-CA-6J21-KKH3-VSAJ-3209 | +------+------------------------------+ *** Display details for a CA certificate *** amnesiac (config) # show ssc sd-admin-ca admin-ca-name CA-1 +-----------------------+-------------------------------------------------------... | Field | Value +-----------------------+-------------------------------------------------------... | admin_ca_id | Admin-CA-5XJ0-HP0Y-YQAX-69O2 | tag | CA-1 | certificate_authority | -----BEGIN CERTIFICATE----- | | MIIDSzCCAjOgAwIBAgIQciGh+iQigI5d1LTxq9pEEG9w0BAQsFADAl... . . . | | TC+Rno87nWeTLHXwRVWOJhwlspgaN66dPyOw43bkzh7JTALTWBXKJs... | | PCuhDlHZSui0p1auJnIIg3pmqyANx/bw== | | -----END CERTIFICATE----- | children | None +-----------------------+-------------------------------------------------------... ``` ### Related Commands :::Paragraph{indent="1"} [ssc sd-admin-ca create](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca update](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc sd-authenticator :::Paragraph{indent="1"} Displays full details of a specified Services Director authenticator. This can be for an LDAP, RADIUS or TACACS+ server. ::: ### Syntax ```bash show ssc sd-authenticator auth-name authenticator-name ``` ### Parameters ```bash auth-name authenticator-name ``` :::Paragraph{indent="1"} Specify the name of the Services Director authenticator. ::: ### Examples ```bash *** List Services Director authenticators *** amnesiac (config) # ssc sd-authenticator list +--------------+-----------------------------------+ | Name | Unique ID | +--------------+-----------------------------------+ | bbotservices | Authenticator-Y4RC-M3OI-J1BE-5N96 | | SecureLDAP | Authenticator-V3JW-M4GT-B1NG-43FT | +--------------+-----------------------------------+ *** Display details for a secure LDAP authenticator *** amnesiac (config) # show ssc sd-authenticator auth-name SecureLDAP +------------------------------+---------------------------------------------+ | Description | Value | +------------------------------+---------------------------------------------+ | Name | SecureLDAP | | Type | ldap | | Status of SD authenticator | enabled | | Server Address | dc1.dev-win17.demo.com | | DN Method | construct | | Filter | sAMAccountName=%u | | Base DN | CN=Users,DC=dev-win19,DC=demo,DC=com | | SSL mode | starttls | | Fallback SD permission group | Permission-Group-PYS6-1U8P-HNEG-OARS | | Server Port | 389 | | Timeout | 10 | | Group Attribute | memberOf | | Group Field | CN | | Bind DN | %u@dev-win17.demo.com | | Group Filter | | | Search DN | | | Search Password | ***** | +------------------------------+---------------------------------------------+ *** Display details for the TACACS+ authenticator *** amnesiac (config) # show ssc sd-authenticator auth-name Authenticator-Y4RC-M3OI-J1BE-5N96 +------------------------------+---------------------------+ | Description | Value | +------------------------------+---------------------------+ | Name | bbotservices | | Type | tacacs_plus | | Status of SD authenticator | enabled | | Server Address | bbotservices.cam.demo.com | | SD Authentication Type | pap | | Fallback SD permission group | | | Server Port | 4900 | | Timeout | 10 | | Group Field | permission-group | | Secret | ***** | | Group Service | zeus | +------------------------------+---------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator add radius auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator add tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update radius auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc sd-permission-group :::Paragraph{indent="1"} Displays details for a specified Services Director permission group. ::: ### Syntax ```bash show ssc sd-permission-group pg-name permission-group ``` ### Parameters ```bash pg-name permission-group ``` :::Paragraph{indent="1"} Specify the required permission-group. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: :::Paragraph{indent="1"} Typically, there is a single Services Director permission group, with full access. The name of this permission group matches the group returned by the authenticator. ::: ### Examples ```bash *** show permissions for the admin group *** amnesiac (config) # show ssc sd-permission-group pg-name admin +---------------------+--------------------------------------+ | Field | Value | +---------------------+--------------------------------------+ | description | | | permission_group_id | Permission-Group-XG8K-FUYG-WKKV-9IKP | | tag | admin | | children | None | +---------------------+--------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc sd-permission-group create pg-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-permission-group list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-permission-group update pg-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc search-endpoint :::Paragraph{indent="1"} Displays details for a specified Search Endpoint resource. This endpoint is used to retrieve analytics data from your chosen Analytics System. ::: ### Syntax ```bash show ssc search-endpoint id endpoint-id ``` ### Parameters ```bash id endpoint-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the search endpoint, either its tag or UUID. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Search Endpoint resources. Collection Endpoint resources are handled separately, by an equivalent "collection-endpoint" command. ::: ### Examples ```bash *** list all search-endpoints *** amnesiac (config) # ssc search-endpoint list +-------------------------------------+-----------------+ | ID | Tag | +-------------------------------------+-----------------+ | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | JK-EP-Search-01 | +-------------------------------------+-----------------+ *** display details for a specific search-endpoint *** amnesiac (config) # show ssc search-endpoint name JK-EP-Search-01 +-----------------------------+---------------------------------------------------- | Field | Value +-----------------------------+---------------------------------------------------- | verify_tls | True | search_endpoint_id | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | tag | JK-EP-Search-01 | auth_password | password | auth_username | admin | search_endpoint_address | demo.com:2020 | use_tls | True | search_endpoint_certificate | LS0tLS1CRUdJTiBDRVJUSUZJCk1JSUNXRENDQWNHZ0F3UJBZ... | transactions_index | zxtm_transactions | logs_index | zxtm_logs +-----------------------------+---------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [ssc search-endpoint create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint delete](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc server :::Paragraph{indent="1"} Displays the Services Director server settings. ::: ### Syntax ```bash show ssc server ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc server SSC REST port number: 8100 ``` ### Related Commands :::Paragraph{indent="1"} [ssc server rest-port-num](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc server thread :::Paragraph{indent="1"} Displays Services Director server threads. ::: ### Syntax ```bash show ssc server thread ``` ### Examples ```bash amnesiac (config) # show ssc server thread +-----------------+-------+ | Field | Value | +-----------------+-------+ | threads | 25 | | action threads | 5 | | monitor threads | 10 | +-----------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc service enable](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings analytics :::Paragraph{indent="1"} Displays Services Director analytics settings. ::: ### Syntax ```bash show ssc settings analytics ``` ### Examples ```bash amnesiac (config) # show ssc settings analytics +-------------------------+-------------------+ | Field | Value | +-------------------------+-------------------+ | transaction_source_type | zxtm_transactions | +-------------------------+-------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings analytics update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings con-lic :::Paragraph{indent="1"} Displays the number of days set to send a warning about the expiration of the controller license. ::: ### Syntax ```bash show ssc settings con-lic ``` ### Examples ```bash amnesiac (config) # show ssc settings con-lic +---------------------+-------+ | Field | Value | +---------------------+-------+ | expiry_warning_days | 30 | +---------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc license enterprise controller list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc settings deployment :::Paragraph{indent="1"} Displays the number of vTM instances that can be deployed. ::: ### Syntax ```bash show ssc settings deployment ``` ### Examples ```bash amnesiac (config) # show ssc settings deployment +---------------+-------+ | Field | Value | +---------------+-------+ | max_instances | 0 | +---------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc license enterprise controller list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### show ssc settings external-ip :::Paragraph{indent="1"} Displays the external IP corresponding to the Services Endpoint Address when Services Director is running in a private network behind a NAT. ::: ### Syntax ```bash show ssc settings external-ip ``` ### Examples ```bash amnesiac (config) # show ssc settings external-ip +-------------+--------------+ | Field | Value | +-------------+--------------+ | external_ip | 10.62.150.30 | +-------------+--------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings external-ip](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings fla-check :::Paragraph{indent="1"} Displays whether the FLA checker is enabled for the Services Director. ::: ### Syntax ```bash show ssc settings fla-check ``` ### Examples ```bash amnesiac (config) # show ssc settings fla-check +-------------------+-------+ | Field | Value | +-------------------+-------+ | fla_check_enabled | True | +-------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings fla-check enable](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings licensing :::Paragraph{indent="1"} Displays alert threshold and alert threshold interval settings. ::: ### Syntax ```bash show ssc settings licensing ``` ### Examples ```bash amnesiac (config) # show ssc settings licensing +--------------------------+-------+ | Field | Value | +--------------------------+-------+ | alert_threshold | 1 | | alert_threshold_interval | 300 | +--------------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings licensing update alert-threshold](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings logging :::Paragraph{indent="1"} Displays metering, inventory, and license log settings. ::: ### Syntax ```bash show ssc settings logging ``` ### Examples ```bash amnesiac (config) # show ssc settings logging +-------------------+-------+ | Field | Value | +-------------------+-------+ | metering_logging | 0 | | inventory_logging | 0 | | license_logging | 0 | +-------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings logging update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings master-password :::Paragraph{indent="1"} Displays the status of the master password. This can either be Active or Changing. ::: ### Syntax ```bash show ssc settings master-password ``` ### Examples ```bash amnesiac (config) # show ssc settings master-password +------------------+--------+ | Field | Value | +------------------+--------+ | status | Active | +------------------+--------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings master-password update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings metering :::Paragraph{indent="1"} Displays metering and log check interval settings. ::: ### Syntax ```bash show ssc settings metering ``` ### Examples ```bash amnesiac (config) # show ssc settings metering +--------------------------+-------+ | Field | Value | +--------------------------+-------+ | alerts_and_notifications | True | | snmp_enabled | True | | log_check_interval | 3600 | | meter_interval | 3600 | +--------------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc dashboard](docId\:Daj0PxouZD3s712K5TKUW), [show ssc metering warning instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc metering warning list](docId\:H010mqCIZJAevKMkPzNkS), [ssc settings metering update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings monitoring :::Paragraph{indent="1"} Displays Services Director monitoring settings. ::: :::hint{type="info"} The `purge_deleted_vtm`, `purge_deleted_vtm_interval`, and `purge_deleted_vtm_check_period` settings can only be updated via the REST API. ::: ### Syntax ```bash show ssc settings monitoring ``` ### Examples ```bash amnesiac (config) # show ssc settings monitoring +-----------------------------------+----------+ | Field | Value | +-----------------------------------+----------+ | controller_failure_period | 180 | | instance_failure_period | 180 | | host_failure_period | 180 | | instance_monitor_interval | 60 | | auto_cleanup_vtms | all_vtms | | purge_deleted_vtm | False | | monitor_email_interval | 60 | | purge_deleted_vtm_interval | 42 | | purge_deleted_vtm_check_period | 86400 | | overdue_monitoring_warning_period | 300 | | host_monitor_interval | 60 | | controller_monitor_interval | 60 | +-----------------------------------+----------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings monitoring update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings security :::Paragraph{indent="1"} Displays Services Director security settings. ::: ### Syntax ```bash show ssc settings security ``` ### Examples ```bash amnesiac (config) # show ssc settings security +-----------------------------------+------------------------------------------... | Field | Value +-----------------------------------+------------------------------------------... | max_login_attempts | 0 | user_lockout_duration_minutes | 15 | candidate_service_ssl_certificate | | auth_success_cache_time_seconds | 30 | auth_failure_cache_time_seconds | 10 | ssl-cipher-list | ECDH+AESGCM:ECDH+CHACHA20:DH+AESGCM:ECDH+... +-----------------------------------+------------------------------------------... ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings security update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings telemetry :::Paragraph{indent="1"} Displays Services Director phone home telemetry status. ::: ### Syntax ```bash show ssc settings telemetry ``` ### Examples ```bash amnesiac (config) # show ssc settings telemetry +--------------------+-----------------------------------------------------+ | Field | Value | +--------------------+-----------------------------------------------------+ | destination | https://telemetry.cam.demo.com/product-feedback/1.0 | | phone_home_enabled | True | +--------------------+-----------------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings telemetry archives](docId\:Daj0PxouZD3s712K5TKUW), [ssc settings telemetry update enabled](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings telemetry archives :::Paragraph{indent="1"} Lists the telemetry files that have been created by Services Director. ::: ### Syntax ```bash show ssc settings telemetry archives ``` ### Usage Guidelines :::Paragraph{indent="1"} To view the contents of archived telemetry files, start the Operating System shell (see [Accessing the OS Shell](docId:15c9Ii3DlskoeFlMNGkpj)) and view the files from there. ::: :::Paragraph{indent="1"} To enable the creation and export of telemetry data, see [ssc settings telemetry update enabled](docId:2xtd8nOKdlgsAEu6GI3W6)). ::: ### Examples ```bash amnesiac (config) # show ssc settings telemetry archives +---------------------+--------------------------------+ | Date | Path | +---------------------+--------------------------------+ | 2018-05-24 13:17:48 | /var/opt/tms/telemetry/telem_1 | | 2018-05-24 13:17:49 | /var/opt/tms/telemetry/telem_2 | | 2018-05-24 13:17:51 | /var/opt/tms/telemetry/telem_3 | | 2018-05-24 13:31:11 | /var/opt/tms/telemetry/telem_4 | | 2018-05-24 13:31:16 | /var/opt/tms/telemetry/telem_5 | +---------------------+--------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings telemetry ](docId\:Daj0PxouZD3s712K5TKUW), [ssc settings telemetry update enabled](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc settings throughput :::Paragraph{indent="1"} Displays Services Director bandwidth-pack expiry warning settings. ::: ### Syntax ```bash show ssc settings throughput ``` ### Examples ```bash amnesiac (config) # show ssc settings throughput +---------------------+-------+ | Field | Value | +---------------------+-------+ | expiry_warning_days | 30 | +---------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings throughput update exp-warningdays](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc sku sku-name :::Paragraph{indent="1"} Displays Services Director SKU details. ::: ### Syntax ```bash show ssc sku [ show-all [ true | false ] ] sku-name name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the SKU. ::: ### Usage Guidelines :::Paragraph{indent="1"} By default, the auto-completion for sku-name only includes SKUs that are compatible with your license. ::: :::Paragraph{indent="1"} The show-all switch affects how auto-completion of sku-name. If show-all is set to true, the auto-completion for the SKU names includes all SKUS, and not just those that are compatible with your license. ::: ### Examples ```bash *** auto-completion (tab key) is limited to SKUS compatible with your license *** amnesiac (config) # show ssc sku sku-name ENT-ADVANCED ENT-ENTERPRISE ENT-WAFPROXY STM-100 STM-200 STM-300 STM-400 STM-WAFPROXY *** auto-completion (tab key) includes all SKUS, not just compatible ones *** amnesiac (config) # show ssc sku show-all true sku-name BR-ADC-UTILM-WAFP1G-U-01 BR-ADC-UTLM-ADV150M-U-01 BR-ADC-UTLM-ENT10G-U-01 BR-ADC-UTLM-ENT60M-U-01 BR-ADC-UTLM-STD500M-U-01 BR-ADC-UTILM-WAFP3G-U-01 BR-ADC-UTLM-ADV1G-U-01 BR-ADC-UTLM-ENT10M-U-01 BR-ADC-UTLM-STD100M-U-01 BR-ADC-UTLM-STD5G-U-01 BR-ADC-UTILM-WAFP400M-U-01 BR-ADC-UTLM-ADV200M-U-01 BR-ADC-UTLM-ENT150M-U-01 BR-ADC-UTLM-STD10G-U-01 BR-ADC-UTLM-STD60M-U-01 BR-ADC-UTILM-WAFP50M-U-01 BR-ADC-UTLM-ADV20M-U-01 BR-ADC-UTLM-ENT1G-U-01 BR-ADC-UTLM-STD10M-U-01 ENT-ADVANCED BR-ADC-UTILM-WAFP5G-U-01 BR-ADC-UTLM-ADV300M-U-01 BR-ADC-UTLM-ENT200M-U-01 BR-ADC-UTLM-STD150M-U-01 ENT-ENTERPRISE BR-ADC-UTLH-ADVHRLY-U-01 BR-ADC-UTLM-ADV3G-U-01 BR-ADC-UTLM-ENT20M-U-01 BR-ADC-UTLM-STD1G-U-01 ENT-WAFPROXY BR-ADC-UTLH-ENTHRLY-U-01 BR-ADC-UTLM-ADV40M-U-01 BR-ADC-UTLM-ENT300M-U-01 BR-ADC-UTLM-STD200M-U-01 STM-100 BR-ADC-UTLH-STDHRLY-U-01 BR-ADC-UTLM-ADV500M-U-01 BR-ADC-UTLM-ENT3G-U-01 BR-ADC-UTLM-STD20M-U-01 STM-200 BR-ADC-UTLM-ADV100M-U-01 BR-ADC-UTLM-ADV5G-U-01 BR-ADC-UTLM-ENT40M-U-01 BR-ADC-UTLM-STD300M-U-01 STM-300 BR-ADC-UTLM-ADV10G-U-01 BR-ADC-UTLM-ADV60M-U-01 BR-ADC-UTLM-ENT500M-U-01 BR-ADC-UTLM-STD3G-U-01 STM-400 BR-ADC-UTLM-ADV10M-U-01 BR-ADC-UTLM-ENT100M-U-01 BR-ADC-UTLM-ENT5G-U-01 BR-ADC-UTLM-STD40M-U-01 STM-WAFPROXY *** show details for an included SKU *** amnesiac (config) # show ssc sku sku-name STM-400 +--------------------+----------------------------------------------------------- | Field | Value +--------------------+----------------------------------------------------------- | status | Active | pricing_model | hourly | add_on_skus | [u'ADD-FIPS', u'ADD-WAF', u'ADD-WEBACCEL'] | feature_tier | STM-400 | features | anlyt : Enable Realtime Analytics. | | auto : Enable Autoscaling. | | bwm : Enable Bandwidth Management classes. | | cache : Enable Web Caching | | comp : Enable Compression | | cr : Do not limit the user to cut-down RuleBuilder ... | | evnts : Enable Events and Actions | | glb : Enable Global Load Balancing | | java : Enable Java. | | kcd : Kerberos Constrained Delegation | | lbcel : Array of cells. | | lbcon : Least connection based. | | lbfail: Balance failure class (used only for testing ... | | lbone : Always choose first node in a pool (used ... | | lbrnd : Random. | | lbrob : Round robin. . . . | | spnam : Named node session persistence. | | spsar : Transparent session affinity. | | spssl : SSL session ID session persistence. | | spuni : Universal session persistence. | | spxze : X-Zeus-backend cookie session persistence. | | ssl : Enable SSL | | svcprt: Enable Service Protection classes | | ts : Enable TrafficScript | | xml : Enable XML functions in TrafficScript. | info | | stm_u | STM-400 | fixed_..._usage | None | ent | True | resource_unit | None | csp | True +--------------------+----------------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [ssc sku list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc stm images :::Paragraph{indent="1"} Displays list of vTM imported images ::: ### Syntax ```bash show ssc stm images ``` ### Examples ```bash amnesiac (config) # show ssc stm images ---------------------------------------- ZeusTM101_Linux-x86_64.tgz ``` ### Related Commands :::Paragraph{indent="1"} [ssc stm import-image file](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc stm license-file :::Paragraph{indent="1"} Displays a list of Virtual Traffic Manger licenses. ::: ### Syntax ```bash show ssc stm license-file ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: ### Examples ```bash amnesiac (config) # show ssc stm license-file # Virtual Traffic Manager - License Key File # # This file enables Virtual Traffic Manager to run subject to the conditions # specified within the key. The license key should be imported into the product # using the web administration interface. # # The following values are encoded within the encrypted license key, and are # provided as a reminder to system administrators of the values. # # Info: # Product: Stingray Traffic Manager # License Type: SSC # License Serial: 1234 # Issued on: Mon, 15 Jul 2017 00:00:00 GMT # # Valid Until: Thu, 15 Aug 2017 10:00:00 GMT # # Features: # Application Firewall: No # Advanced Connection Analytics: No # Aptimizer: No *** partial listing only *** ``` ### Related Commands :::Paragraph{indent="1"} [ssc stm import-lic](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc user user-name :::Paragraph{indent="1"} Displays Services Director user details. ::: ### Syntax ```bash show ssc user user-name name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the user. ::: ### Examples ```bash amnesiac (config) # show ssc user user-name admin +----------+-------+ | Field | Value | +----------+-------+ | username | admin | | active | True | +----------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc user create user-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc version version-name :::Paragraph{indent="1"} Displays vTM versions available for deployment. ::: ### Syntax ```bash show ssc version version-name name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager version. ::: ### Examples ```bash amnesiac (config) # show ssc version version-name 10.1 +------------------+-----------------------------+ | Field | Value | +------------------+-----------------------------+ | info | | | status | Active | | version_filename | ZeusTM_101_Linux-x86_64.tgz | +------------------+-----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc version update version-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc vtm-admin-ca :::Paragraph{indent="1"} Displays full details of a specified vTM CA certificate. This certificate is required to enable communications with a secure LDAP authentication server. ::: ### Syntax ```bash show ssc vtm-admin-ca admin-ca-name ca-certificate-name ``` ### Parameters ```bash admin-ca-name ca-certificate-name ``` :::Paragraph{indent="1"} Specify the name or ID of a CA certificate present on Services Director. ::: ### Examples ```bash *** List all CA certificates on Services Director *** amnesiac (config) # ssc vtm-admin-ca list +----------+----------------------------------+ | Name | Unique ID | +----------+----------------------------------+ | VTM-CA-1 | VTM-Admin-CA-KBBH-G7LT-K6SK-B6N4 | | VTM-CA-2 | VTM-Admin-CA-6J21-KKH3-VSAJ-3209 | +----------+----------------------------------+ *** Display details for a vTM CA certificate *** amnesiac (config) # show ssc vtm-admin-ca admin-ca-name VTM-CA-1 +-----------------------+-------------------------------------------------------... | Field | Value +-----------------------+-------------------------------------------------------... | admin_ca_id | VTM-Admin-CA-KBBH-G7LT-K6SK-B6N4 | tag | CA-1 | certificate_authority | -----BEGIN CERTIFICATE----- | | MIICWDCCAcGgAwIBAgIJAOmKu/JQQpwnMA0GCSqGSIb3DQEBCwUAMl... . . . | | XF9oRLSissZA+pXJe4kUT7R01jpCWWd0G4v5Dl+UaoesbALTWBXKJs... | | Otq69iXpnasFp5flIihAAd4VLGTwC4cNo7ax+Q== | | -----END CERTIFICATE----- | children | None +-----------------------+-------------------------------------------------------... ``` ### Related Commands :::Paragraph{indent="1"} [ssc vtm-admin-ca create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-admin-ca list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-admin-ca update](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator add ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc vtm-authenticator :::Paragraph{indent="1"} Displays full details of a specified vTM authenticator. This can be for an LDAP, RADIUS or TACACS+ server. ::: ### Syntax ```bash show ssc vtm-authenticator auth-name authenticator-name ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify the name of the vTM authenticator. ::: ### Examples ```bash *** example secure LDAP authenticator *** amnesiac (config) # show ssc vtm-authenticator auth-name "LDAP Server" +-------------------------------+---------------------------------------------+ | Description | Value | +-------------------------------+---------------------------------------------+ | Name | LDAP Server | | Type | ldap | | Server Address | dc1.dev-win19.demo.com | | DN Method | construct | | Filter | sAMAccountName=%u | | Base DN | CN=Users,DC=dev-win19,DC=demo,DC=com | | SSL mode | | | Fallback vTM permission group | admin | | Server Port | 389 | | Timeout | 30 | | Group Attribute | memberOf | | Group Field | CN | | Bind DN | %u@dev- win19.demo.com | | Group Filter | | | Search DN | | | Search Password | ***** | +-------------------------------+---------------------------------------------+ *** example RADIUS authenticator *** amnesiac (config) # show ssc vtm-authenticator auth-name Authenticator-808G-LJWJ-MT3B-WMDZ +---------------------------+-----------------+ | Description | Value | +---------------------------+-----------------+ | Name | RADIUS Server | | Type | radius | | Server Address | 10.62.167.194 | | Fallback permission group | admin | | Server Port | 1812 | | Timeout | 30 | | Group Attribute | 1 | | Secret | ***** | | Group Vendor | 1476 | | NAS Identifier | Internal RADIUS | | NAS IP address | 127.0.0.1 | +---------------------------+-----------------+ *** example TACACS+ server *** amnesiac (config) # show ssc vtm-authenticator auth-name Authenticator-7F1D-A1K3-1PO4-VSEF +---------------------------+------------------+ | Description | Value | +---------------------------+------------------+ | Name | TACACS+ Server | | Type | tacacs_plus | | Server Address | 10.62.167.195 | | Authentication Type | pap | | Fallback permission group | admin | | Server Port | 49 | | Timeout | 30 | | Group Field | permission-group | | Secret | ***** | | Group Service | Hoobland | +---------------------------+------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc vtm-admin-ca create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator add radius auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator add tacacs\_plus auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update radius auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update tacacs\_plus auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### show ssc vtm-permission-group :::Paragraph{indent="1"} Displays details for a specified vTM permission group. ::: ### Syntax ```bash show ssc vtm-permission-group pg-name permission-group ``` ### Parameters :::Paragraph{indent="2"} `pg-name permission-group` ::: :::Paragraph{indent="1"} Specify the required permission-group. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is also available in user and enable mode. ::: :::Paragraph{indent="1"} There are four default permission groups (admin, Demo, Monitoring and Guest), and you can create additional vTM permission groups, see [ssc vtm-permission-group list](docId:2xtd8nOKdlgsAEu6GI3W6). ::: :::Paragraph{indent="1"} Each permission supports the following access levels: ro (read-only), full. ::: :::Paragraph{indent="1"} Where a permission branch node and all of its leaf nodes share a permission, only the permission branch node and its access level are displayed. ::: :::Paragraph{indent="1"} Where all permissions share a single access level, the permission "all" is used. The admin permission group has this setting by default. ::: ### Examples ```bash *** show permissions for the admin group *** amnesiac (config) # show ssc vtm-permission-group pg-name admin +--------------+---------------------------------------------------+--------+ | Parameter | Value | | +--------------+---------------------------------------------------+--------+ | Name | admin | | | Unique Name | admin | | | Description | Full access to all pages | | | Timeout | 30 | | | Permissions: | ------------------------------------------------- | ------ | | | Permission String | Access | | | ------------------------------------------------- | ------ | | | all | full | +--------------+---------------------------------------------------+--------+ *** show permissions for the Demo group *** amnesiac (config) # show ssc vtm-permission-group pg-name Demo +--------------+---------------------------------------------------+--------+ | Parameter | Value | | +--------------+---------------------------------------------------+--------+ | Name | Demo | | | Unique Name | Demo | | | Description | Full access, except to user management / system | | | Timeout | 30 | | | Permissions: | ------------------------------------------------- | ------ | | | Permission String | Access | | | ------------------------------------------------- | ------ | | | Access_Management | ro | | | Alerting | full | | | Appliance_Console | none | | | Aptimizer | full | | | Audit_Log | full | | | Backup | ro | | | Bandwidth | full | | | Catalog | full | | | Config_Summary | full | | | Configure | full | | | Connections | full | | | Custom | full | | | DateTime | ro | | | Diagnose | full | . . . | | Rules | full | | | SLM | full | | | SNMP | ro | | | SOAP_API | none | | | SSL | full | | | Security | ro | | | Service_Protection | full | | | Shutdown | ro | | | Statd | full | | | Support | full | | | Traffic_IP_Groups | full | | | Traffic_Managers | full | | | Traffic_Managers!AddRemove | none | | | Traffic_Managers!Upgrade | none | | | Virtual_Servers | full | | | Web_Cache | full | | | Web_Cache!Clear | none | | | Wizard | full | | | Wizard!Backup | none | | | Wizard!ClusterJoin | none | | | Wizard!FreeDiskSpace | none | | | Wizard!Restore | none | +--------------+---------------------------------------------------+--------+ *** show permissions for the Guest group *** amnesiac (config) # show ssc vtm-permission-group pg-name Guest +--------------+---------------------------------------------------+--------+ | Parameter | Value | | +--------------+---------------------------------------------------+--------+ | Name | Guest | | | Unique Name | Guest | | | Description | Read-only access | | | Timeout | 30 | | | Permissions: | ------------------------------------------------- | ------ | | | Permission String | Access | | | ------------------------------------------------- | ------ | | | Access_Management | ro | | | Alerting | ro | | | Appliance_Console | none | | | Aptimizer | ro | | | Audit_Log | none | | | Backup | ro | | | Bandwidth | ro | | | Catalog | ro | | | Config_Summary | ro | | | Configure | ro | | | Connections | full | | | Custom | ro | | | DateTime | ro | | | Diagnose | ro | | | Draining | ro | . . . | | Rate | ro | | | Reboot | ro | | | Request_Logs | ro | | | Restart | ro | | | Rules | ro | | | SLM | ro | | | SNMP | ro | | | SOAP_API | none | | | SSL | ro | | | Security | ro | | | Service_Protection | ro | | | Shutdown | ro | | | Statd | full | | | Support | ro | | | Traffic_IP_Groups | ro | | | Traffic_Managers | ro | | | Traffic_Managers!AddRemove | none | | | Traffic_Managers!Upgrade | none | | | Virtual_Servers | ro | | | Web_Cache | full | | | Web_Cache!Clear | none | | | Wizard | ro | +--------------+---------------------------------------------------+--------+ *** show permissions for the Monitoring group *** amnesiac (config) # show ssc vtm-permission-group pg-name Monitoring +--------------+---------------------------------------------------+--------+ | Parameter | Value | | +--------------+---------------------------------------------------+--------+ | Name | Monitoring | | | Unique Name | Monitoring | | | Description | Access only to config summary / monitoring pages | | | Timeout | 30 | | | Permissions: | ------------------------------------------------- | ------ | | | Permission String | Access | | | ------------------------------------------------- | ------ | | | Access_Management | none | | | Access_Management!LocalUsers!Edit | full | | | Access_Management!LocalUsers!EditOtherUsers | none | | | Alerting | none | | | Appliance_Console | none | | | Aptimizer | none | | | Audit_Log | none | | | Backup | none | | | Bandwidth | none | | | Catalog | none | | | Config_Summary | full | | | Configure | none | | | Connections | full | | | Custom | none | . . . | | Request_Logs | none | | | Restart | none | | | Rules | none | | | SLM | none | | | SNMP | none | | | SOAP_API | none | | | SSL | none | | | Security | none | | | Service_Protection | none | | | Shutdown | none | | | Statd | full | | | Support | none | | | Traffic_IP_Groups | none | | | Traffic_Managers | none | | | Virtual_Servers | none | | | Web_Cache | full | | | Web_Cache!Clear | none | | | Wizard | none | +--------------+---------------------------------------------------+--------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc vtm-permission-group create pg-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-permission-group list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-permission-group update pg-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### snmp-server acl :::Paragraph{indent="1"} Configures changes to the View-Based Access Control Model (VACM) ACL configuration. ::: ### Syntax ```bash [no] snmp-server acl group name security-level level read-view name ``` ### Parameters ```bash group name ``` :::Paragraph{indent="1"} Specify the name of the SNMP server community. ::: ```bash security-level level ``` :::Paragraph{indent="1"} Specify the security level for this ACL entry. ::: :::Paragraph{listStyleType="disc" indent="3"} noauth: Does not authenticate packets and does not use privacy. This is the default setting. ::: :::Paragraph{listStyleType="disc" indent="3"} auth: Authenticates packets but does not use privacy. ::: :::Paragraph{listStyleType="disc" indent="3"} authpriv: Authenticates packets and uses privacy. ::: :::hint{type="info"} This setting determines whether a single atomic message exchange is authenticated. ::: :::hint{type="info"} A security level applies to a group, not to an individual user. ::: ```bash read-view name ``` :::Paragraph{indent="1"} Specify that read requests will be restricted to this view. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables an SNMP server community. ::: ### Examples ```bash amnesiac (config) # snmp-server acl group ReadOnly security-level auth read-view ReadOnly ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server community :::Paragraph{indent="1"} Sets an SNMP read-only server community. ::: ### Syntax ```bash [no] snmp-server community name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the name of the SNMP server community. ::: :::Paragraph{indent="1"} The # and - characters are not allowed at the beginning of the \ argument. If you use either of these characters at the beginning of the \ argument, the CLI returns the following error message: ::: ```bash % Invalid SNMP community name ``` ### Usage Guidelines :::Paragraph{indent="1"} You can still access the entire MIB tree from any source host using this setting. If you do not want this type of access, you must delete this option and configure the security name for SNMP ACL support. For details, see [snmp-server host](docId\:Daj0PxouZD3s712K5TKUW). ::: :::Paragraph{indent="1"} This community string overrides any VACM settings. ::: :::Paragraph{indent="1"} The** no** command option disables an SNMP server community. ::: ### Examples ```bash amnesiac (config) # snmp-server community ReaDonLy ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server contact :::Paragraph{indent="1"} Sets the SNMP server contact. ::: ### Syntax ```bash [no] snmp-server contact name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the user name of the SNMP server community contact. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the SNMP server contact. ::: ### Examples ```bash amnesiac (config) # snmp-server contact john doe ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server enable :::Paragraph{indent="1"} Enables an SNMP server. ::: ### Syntax ```bash [no] snmp-server enable | [traps] ``` ### Parameters ```bash traps ``` :::Paragraph{indent="1"} Enables sending of SNMP traps from this system. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the SNMP server or traps. ::: ### Examples ```bash amnesiac (config) # snmp-server enable traps ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server group :::Paragraph{indent="1"} Configures the View Access Control Model (VACM) group configuration. ::: ### Syntax ```bash [no] snmp-server group group security-name name security-model model ``` ### Parameters ```bash group group ``` :::Paragraph{indent="1"} Specify a group name. ::: ```bash security-name name ``` :::Paragraph{indent="1"} Specify a name to identify a requester (allowed to issue gets and sets) or a recipient (allowed to receive traps) of management data. The security name is also required to make changes to the VACM security name configuration. ::: ```bash security-model model ``` :::Paragraph{indent="1"} Specify one of the following security models: ::: :::Paragraph{listStyleType="disc" indent="3"} v1: Enables SNMPv1 security model. ::: :::Paragraph{listStyleType="disc" indent="3"} v2c: Enables SNMPv2c security model. ::: :::Paragraph{listStyleType="disc" indent="3"} usm: Enables User-based Security Model (USM). ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the SNMP server group. ::: ### Examples ```bash amnesiac (config) # snmp-server group rvbdgrp security-name security-model v1 ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server host :::Paragraph{indent="1"} Configures hosts to which to send SNMP traps. ::: ### Syntax ```bash [no] snmp-server host {hostname | IPv4-addr | IPv6-addr} traps community-string ``` ### Parameters ```bash hostname | IPv4-addr | IPv6-addr ``` :::Paragraph{indent="1"} Specify the hostname, IPv4 address, or IPv6 address for the SNMP server. ::: ```bash traps community-string ``` :::Paragraph{indent="1"} Send traps to the specified host. Specify the password-like community string to control access. Use a combination of uppercase, lowercase, and numerical characters to reduce the chance of unauthorized access to the appliance. The # and - characters are not allowed at the beginning of the \ argument. ::: :::hint{type="info"} If you specify a read-only community string, it takes precedence over this community name and allows users to access the entire MIB tree from any source host. If this is not desired, delete the read-only community string. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the SNMP server host. ::: ### Examples ```bash amnesiac (config) # snmp-server host 10.0.0.1 traps public ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server host version :::Paragraph{indent="1"} Configures the SNMP version of traps to send to the host. ::: ### Syntax ```bash [no] snmp-server host {hostname | IPv4-addr | IPv6-addr} traps version { 1 | 2 c | 3 remote-user name} password encrypted key auth-protocol {MD5 | SHA} security-level {noauth | auth | authpriv} | plain-text text auth-protocol MD5 | SHA [ security-level {noauth | auth | authpriv}] | [priv-protocol {AES | DES} priv-key {encrypted key | plaintext text}] [port port] ``` ### Parameters ```bash hostname-or-ip-addr ``` :::Paragraph{indent="1"} Specify the hostname, IPv4 address, or IPv6 address for the SNMP server. ::: ```bash traps ``` :::Paragraph{indent="1"} Send traps to the specified host. ::: ```bash version ``` :::Paragraph{indent="1"} Specify the SNMP version of traps to send to this host: ::: :::Paragraph{listStyleType="disc" indent="3"} 1: Specifies SNMPv1. ::: :::Paragraph{listStyleType="disc" indent="3"} 2c: Specifies SNMPv2c. ::: :::Paragraph{listStyleType="disc" indent="3"} 3: Specifies SNMPv3. This setting requires the remote-user property to be set. ::: ```bash remote-user name ``` :::Paragraph{indent="1"} For SNMPv3 specify the user name. ::: ```bash password ``` :::Paragraph{indent="1"} Specify the password type: ::: :::Paragraph{listStyleType="disc" indent="3"} encrypted: Enable encrypted password authentication. This require ::: :::Paragraph{listStyleType="disc" indent="3"} plaintext: Enable plain-text password authentication. ::: ```bash encrypted key ``` :::Paragraph{indent="1"} For SNMPv3 specify the user password. ::: ```bash auth-protocol ``` :::Paragraph{indent="1"} Specify the authorization protocol: ::: :::Paragraph{listStyleType="disc" indent="3"} MD5: Enable MD5 security protocol. ::: :::Paragraph{listStyleType="disc" indent="3"} SHA: Enable SHA security protocol. ::: ```bash security-level ``` :::Paragraph{indent="1"} Specify the security level: ::: :::Paragraph{listStyleType="disc" indent="3"} noauth: Specify no authorization required. ::: :::Paragraph{listStyleType="disc" indent="3"} auth: Specify authorization required. ::: :::Paragraph{listStyleType="disc" indent="3"} authpriv: Specify authorization and privacy required. ::: ```bash priv-protocol ``` :::Paragraph{indent="1"} Specify the privacy protocol: ::: :::Paragraph{listStyleType="disc" indent="3"} AES: Specify CFB128-AES-128 as the privacy protocol. ::: :::Paragraph{listStyleType="disc" indent="3"} DES: Specify CBC-DES as the privacy protocol. ::: ```bash priv-key ``` :::Paragraph{indent="1"} Specify the privacy key: ::: :::Paragraph{listStyleType="disc" indent="3"} encrypted key: Specify encrypted privacy key. ::: :::Paragraph{listStyleType="disc" indent="3"} plaintext text: Specify plain-text privacy key. The plain-text privacy key must be at least 8 characters. ::: ```bash port port ``` :::Paragraph{indent="1"} Optionally, specify the destination port. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the SNMP server host. ::: ### Examples ```bash amnesiac (config) # snmp-server host 10.0.0.1 traps version 1 "public 99162?" port 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo), [snmp-server community](docId\:Daj0PxouZD3s712K5TKUW), [snmp-server security-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### snmp-server ifindex :::Paragraph{indent="1"} Adds a custom index value for an interface. ::: ### Syntax ```bash snmp-server ifindex interface index ``` ### Parameters ```bash interface ``` :::Paragraph{indent="1"} Specify the interface: **wan0\_0**, **lan0\_0**, **wan0\_1**, **lan0\_1**, **primary**, **aux**, **inpath0\_0**, **inpath0\_1** ::: ```bash index ``` :::Paragraph{indent="1"} Specify the index. ::: ### Examples ```bash amnesiac (config) # snmp-server ifindex aux 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server ifindex-persist :::Paragraph{indent="1"} Enables persistent SNMP interface indexes. ::: ### Syntax ```bash [no] snmp-server ifindex-persist ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the SNMP server group. ::: ### Examples ```bash amnesiac (config) # snmp-server ifindex-persist ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server ifindex-reset :::Paragraph{indent="1"} Resets the ifindex values of all interfaces to the factory default value. ::: ### Syntax ```bash snmp-server ifindex-reset ``` ### Examples ```bash amnesiac (config) # snmp-server ifindex-reset ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server listen enable :::Paragraph{indent="1"} Enables SNMP server interface restrictions (that is, it enables access control and blocks requests on all the interfaces). ::: ### Syntax ```bash [no] snmp-server listen enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables SNMP interface restrictions. ::: :::Paragraph{indent="1"} SNMP interface restrictions are not available through the Management Console. ::: ### Examples ```bash amnesiac (config) # snmp-server listen enable ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server listen interface :::Paragraph{indent="1"} Adds an interface to the SNMP server access restriction list. ::: ### Syntax ```bash [no] snmp-server listen interface interface ``` ### Parameters ```bash interface ``` :::Paragraph{indent="1"} Specify the interface:** primary**,** aux**,** inpath0\_0**,** rios\_lan0\_0**,** rios\_wan0\_0** ::: ### Usage Guidelines :::Paragraph{indent="1"} If the list of interfaces is empty, none of the interfaces respond to the queries. If the list of interfaces has at least one entry, then the server listens on that subset of interfaces. ::: :::Paragraph{indent="1"} To add an interface to the list to listen on: ::: ```bash snmp-server listen interface primary ``` :::Paragraph{indent="1"} To remove an interface from the list: ::: ```bash no snmp-server listen interface ``` ### Examples ```bash amnesiac (config) # snmp-server listen interface aux ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server location :::Paragraph{indent="1"} Sets the value for the system location variable in the MIB. ::: ### Syntax ```bash [no] snmp-server location ip-addr ``` ### Parameters ```bash ip-addr ``` :::Paragraph{indent="1"} Specify the IP address of the system. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the SNMP server location. ::: ### Examples ```bash amnesiac (config) # snmp-server location 10.10.10.1 ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server security-name :::Paragraph{indent="1"} Configures the SNMP security name. ::: ### Syntax ```bash [no] snmp-server security-name name community community-string source IPv4-addr | IPv6-addr netmask ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the security name. ::: ```bash community community-string ``` :::Paragraph{indent="1"} Specify the password-like community string to control access. Use a combination of uppercase, lowercase, and numerical characters to reduce the chance of unauthorized access to the appliance. Community strings allow printable 7-bit ASCII characters except for white spaces. Community strings can not begin with ’#’ or ’-’. ::: :::Paragraph{indent="1"} If you specify a read-only community string, it takes precedence over this community name and allows users to access the entire MIB tree from any source host. If this is not desired, delete the read-only community string. ::: ```bash source IPv4-addr | IPv6-addr netmask ``` :::Paragraph{indent="1"} Specify the source IPv4 address or IPv6 address and netmask. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the trap interface. ::: ### Examples ```bash amnesiac (config) # snmp-server security-name community public source 10.1.2.3/24 ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server trap-interface :::Paragraph{indent="1"} Configures the system to use the IP address of the specified interface in the SNMP trap header. ::: ### Syntax ```bash [no] snmp-server trap-interface interface ``` ### Parameters ```bash interface ``` :::Paragraph{indent="1"} Specify the interface. ::: ### Usage Guidelines :::Paragraph{indent="1"} The trap interface setting sets which interface IP address is used in the agent-address header field of SNMP v1 trap Protocol Data Units (PDUs). It does set the interface for the trap. ::: :::Paragraph{indent="1"} Traps are sent out the Primary interface. If the primary interface is physically disconnected, no traps are sent. Traps can be sent out the auxiliary interface if the trap receiver is reachable from the auxiliary interface. ::: :::Paragraph{indent="1"} The **no** command option disables the trap interface. ::: ### Examples ```bash amnesiac (config) # snmp-server trap-interface aux ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server trap-test :::Paragraph{indent="1"} Generates an SNMP trap test. ::: ### Syntax ```bash snmp-server trap-test ``` ### Usage Guidelines :::Paragraph{indent="1"} Use this command to send a sample trap test to ensure that the SNMP server is monitoring the appliance. ::: ### Examples ```bash amnesiac (config) # snmp-server trap-test ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server user :::Paragraph{indent="1"} Configures changes to the User-Based Security (UBS) model. ::: ### Syntax ```bash [no] snmp-server user name password {encrypted key | plaintext text} auth-protocol {MD5 | SHA} [priv-protocol {AES | DES} priv-key {encrypted key | plain-text text}] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the user name. ::: ```bash password ``` :::Paragraph{indent="1"} Specify the password type: ::: :::Paragraph{listStyleType="disc" indent="3"} encrypted key: Enable encrypted password authentication. ::: :::Paragraph{listStyleType="disc" indent="3"} plaintext text: Enable plain-text password authentication. The plain-text password must be at least 8 characters. ::: ```bash auth-protocol ``` :::Paragraph{indent="1"} Specify the authorization protocol: ::: :::Paragraph{listStyleType="disc" indent="3"} MD5: Enable MD5 security protocol. ::: :::Paragraph{listStyleType="disc" indent="3"} SHA: Enable SHA security protocol. ::: ```bash priv-protocol ``` :::Paragraph{indent="1"} Specify the privacy protocol: ::: :::Paragraph{listStyleType="disc" indent="3"} AES: Specify CFB128-AES-128 as the privacy protocol. ::: :::Paragraph{listStyleType="disc" indent="3"} DES: Specify CBC-DES as the privacy protocol. ::: ```bash priv-key ``` :::Paragraph{indent="1"} Specify the privacy key: ::: :::Paragraph{listStyleType="disc" indent="3"} encrypted key: Specify encrypted privacy key. ::: :::Paragraph{listStyleType="disc" indent="3"} plaintext text: Specify plain-text privacy key. The plain-text privacy key must be at least 8 characters. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this option. ::: ### Examples ```bash amnesiac (config) # snmp-server user testuser password plain-text testpass auth-protocol SHA ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### snmp-server view :::Paragraph{indent="1"} Configures changes to the View-based Access Control Model (VACM) configuration. ::: ### Syntax ```bash [no] snmp-server view name [excluded | included] oid ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the user name. ::: ```bash excluded ``` :::Paragraph{indent="1"} View option. Excludes an oid sub-tree from this view. ::: ```bash included ``` :::Paragraph{indent="1"} View option. Includes an OID subtree into this view. ::: ```bash oid ``` :::Paragraph{indent="1"} Specify the object ID. For example: .1.3.6.1.2.1.1 or .iso.org.dod.internet.mgmt.mib-2.system ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this option. ::: ### Examples ```bash amnesiac (config) # snmp-server view joedoe included .1.3.6.1.2.1.1 ``` ### Related Commands :::Paragraph{indent="1"} [show snmp](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### ssc access-profile add-perm-group :::Paragraph{indent="1"} Adds a permission group to a specified access profile. ::: ### Syntax ```bash ssc access-profile add-perm-group access-profile-name access-profile-name perm-group-name permission-group-name ``` ### Parameters ```bash access-profile-name ``` :::Paragraph{indent="1"} Specify the name of an existing access profile. ::: ```bash permission-group-name ``` :::Paragraph{indent="1"} Specify the name of a single permission group to add to the access profile. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command only enables you to add one permission group at a time. To add additional permission groups to the same access profile, repeat this command for each permission group. ::: ### Examples ```bash *** confirm access profile has no permission groups *** amnesiac (config) # show ssc access-profile access-profile-name "RADIUS All" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | RADIUS All | | Unique ID | Access-Profile-H4U5-3SIR-7VUV-2AG8 | | Authenticator | RADIUS Server | | Permission Groups | | +-------------------+------------------------------------+ *** add the "admin" permission group to access profile *** amnesiac (config) # ssc access-profile add-perm-group access-profile-name "RADIUS All" perm-group-name admin +-----------------------------------+ | Updated | +-----------------------------------+ | Access profile RADIUS All updated | +-----------------------------------+ *** confirm outcome *** amnesiac (config) # show ssc access-profile access-profile-name "RADIUS All" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | RADIUS All | | Unique ID | Access-Profile-H4U5-3SIR-7VUV-2AG8 | | Authenticator | RADIUS Server | | Permission Groups | admin | +-------------------+------------------------------------+ *** add a second permission group to the same access profile *** amnesiac (config) # ssc access-profile add-perm-group access-profile-name "RADIUS All" perm-group-name Guest +-----------------------------------+ | Updated | +-----------------------------------+ | Access profile RADIUS All updated | +-----------------------------------+ *** confirm outcome *** amnesiac (config) # show ssc access-profile access-profile-name "RADIUS All" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | RADIUS All | | Unique ID | Access-Profile-H4U5-3SIR-7VUV-2AG8 | | Authenticator | RADIUS Server | | Permission Groups | admin | | | Guest | +-------------------+------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc access-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile create access-profile-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile list](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile update access-profile-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc access-profile create access-profile-name :::Paragraph{indent="1"} Creates an access profile and associates it with an authenticator. ::: ### Syntax ```bash ssc access-profile create access-profile-name access-profile-name auth-name authenticator-name ``` ### Parameters ```bash access-profile-name ``` :::Paragraph{indent="1"} Specify the name of the new access profile. ::: ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify the name of an existing authenticator. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command does not support the addition of permission groups, see [ssc access-profile create access-profile-name](docId\:Daj0PxouZD3s712K5TKUW). ::: :::Paragraph{indent="1"} Use the** no ssc access-profile access-profile-name** command to delete an access profile. ::: ### Examples ```bash *** create an access profile *** amnesiac (config) # ssc access-profile create access-profile-name "RADIUS All" auth-name "RADIUS Server" +-----------------------------------+ | Created | +-----------------------------------+ | Access profile RADIUS All created | +-----------------------------------+ *** delete an access profile *** amnesiac (config) # no ssc access-profile access-profile-name "LDAP Read-Only" +---------------------------------------+ | Deleted | +---------------------------------------+ | Access profile LDAP Read-Only deleted | +---------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc access-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile add-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile list](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile update access-profile-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc access-profile list :::Paragraph{indent="1"} Displays a list of all defined access profiles. ::: ### Syntax ```bash ssc access-profile list ``` ### Examples ```bash amnesiac (config) # ssc access-profile list +-----------------+------------------------------------+ | Name | Unique ID | +-----------------+------------------------------------+ | LDAP All | Access-Profile-ZRVA-MXIE-MI92-U787 | | LDAP Read-Only | Access-Profile-DAUH-F3NU-XYYA-MISP | | LDAP Monitoring | Access-Profile-YJ5M-HGIR-B8PZ-C0XU | | RADIUS All | Access-Profile-H4U5-3SIR-7VUV-2AG8 | +-----------------+------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc access-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile add-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile create access-profile-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile update access-profile-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc access-profile remove-perm-group :::Paragraph{indent="1"} Removes a permission group from a specified access profile. ::: ### Syntax ```bash ssc access-profile remove-perm-group access-profile-name access-profile-name perm-group-name permission-group-name ``` ### Parameters ```bash access-profile-name ``` :::Paragraph{indent="1"} Specify the name of an existing access profile. ::: ```bash permission-group-name ``` :::Paragraph{indent="1"} Specify the name of a single permission group to be removed from the access profile. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command only enables you to remove one permission group at a time. To remove additional permission groups from the same access profile, repeat this command for each permission group. ::: ### Examples ```bash *** show current permission groups in an access-profile *** amnesiac (config) # show ssc access-profile access-profile-name "RADIUS All" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | RADIUS All | | Unique ID | Access-Profile-H4U5-3SIR-7VUV-2AG8 | | Authenticator | RADIUS Server | | Permission Groups | admin | | | Guest | +-------------------+------------------------------------+ *** remove one of those permission groups *** amnesiac (config) # ssc access-profile remove-perm-group access-profile-name "RADIUS All" perm-group-name Guest +-----------------------------------+ | Updated | +-----------------------------------+ | Access profile RADIUS All updated | +-----------------------------------+ *** confirm the result *** amnesiac (config) show ssc access-profile access-profile-name "RADIUS All" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | RADIUS All | | Unique ID | Access-Profile-H4U5-3SIR-7VUV-2AG8 | | Authenticator | RADIUS Server | | Permission Groups | admin | +-------------------+------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc access-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile add-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile create access-profile-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile list](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile update access-profile-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc access-profile update access-profile-name :::Paragraph{indent="1"} Updates the details of an access profile, including the authenticator with which it is associated. ::: ### Syntax ```bash ssc access-profile create access-profile-name access-profile-name auth-name authenticator-name ``` ### Parameters ```bash access-profile-name ``` :::Paragraph{indent="1"} Specify the name of the new access profile. ::: ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify the name of an existing authenticator. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command does not support: ::: :::Paragraph{listStyleType="disc" indent="2"} The addition of permission groups from the profile. See [ssc access-profile create access-profile-name](docId\:Daj0PxouZD3s712K5TKUW). ::: :::Paragraph{listStyleType="disc" indent="2"} The removal of permission groups from the profile. See [ssc access-profile update access-profile-name](docId\:Daj0PxouZD3s712K5TKUW). ::: ### Examples ```bash *** show details for an access profile *** amnesiac (config) # show ssc access-profile access-profile-name "LDAP Monitoring" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | LDAP Monitoring | | Unique ID | Access-Profile-YJ5M-HGIR-B8PZ-C0XU | | Authenticator | LDAP Server | | Permission Groups | Guest | +-------------------+------------------------------------+ *** update the name of the access profile *** amnesiac (config) # ssc access-profile update access-profile-name "LDAP Monitoring" new-access-profile-name "LDAP Statistics" +----------------------------------------+ | Updated | +----------------------------------------+ | Access profile LDAP Monitoring updated | +----------------------------------------+ *** confirm the change *** amnesiac (config) # show ssc access-profile access-profile-name "LDAP Statistics" +-------------------+------------------------------------+ | Description | Value | +-------------------+------------------------------------+ | Name | LDAP Statistics | | Unique ID | Access-Profile-YJ5M-HGIR-B8PZ-C0XU | | Authenticator | LDAP Server | | Permission Groups | Guest | +-------------------+------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc access-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile add-perm-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile create access-profile-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile list](docId\:Daj0PxouZD3s712K5TKUW), [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc action list :::Paragraph{indent="1"} Lists Services Director actions. ::: ### Syntax ```bash ssc action list ``` ### Usage Guidelines :::Paragraph{indent="1"} The Services Director can carry out the following actions on Traffic Manager instances: ::: :::Paragraph{listStyleType="disc" indent="2"} deploy an instance with specified parameters ::: :::Paragraph{listStyleType="disc" indent="2"} start and stop an instance ::: :::Paragraph{listStyleType="disc" indent="2"} uninstall an instance ::: :::Paragraph{listStyleType="disc" indent="2"} upgrade an instance ::: ### Examples ```bash amnesiac (config) # ssc action list +--------+ | Action | +--------+ | 1 | +--------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc action update action-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc action update template-name :::Paragraph{indent="1"} Updates a Services Director action based on the specified template. ::: ### Syntax ```bash ssc action update template-name name | [action-name name] | [action-args] | [ status [ Waiting | Pending | Blocked ] ] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash action-name name ``` :::Paragraph{indent="1"} Specify the action name. ::: ```bash action-args ``` :::Paragraph{indent="1"} Optionally, specify one or more action arguments to be modified in the new template. ::: ```bash status ``` :::Paragraph{indent="1"} Specify the status: ::: :::Paragraph{listStyleType="disc" indent="3"} `Waiting: `If the action fails and the underlying problems have been corrected change the status of the original action to Waiting to cause the action to be re-queued and re-tried. ::: :::Paragraph{listStyleType="disc" indent="3"} Pending: If an instance is associated with a failed or blocked action. ::: :::Paragraph{listStyleType="disc" indent="3"} Blocked: If an instance is associated with a blocked action. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates an action with the parameters predefined in an existing template. The existing template is created by the **ssc template create** command. The predefined parameters in the existing template are passed to the resource to update the command. You have the option to replace or add extra parameters that exist in the specified template (that is, add extra arguments). ::: ### Examples ```bash amnesiac (config) # ssc action update action-template test status Waiting ``` ### Related Commands :::Paragraph{indent="1"} [ssc action list](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc action update action-name :::Paragraph{indent="1"} Updates a Services Director action. ::: ### Syntax ```bash ssc action update action-name name status [Waiting | Pending | Blocked] | [Waiting | Pending | Blocked] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the action name. ::: ```bash status ``` :::Paragraph{indent="1"} Specify the status: ::: :::Paragraph{listStyleType="disc" indent="3"} `Waiting: `If the action fails and the underlying problems have been corrected change the status of the original action to Waiting to cause the action to be re-queued and re-tried. ::: :::Paragraph{listStyleType="disc" indent="3"} Pending: If an instance is associated with a failed or blocked action. ::: :::Paragraph{listStyleType="disc" indent="3"} Blocked: If an instance is associated with a blocked action. ::: ### Usage Guidelines :::Paragraph{indent="1"} When a life cycle action is unsuccessful, you might need to intervene to determine the cause of the problem. Each action is recorded in the inventory database. After any underlying problems have been rectified, the action can be re-tried in one of two ways: ::: :::Paragraph{listStyleType="disc" indent="2"} The original action can have its status changed to **Waiting** so that the action is re-queued and re-tried. ::: :::Paragraph{listStyleType="disc" indent="2"} The instance can have its status changed to a desired status and the system deletes the old action and queues an entirely new action based on the status. ::: :::Paragraph{indent="1"} Use the **no ssc action action-name \** command to delete an action. ::: ### Examples ```bash amnesiac (config) # ssc action update action-name test status Waiting ``` ### Related Commands :::Paragraph{indent="1"} [ssc action list](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc analytics-profile create :::Paragraph{indent="1"} Creates a new analytics profile resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc analytics-profile create logs-to-export log-list [tag value] [txn-export Boolean] ``` ### Parameters ```bash logs-to-export ``` :::Paragraph{indent="1"} A comma-separated list of identifiers for log-export resources. By default, this list can include the following log-export resources: ::: :::Paragraph{listStyleType="disc" indent="3"} `Audit Log` ::: :::Paragraph{listStyleType="disc" indent="3"} `Application Firewall` ::: :::Paragraph{listStyleType="disc" indent="3"} `Process Monitor` ::: :::Paragraph{listStyleType="disc" indent="3"} `Admin Server Access` ::: :::Paragraph{listStyleType="disc" indent="3"} `System - syslog` ::: :::Paragraph{listStyleType="disc" indent="3"} `Event Log` ::: :::Paragraph{listStyleType="disc" indent="3"} `Routing Software` ::: :::Paragraph{listStyleType="disc" indent="3"} `Data Plane Acceleration` ::: :::Paragraph{listStyleType="disc" indent="3"} `System - authentication log` ::: :::Paragraph{indent="1"} For example: "Audit Log","Event Log","System - authentication log" ::: :::Paragraph{indent="1"} For details of these logs, see the Virtual Traffic Manager documentation. ::: ```bash tag ``` :::Paragraph{indent="1"} (Optional) The customer-facing name for the analytics-profile resource. If this is not set, the tag is set to the UUID value for the resource. ::: ```bash txn-export ``` :::Paragraph{indent="1"} (Optional) If true, the analytics profile will record that transaction data is enabled. This ensures that any vTM configured using this profile will transmit transaction data (in addition to its assigned logs) to its assigned endpoint. ::: ### Examples ```bash *** list all analytics profiles *** amnesiac (config) # ssc analytics-profile list +---------------------------------------+----------------+ | ID | Tag | +---------------------------------------+----------------+ | Analytics-Profile-6IQG-F6UQ-8C11-7G8F | Audit + System | | Analytics-Profile-F5V3-S912-G3UP-HPNR | Event | | Analytics-Profile-XNAH-H9J1-0MQM-BK59 | Audit | | Analytics-Profile-I6DJ-RRQV-KQ5Z-HY7J | Event + System | | Analytics-Profile-SXSR-UCDA-JJDS-1Q3K | Audit + Event | | Analytics-Profile-CHM8-D0PC-58BW-I8GI | System | +---------------------------------------+----------------+ *** create an analytics profile that combines Audit, Events and System *** amnesiac (config) # ssc analytics-profile create logs-to-export "Audit Log","Event Log","System - authentication log" tag "Audit + Event + System" txn-export true +---------------------------+---------------------------------------------------+ | Field | Value | +---------------------------+---------------------------------------------------+ | tag | Audit + Event + System | | enable_transaction_export | True | | vtm_logs_to_export | Audit Log, Event Log, System - authentication log | | analytics_profile_id | Analytics-Profile-V613-KAI2-4N49-MTL6 | +---------------------------+---------------------------------------------------+ *** list all analytics profiles to confirm creation *** amnesiac (config) # ssc analytics-profile list +---------------------------------------+------------------------+ | ID | Tag | +---------------------------------------+------------------------+ | Analytics-Profile-6IQG-F6UQ-8C11-7G8F | Audit + System | | Analytics-Profile-F5V3-S912-G3UP-HPNR | Event | | Analytics-Profile-XNAH-H9J1-0MQM-BK59 | Audit | | Analytics-Profile-I6DJ-RRQV-KQ5Z-HY7J | Event + System | | Analytics-Profile-V613-KAI2-4N49-MTL6 | Audit + Event + System | | Analytics-Profile-SXSR-UCDA-JJDS-1Q3K | Audit + Event | | Analytics-Profile-CHM8-D0PC-58BW-I8GI | System | +---------------------------------------+------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc analytics-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc analytics-profile list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc analytics-profile update](docId\:LLjz7el7U_q1thWAbTl0A) :::