Config-Mode Commands
ssc analytics-profile delete
Delete a specified analytics profile resource. This resource is used for vTM analytics.
Syntax
ssc analytics-profile delete id profile-idParameters
id profile-idThe identifier for the analytics profile resource, either its tag or its UUID.
Examples
*** 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-V613-KAI2-4N49-MTL6 | Audit + Event + System |
| Analytics-Profile-SXSR-UCDA-JJDS-1Q3K | Audit + Event |
| Analytics-Profile-CHM8-D0PC-58BW-I8GI | System |
+---------------------------------------+------------------------+
*** delete an analytics profile ***
amnesiac (config) # ssc analytics-profile delete id Event
+-----------------------------------------------------------------+
| Deleted |
+-----------------------------------------------------------------+
| Analytics Profile Analytics-Profile-F5V3-S912-G3UP-HPNR deleted |
+-----------------------------------------------------------------+
*** List all analytics profiles to confirm deletion ***
amnesiac (config) # ssc analytics-profile list
+---------------------------------------+------------------------+
| ID | Tag |
+---------------------------------------+------------------------+
| Analytics-Profile-6IQG-F6UQ-8C11-7G8F | Audit + System |
| 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
show ssc analytics-profile, ssc analytics-profile create, ssc analytics-profile list, ssc analytics-profile update
ssc analytics-profile list
Lists all analytics profile resources. These resources are used for vTM analytics.
Syntax
ssc analytics-profile listExamples
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
show ssc analytics-profile, ssc analytics-profile create, ssc analytics-profile delete, ssc analytics-profile update
ssc analytics-profile update
Updates an analytics profile resource. This resource is used for vTM analytics.
Syntax
ssc analytics-profile update id profile-id [logs-to-export log-list] [tag value] [txn-export Boolean]Parameters
id profile-idSpecify a unique identifier for the analytics profile, either its tag or UUID.
logs-to-exportA comma-separated list of identifiers for log-export resources. By default, this list can include the following log-export resources:
- Audit Log
- Application Firewall
- Process Monitor
- Admin Server Access
- System - syslog
- Event Log
- Routing Software
- Data Plane Acceleration
- System - authentication log
For example: "Audit Log","Event Log","System - authentication log"
For details of these logs, see the Virtual Traffic Manager documentation.
tagThe customer-facing name for the analytics-profile resource. If this is not set, the tag is set to the UUID value for the resource.
txn-exportIf 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
*** 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-V613-KAI2-4N49-MTL6 | Audit + Event + System |
| Analytics-Profile-SXSR-UCDA-JJDS-1Q3K | Audit + Event |
| Analytics-Profile-CHM8-D0PC-58BW-I8GI | System |
+---------------------------------------+------------------------+
*** View properties for a specific analytics profile ***
amnesiac (config) # show ssc analytics-profile id Event
+---------------------------+---------------------------------------+
| Field | Value |
+---------------------------+---------------------------------------+
| tag | Event |
| enable_transaction_export | True |
| vtm_logs_to_export | Event Log |
| analytics_profile_id | Analytics-Profile-F5V3-S912-G3UP-HPNR |
+---------------------------+---------------------------------------+
*** Update properties for this analytics profile, and confirm change ***
amnesiac (config) # ssc analytics-profile update id Event txn-export false
+---------------------------+---------------------------------------+
| Field | Value |
+---------------------------+---------------------------------------+
| tag | Event |
| enable_transaction_export | False |
| vtm_logs_to_export | Event Log |
| analytics_profile_id | Analytics-Profile-F5V3-S912-G3UP-HPNR |
+---------------------------+---------------------------------------+Related Commands
show ssc analytics-profile, ssc analytics-profile create, ssc analytics-profile delete, ssc analytics-profile list
ssc app-template import
Import an application template (a .ZIP file) into Services Director.
Syntax
ssc app-template import template-url URLUsage Guidelines
The no ssc app-template command deletes an imported application template.
Parameters
URLURL of the application template.
Examples
*** view empty list of application templates ***
amnesiac (config) # ssc app-template list
+-----------------+
| Message |
+-----------------+
| No record found |
+-----------------+
*** import an application template ***
amnesiac (config) # ssc app-template import template-url http://example.com/example_filepath/example_filename.zip
+---------------------------------------+
| Imported |
+---------------------------------------+
| Imported "Http Service Template__1.0" |
+---------------------------------------+
*** confirm the addition of an application template ***
amnesiac (config) # ssc app-template list
+----------------------------+
| Templates |
+----------------------------+
| Http Service Template__1.0 |
+----------------------------+
*** delete specific application template ***
amnesiac (config) # no ssc app-template template-name "Http Service Template__1.0"
+---------------------------------------------+
| Deleted |
+---------------------------------------------+
| Template Http Service Template__1.0 deleted |
+---------------------------------------------+Related Commands
show ssc app-template , show ssc app-template-instance, ssc app-template list, ssc app-template-instance create, ssc app-template-instance list, ssc app-template-instance update
ssc app-template list
Lists all application template resources.
Syntax
ssc app-template listUsage Guidelines
The no ssc app-template command deletes an imported application template.
Examples
*** list application templates ***
amnesiac (config) # ssc app-template list
+----------------------------+
| Templates |
+----------------------------+
| Http Service Template__1.0 |
+----------------------------+
*** delete application template ***
amnesiac (config) # no ssc app-template template-name "Http Service Template__1.0"
+---------------------------------------------+
| Deleted |
+---------------------------------------------+
| Template Http Service Template__1.0 deleted |
+---------------------------------------------+Related Commands
show ssc app-template , show ssc app-template-instance, ssc app-template import, ssc app-template-instance create, ssc app-template-instance list, ssc app-template-instance update
ssc app-template-instance create
Instantiate a named application template instance, performing both of the following actions:
- Creates a template instance on Services Director.
- Applies the configuration of the template instance to the specified vTM cluster.
Syntax
ssc app-template-instance create template-instance-name instance-name template-name template-id
cluster-id cluster-id parameters parametersUsage Guidelines
The no ssc app-template-instance command deletes a template instance.
Parameters
instance-nameSpecify a new name for the application template instance.
template-idSpecify a unique identifier for the application template, either its tag or UUID.
cluster-idSpecify a unique identifier for the vTM cluster, either its tag or UUID.
parametersA list of all parameters for the selected application template.
To automatically populate the command line with parameters from the application template, press the Tab key after you have typed the parameters keyword. You can then update the command line as required before creating the template instance.
Examples
*** show empty instance parameter list ***
amnesiac (config) # ssc app-template-instance list
+-----------------+
| Message |
+-----------------+
| No record found |
+-----------------+
*** create a template instance ***
amnesiac (config) # ssc app-template-instance create
template-instance-name "TK-421"
template-name "Http Service Template__1.0"
cluster-id "Cluster-CRCF-9WDA-T1HE-Z5WS"
parameters '{"instance_name": "Service Name",
"pool_nodes": ["127.0.0.1:80",
"127.0.0.2:80"],
"public_port": 100}'
+----------------------------------------------------------------------------...
| Created
+----------------------------------------------------------------------------...
| data.vtm_pool_nodes_table_table.nodes[0]: Refreshing state...
| data.vtm_pool_nodes_table_table.nodes[1]: Refreshing state...
|
| vtm_pool.pool: Creating...
| auto_scaling_addnode_delaytime: "" => "0"
| auto_scaling_enabled: "" => "false"
| auto_scaling_external: "" => "true"
| auto_scaling_hysteresis: "" => "20"
.
. (system messages: vTM settings)
.
| web_cache_enabled: "" => "false"
| web_cache_error_page_time: "" => "30"
| web_cache_max_time: "" => "600"
| web_cache_refresh_time: "" => "2"
| vtm_virtual_server.virtual_server: Creation complete after 0s ...
|
| Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
|
+----------------------------------------------------------------------------...
*** show all template instances ***
amnesiac (config) # ssc app-template-instance list
+-------------------+
| Template Instance |
--------------------+
| TK-421 |
+-------------------+
*** delete a specific template instance ***
amnesiac (config) # no ssc app-template-instance template-instance-name Template-Instance-TJVG-671N-ZHOD-MUKP
+----------------+
| Deleted |
+----------------+
| TK-421 deleted |
+----------------+Related Commands
show ssc app-template , show ssc app-template-instance, ssc app-template import, ssc app-template list, ssc app-template-instance list, ssc app-template-instance update
ssc app-template-instance list
Lists all application template instance resources. Each template instance is identified by a name. If there is no name defined for the instance, the unique template instance identifier is used instead.
Syntax
ssc app-template-instance listUsage Guidelines
The no ssc app-template-instance command deletes a template instance.
Examples
amnesiac (config) # ssc app-template-instance list
+---------------------------------------+
| Template Instance |
+---------------------------------------+
| Template-Instance-LGBI-671N-ZHOD-T0TA |
+---------------------------------------+
amnesiac (config) # no ssc app-template-instance template-instance-name Template-Instance-LGBI-671N-ZHOD-T0TA
+-----------------------------------------------+
| Deleted |
+-----------------------------------------------+
| Template-Instance-LGBI-671N-ZHOD-T0TA deleted |
+-----------------------------------------------+Related Commands
show ssc app-template , show ssc app-template-instance, ssc app-template import, ssc app-template list, ssc app-template-instance create, ssc app-template-instance update
ssc app-template-instance update
Update an application template instance, and re-apply it to the vTM cluster.
You cannot update the selected vTM cluster using this command. Instead, you should create a new template instance, see ssc app-template-instance create.
Syntax
ssc app-template-instance update template-instance-name instance-name template-name
template-name parameters parametersParameters
instance-nameSpecify a new name for the application template instance.
template-nameSpecify a unique identifier for the application template, either its tag or UUID.
parametersA formatted list of all parameters for the selected application template.
To automatically populate the command line with parameters from the application template, press the Tab key after you have typed the parameters keyword. You can then update the command line as required before creating the template instance.
Examples
*** view template instance list ***
amnesiac (config) # ssc app-template-instance list
+---------------------------------------+
| Template Instance |
----------------------------------------+
| Template-Instance-TJVG-L0K8-90AO-MUKP |
+---------------------------------------+
*** view details for a specific template instance ***
amnesiac (config) # show ssc app-template-instance template-instance-name
Template-Instance-TJVG-L0K8-90AO-MUKP
+----------------------+---------------------------------------+
| Field | Value |
+----------------------+---------------------------------------+
| template_instance_id | Template-Instance-TJVG-L0K8-90AO-MUKP |
| tag | |
| cluster_id | Cluster-CRCF-9WDA-T1HE-Z5WS |
| result | None |
| children | None |
| parameters | { |
| | "instance_name": "Service Name", |
| | "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 |
+----------------------+---------------------------------------+
*** update the public port for the template instance ***
amnesiac (config) # ssc app-template-instance update
template-instance-name Template-Instance-TJVG-L0K8-90AO-MUKP
parameters '{
"instance_name": "Service Name",
"pool_nodes": ["127.0.0.1:80", "127.0.0.2:80"],
"public_port": 100}'
+----------------------------------------------------------------------------...
| Created
+----------------------------------------------------------------------------...
| data.vtm_pool_nodes_table_table.nodes[0]: Refreshing state...
| data.vtm_pool_nodes_table_table.nodes[1]: Refreshing state...
|
|
| vtm_pool.pool: Creating...
| auto_scaling_addnode_delaytime: "" => "0"
| auto_scaling_enabled: "" => "false"
.
. (system messages: vTM settings)
.
| web_cache_max_time: "" => "600"
| web_cache_refresh_time: "" => "2"
| vtm_virtual_server.virtual_server: Creation complete after 0s ...
|
| Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
|
+----------------------------------------------------------------------------...
*** confirm new public port setting ***
amnesiac (config) # show ssc app-template-instance template-instance-name
Template-Instance-TJVG-L0K8-90AO-MUKP
+----------------------+---------------------------------------+
| Field | Value |
+----------------------+---------------------------------------+
| template_instance_id | Template-Instance-TJVG-L0K8-90AO-MUKP |
| tag | |
| cluster_id | Cluster-CRCF-9WDA-T1HE-Z5WS |
| result | None |
| children | None |
| parameters | { |
| | "instance_name": "Service Name", |
| | "pool_nodes": [ |
| | "127.0.0.1:80", |
| | "127.0.0.2:80" ], |
| | "public_port": 100 |
| | } |
| pending_action | None |
| template_id | Http Service Template__1.0 |
+----------------------+---------------------------------------+Related Commands
show ssc app-template , show ssc app-template-instance, ssc app-template import, ssc app-template list, ssc app-template-instance create, ssc app-template-instance list
ssc backup sd-va config clear
Clears the backup service configuration for the Services Director. The configuration of the remote system is unaffected.
Syntax
ssc backup sd-va config clearExamples
amnesiac (config) # ssc backup sd-va config clear
amnesiac (config) # ssc backup sd-va service status
Backup service is not configured
+------------------------------+-------------------------+- ...
| Config | Status | ...
+------------------------------+-------------------------+ ...
| Backup Configuration | Configuration failed | ...
| Restore Remote Configuration | Successfully configured | ...
+------------------------------+-------------------------+ ...
... -----------------------------------------+
... Message |
... -----------------------------------------+
... Services Director is not configured yet |
... None |
... -----------------------------------------+Related Commands
show ssc backup sd-va config, ssc backup sd-va config create, ssc backup sd-va config update, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va config create
Creates a backup service configuration for the Services Director. Files are backed up to a local location according to a defined backup frequency. These are then synchronized to a remote location using a separate frequency. After synchronizing, a specified number of local files are retained.
Syntax
ssc backup sd-va config create remote-sys IP-address remote-sys-path path remote-sys-user user remote-sys-pass password backup-data-trans protocol backup-freq frequency backup-retain number remote-sync-freq frequencyParameters
remote-sys profile-idIP address of the remote system.
remote-sys-path pathRemote directory for backup files. For example, "/var/home/root".
remote-sys-user userRemote username.
remote-sys-pass passwordPassword for the remote user.
backup-data-trans protocolThe protocol to perform the remote transfer ("scp" or "ftp"). 2
backup-freq frequencyThe 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.
backup-retain numberThe number of local backup files to be retained. For example, 3.
remote-sync-freq frequencyThe 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.
Examples
amnesiac (config) # ssc backup sd-va config create remote-sys 10.62.166.206 remote-sys-path /space/sd-backup/sd-backup-test/gold-silver-backups remote-sys-user sd-backup remote-sys-pass password backup-data-trans scp backup-freq 1m backup-retain 10 remote-sync-freq 5m
Succesfully configured backup configuration for Services Director.
Backup restore remote configuration will be created with the same parameters
+-------------------+-----------------------------------------------------+
| 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
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config update, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va config update
Updates the backup service configuration for the Services Director.
Syntax
ssc backup sd-va config update [remote-sys IP-address] | [remote-sys-path path] | [remote-sys-user user] | [remote-sys-pass password] | [backup-data-trans protocol] | [backup-freq frequency] | [backup-retain number] | [remote-sync-freq frequency]Parameters
remote-sysIP address of the remote system.
remote-sys-pathRemote directory for backup files. For example, "/var/home/root".
remote-sys-userRemote username.
remote-sys-passPassword for the remote user.
backup-data-transThe protocol to perform the transfer to the remote system ("scp" or "ftp"). 2
backup-freqThe 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.
backup-retainThe number of local backup files to be retained. For example, 3.
remote-sync-freqThe 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.
Examples
amnesiac (config) # ssc backup sd-va config update backup-freq 2m
+-------------------+-----------------------------------------------------+
| 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 | 2m |
| remote-sys-pass | ****** |
+-------------------+-----------------------------------------------------+Related Commands
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va restore local
Restores the Services Director using a local backup file (created by the Services Director backup service).
Syntax
ssc backup sd-va restore local backup-name filename master-password passwordParameters
backup-name filenameSpecify a backup file from the local backup configuration.
master-password passwordSpecify the master password that was current when the backup was made.
Usage Guidelines
The response from the restore process lists any vTM image files that were referenced in the backup file. These images are not stored with the backup, so you must ensure that they are reloaded if they are no longer present on your system.
Examples
amnesiac (config) # ssc backup sd-va restore local backup-name
backup_10.62.167.199_2015-09-08_18-42-01.zip master-password Bcd4531-22
Warning: Using a password on the command line interface can be insecure.
Services Director configuration successfully restored using backup file
backup_10.62.167.199_2015-09-08_18-42-01.zip
Please restore following vTM images existing in the previous backup file:
ZeusTM_101_Linux-x86_64.tgzRelated Commands
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va restore remote
Restores the Services Director from a remote backup file.
Syntax
ssc backup sd-va restore remote backup-name filename master-password passwordParameters
backup-name filenameA backup file from the remote backup configuration.
master-password passwordSpecify the master password that was current when the backup was made.
Usage Guidelines
The response from the restore process lists any vTM image files that were referenced in the backup file. These images are not stored with the backup, so you must ensure that they are reloaded if they are no longer present on your system.
Examples
amnesiac (config) # ssc backup sd-va restore remote backup-name
backup_10.62.167.199_2015-12-12_06-06-02.zip master-password Bcd4531-22
Warning: Using a password on the command line interface can be insecure.
Services Director configuration successfully restored using backup file
backup_10.62.167.199_2015-12-12_06-06-02.zip
Please restore following vTM images existing in the previous backup file:
ZeusTM_101_Linux-x86_64.tgzRelated Commands
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore local, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va restore remotecfg clear
Clears the remote system definition that is used to restore a Services Director.
Syntax
ssc backup sd-va restore remotecfg clearExamples
*** list current remote config ***
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 |
+-------------------+-----------------------------------------------------+
*** clear current config ***
amnesiac (config) # ssc backup sd-va restore remotecfg clear
*** confirm config is clear ***
amnesiac (config) # show ssc backup sd-va restore remotecfg
+-----------------+
| Message |
+-----------------+
| No record found |
+-----------------+Related Commands
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va restore remotecfg create
Specifies the remote system from which a restore of the Services Director is performed.
Syntax
ssc backup sd-va restore remotecfg create remote-sys IP-address remote-sys-path path remote-sys-user user remote-sys-pass password backup-data-trans protocolParameters
remote-sysIP address of the remote system.
remote-sys-pathRemote directory for backup files. For example, "/var/home/root".
remote-sys-userRemote username.
remote-sys-passPassword for the remote user.
backup-data-transThe protocol to perform the transfer from the remote system ("scp" or "ftp").
Usage Guidelines
The restore process itself is performed using ssc backup sd-va restore remotecfg clear.
Examples
amnesiac (config) # ssc backup sd-va restore remotecfg create remote-sys 10.62.166.206 remote-sys-path /space/sd-backup/sd-backup-test/gold-silver-backups remote-sys-user sd-backup remote-sys-pass password backup-data-trans scp
Successfully created backup restore remote configuration for Services Director
+-------------------+-----------------------------------------------------+
| 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
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va restore remotecfg update
Updates the remote system configuration from which a restore of the Services Director is performed.
Syntax
ssc backup sd-va restore remotecfg create [remote-sys IP-address] | [remote-sys-path path] | [remote-sys-user user] | [remote-sys-pass password] | [backup-data-trans protocol]Parameters
remote-sysIP address of the remote system.
remote-sys-pathRemote directory for backup files. For example, "/var/home/root".
remote-sys-userRemote username.
remote-sys-passPassword for the remote user.
backup-data-transThe protocol to perform the transfer from the remote system ("scp" or "ftp").
Usage Guidelines
The restore process itself is performed using ssc backup sd-va restore remotecfg clear.
Examples
amnesiac (config) # ssc backup sd-va restore remotecfg update backup-data-trans ftp
+-------------------+-----------------------------------------------------+
| Field | Value |
+-------------------+-----------------------------------------------------+
| remote-sys-user | sd-backup |
| backup-data-trans | ftp |
| remote-sys-path | /space/sd-backup/sd-backup-test/gold-silver-backups |
| remote-sys-pass | ****** |
| remote-sys | 10.62.166.206 |
+-------------------+-----------------------------------------------------+Related Commands
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va service status, ssc backup sd-va service enable
ssc backup sd-va service enable
Enables the backup service for the Services Director.
Syntax
ssc backup sd-va service enableUsage Guidelines
Use the no ssc backup sd-va service command to disable the backup service.
Examples
*** enable backup service ***
amnesiac (config) # ssc backup sd-va service enable
Backup service is enabled
*** disable backup service ***
amnesiac (config) # no ssc backup sd-va service
Backup service is disabledRelated Commands
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service status
ssc backup sd-va service status
Displays the status of the backup service for the Services Director.
Syntax
ssc backup sd-va service statusExamples
amnesiac (config) # ssc backup sd-va service status
Backup service is configured and running
+------------------------------+-------------------------+---------+
| Config | Status | Message |
+------------------------------+-------------------------+---------+
| Backup Configuration | Successfully configured | None |
| Restore Remote Configuration | Successfully configured | None |
+------------------------------+-------------------------+---------+Related Commands
show ssc backup sd-va config, ssc backup sd-va config clear, ssc backup sd-va config create, ssc backup sd-va restore local, ssc backup sd-va restore remote, ssc backup sd-va restore remotecfg clear, ssc backup sd-va restore remotecfg create, ssc backup sd-va restore remotecfg update, ssc backup sd-va service enable
ssc backup vtm-cluster cluster-name backup now
Performs an immediate backup for the specified cluster.
Syntax
ssc backup vtm-cluster cluster-name cluster-id backup nowParameters
cluster-idSpecify the name of the required cluster.
Usage Guidelines
The cluster must have a defined backup schedule for this command to succeed.
When this command is used, a task is created to perform the backup.
Use the show ssc backup vtm-cluster cluster-name <cluster-name> task <task-id> command to check the status of the backup task.
Examples
amnesiac (config) # ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backup now
Please check the status of the current task using "show ssc backup vtm-cluster cluster-name <cluster-name> task <task-id>"
+---------------+---------------------------------------+
| Task | Details |
+---------------+---------------------------------------+
| status | pending |
| backup_id | |
| creation_date | 2016-06-29 15:11:31.036461 |
| 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-CY7G-X5AB-G0SK-NX5L |
| instance_id | |
| cluster_tag | |
+---------------+---------------------------------------+Related Commands
ssc backup vtm-cluster cluster-name restore backup-name
For a specified cluster, restores an existing backup from that cluster.
Syntax
ssc backup vtm-cluster cluster-name source_cluster-id restore backup-name backup_id target-cluster target_cluster_idParameters
source_cluster-idSpecify the name of the cluster from which the backup was taken.
backup_idSpecify the name of the required backup.
target_cluster-idSpecify the name of the cluster upon which the backup will be used.
Usage Guidelines
When this command is used, a task is created to perform the restore.
Use the show ssc backup vtm-cluster cluster-name <cluster-name> task <task-id> command to check the status of the restore task.
Examples
amnesiac (config) # ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O backup now
Please check the status of the current task using "show ssc backup vtm-cluster cluster-name <cluster-name> task <task-id>"
+---------------+---------------------------------------+
| Task | Details |
+---------------+---------------------------------------+
| status | pending |
| backup_id | |
| creation_date | 2016-06-29 15:11:31.036461 |
| 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-CY7G-X5AB-G0SK-NX5L |
| instance_id | |
| cluster_tag | |
+---------------+---------------------------------------+Related Commands
ssc backup vtm-cluster cluster-name task retry
Re-attempt a failed backup task.
Syntax
ssc backup vtm-cluster cluster-name cluster-id task task_id retryParameters
cluster-idSpecify the name of the cluster upon which the failed task was performed.
task_idSpecify the name of the failed task.
Usage Guidelines
Use the show ssc backup vtm-cluster cluster-name <cluster-name> task <task-id> command to check the progress of the task.
Use the no ssc backup vtm-cluster cluster-name <cluster_id> task <task_id> command to delete a failed task if required.
Examples
*** check task: failed ***
amnesiac (config) # show ssc backup vtm-cluster cluster-name
Cluster-AQJE-R4HV-QYR1-9F4O task BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI
+---------------+---------------------------------------------------------------
| Field | Value
+---------------+---------------------------------------------------------------
| status | failed
| backup_id |
| creation_date | 2016-06-29 16:48:46
| task_subtype | backup now
| manager | 10.62.169.160
| cluster_id | Cluster-AQJE-R4HV-QYR1-9F4O
| error_info | Could not select a vTM for backup for cluster Cluster-AQJE-...
| task_type | backup restore
| task_id | BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI
| instance_id |
| cluster_tag |
+---------------+---------------------------------------------------------------
*** retry after bringing REST API back up ***
amnesiac (config) # ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-
QYR1-9F4O task BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI retry
+---------------+---------------------------------------+
| Field | Value |
+---------------+---------------------------------------+
| status | pending |
| backup_id | |
| creation_date | 2016-06-29 16:48:46 |
| 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-PQ6B-H5PY-JHVM-ZTYI |
| instance_id | |
| cluster_tag | |
+---------------+---------------------------------------+
*** check task: successful ***
amnesiac (config) # show ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O task BackupRestoreTask-PQ6B-H5PY-JHVM-ZTYI
+---------------+---------------------------------------+
| Field | Value |
+---------------+---------------------------------------+
| status | complete |
| backup_id | |
| creation_date | 2016-06-29 16:48:46 |
| 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-PQ6B-H5PY-JHVM-ZTYI |
| instance_id | |
| cluster_tag | |
+---------------+---------------------------------------+Related Commands
ssc backup vtm-cluster cluster-name upload backup-name
Transfers a backup file (in TAR format) to a specified Traffic Manager instance. This file is not used in any way.
Syntax
ssc backup vtm-cluster cluster-name source_cluster-id upload backup-name backup_id target-cluster target_cluster_id target-vTM instance_idParameters
source_cluster-idSpecify the name of the cluster from which the backup was taken.
backup_idSpecify the name of the required backup.
target_cluster-idSpecify the name of the cluster upon which the backup will be used.
instance_idSpecify the name of the Traffic Manager instance to which the backup file (in TAR format) will be loaded.
Usage Guidelines
This command only transfers the TAR file to the specified Traffic Manager instance. note: No operations are performed on this backup file when it reaches the specified Traffic Manager instance.
When this command is used, a task is created to perform the restore.
Use the show ssc backup vtm-cluster cluster-name <cluster-name> task <task-id> command to check the status of the restore task.
Examples
amnesiac (config) # ssc backup vtm-cluster cluster-name Cluster-AQJE-R4HV-QYR1-9F4O upload backup-name Backup-STD3-X1Q4-GTJ3-WX4T target-cluster Cluster-P2WL-IV2B-V8S6-COIY target-instance cerise-01
Please check the status of the current task using "show ssc backup vtm-cluster cluster-name <cluster-name> task <task-id>"
+---------------+---------------------------------------+
| Task | Details |
+---------------+---------------------------------------+
| status | pending |
| backup_id | Backup-STD3-X1Q4-GTJ3-WX4T |
| creation_date | 2016-06-29 15:24:07.015535 |
| task_subtype | upload |
| manager | 10.62.169.160 |
| cluster_id | Cluster-P2WL-IV2B-V8S6-COIY |
| error_info | None |
| task_type | backup restore |
| task_id | BackupRestoreTask-DBGB-SI8U-TMM7-KPUE |
| instance_id | Instance-2YEE-CLUF-NEA8-NWWB |
| cluster_tag | |
+---------------+---------------------------------------+Related Commands
ssc backup vtm-cluster create schedule
Creates a backup schedule.
Syntax
ssc backup vtm-cluster create schedule schedule_id frequency frequency [offset offset] [backup_time time] [info description]Parameters
schedule_idSpecify a unique name for the required backup schedule.
frequency frequencySpecify the basic frequency of the backup.
- daily: A daily frequency. This requires a backup_time but not an offset.
- hourly: An hourly frequency. This requires an offset but not a backup_time.
- monthly: A monthly frequency. This requires both an offset and a backup_time.
- weekly: A weekly frequency. This requires both an offset and a backup_time.
- user_defined: A customized frequency. This requires an offset but not a backup_time.
backup_time timeSpecify the backup time (HH:MM) for the schedule. This is supported for daily, weekly and monthly schedules only.
offsetSpecify an offset for the selected frequency type, which more closely specifies the point at which the backup will be taken:
- For daily schedules, no offset is supported.
- For an hourly schedule, the offsets represent every quarter of an hour, expressed as minutes. That is: 0, 15, 30 and 45.
- For monthly schedules, the offset is the day number on which the backup should be taken. This is limited to between 1 and 28.
- For weekly schedules, the offset is the day of the week on which the backup should be taken. That is: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. These offset values are displayed as the numbers 0 to 6 when the details for a schedule are displayed.
- For user defined schedules, various offsets are available: 15min, hour, 12hour, week, month.
info descriptionOptionally, specify a description for the schedule.
Usage Guidelines
Use the no ssc backup vtm-cluster create schedule <schedule_id> command to delete a specified schedule. You cannot delete a schedule that is in use.
Once the schedule is created, you can associate it with one or more clusters using the ssc cluster create cluster-name <cluster_id> schedule <schedule_id> command.
Examples
*** create a daily backup schedule ***
amnesiac (config) # ssc backup vtm-cluster create schedule sched-daily-01 frequency daily backup_time 10:10 info "Daily backup schedule"
+-------------+------------------------------------+
| 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 |
+-------------+------------------------------------+
*** create an hourly backup schedule ***
amnesiac (config) # ssc backup vtm-cluster create schedule sched-hourly-01 frequency hourly offset 30 info "Hourly backup schedule"
+-------------+------------------------------------+
| Field | Value |
+-------------+------------------------------------+
| info | Hourly backup schedule |
| schedule_id | BackupSchedule-60V4-PWWB-I6M7-OMVA |
| tag | sched-hourly-01 |
| frequency | hourly |
| backup_time | N/A |
| offset | 30 |
+-------------+------------------------------------+
*** create a monthly backup schedule ***
amnesiac (config) # ssc backup vtm-cluster create schedule sched-monthly-01 frequency monthly offset 11 backup_time 11:30 info "Monthly (11th) backup schedule"
+-------------+------------------------------------+
| Field | Value |
+-------------+------------------------------------+
| info | Monthly (11th) backup schedule |
| schedule_id | BackupSchedule-F7AP-X5GP-Y974-WWF7 |
| tag | sched-monthly-01 |
| frequency | monthly |
| backup_time | 11:30 |
| offset | 11 |
+-------------+------------------------------------+
*** create a weekly backup schedule ***
amnesiac (config) # ssc backup vtm-cluster create schedule sched-weekly-01 frequency weekly offset Wednesday backup_time 17:50 info "Weekly backup schedule"
+-------------+------------------------------------+
| Field | Value |
+-------------+------------------------------------+
| info | Weekly backup schedule |
| schedule_id | BackupSchedule-LOUK-W5ZF-IAHR-M8KM |
| tag | sched-weekly-01 |
| frequency | weekly |
| backup_time | 17:50 |
| offset | 2 |
+-------------+------------------------------------+
*** create a custom backup schedule ***
amnesiac (config) # ssc backup vtm-cluster create schedule sched-user-01 frequency user_defined offset 12hour info "12-hourly backup schedule"
+-------------+------------------------------------+
| Field | Value |
+-------------+------------------------------------+
| info | 12-hourly backup schedule |
| schedule_id | BackupSchedule-PSYD-B5VS-1RY6-2TLA |
| tag | sched-user-01 |
| frequency | userdefined |
| backup_time | 14:16 |
| offset | 720 |
+-------------+------------------------------------+
*** delete a schedule: successful ***
amnesiac (config) # no ssc backup vtm-cluster schedule sched-monthly-02
Schedule deleted sucessfully
*** delete a schedule: unsuccessful, as already in use ***
amnesiac (config) # no ssc backup vtm-cluster schedule sched-daily-01
Failed to delete schedule (Cannot purge a resource that is in use)Related Commands
show ssc backup vtm-cluster schedules, ssc backup vtm-cluster update schedule, ssc cluster update cluster-name
ssc backup vtm-cluster update schedule
Updates a backup schedule.
Syntax
ssc backup vtm-cluster update schedule schedule_id [new_name new_schedule_id] [frequency frequency] [offset offset] [backup_time time] [info description]Parameters
schedule_idSpecify the required backup schedule.
new_name new_schedule_idOptionally, specify a new name for the schedule. This is supported for all schedules.
frequency frequencyOptionally, specify a new frequency for the backup.
- daily: A daily frequency. This requires a backup_time but not an offset.
- hourly: An hourly frequency. This requires an offset but not a backup_time.
- monthly: A monthly frequency. This requires both an offset and a backup_time.
- weekly: A weekly frequency. This requires both an offset and a backup_time.
- user_defined: A customized frequency. This requires an offset but not a backup_time.
backup_time timeOptionally, specify a new backup time (HH:MM) for the schedule. This is supported for daily, weekly and monthly schedules only.
offsetOptionally, specify a new offset for the selected frequency type, which more closely specifies the point at which the backup will be taken:
- For daily schedules, no offset is supported.
- For an hourly schedule, the offsets represent every quarter of an hour, expressed as minutes. That is: 0, 15, 30 and 45.
- For monthly schedules, the offset is the day number on which the backup should be taken. This is limited to between 1 and 28.
- For weekly schedules, the offset is the day of the week on which the backup should be taken. That is: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. These offset values are displayed as the numbers 0 to 6 when the details for a schedule are displayed.
- For user defined schedules, various offsets are available: 15min, hour, 12hour, week, month.
info descriptionOptionally, specify a new description for the schedule.
Usage Guidelines
Use the no ssc backup vtm-cluster create schedule <schedule_id> command to delete a specified schedule. You cannot delete a schedule that is in use.
You can associate a schedule with one or more clusters using the ssc cluster create cluster-name <cluster_id> schedule <schedule_id> command.
Examples
ssc backup vtm-cluster update schedule sched-weekly-01 offset Wednesday backup_time 12:20
+-------------+------------------------------------+
| Field | Value |
+-------------+------------------------------------+
| info | Weekly backup schedule |
| schedule_id | BackupSchedule-LOUK-W5ZF-IAHR-M8KM |
| tag | sched-weekly-01 |
| frequency | weekly |
| backup_time | 12:20 |
| offset | 2 |
+-------------+------------------------------------+Related Commands
show ssc backup vtm-cluster schedules, ssc backup vtm-cluster update schedule, ssc cluster update cluster-name
ssh client generate identity user
Generates SSH client identity keys for the specified user. SSH provides secure log in for Windows and UNIX clients and servers.
Syntax
ssh client generate identity user userParameters
userSpecify the client user login.
Usage Guidelines
The no ssh client identity user <user> command disables SSH client identity keys for a specified user.
Examples
amnesiac (config) # ssh client generate identity user testRelated Commands
ssh client user authorized-key key sshv2
Sets the RSA encryption method by RSA Security and authorized-key for the SSH user.
Syntax
[no] ssh client user user authorized-key key sshv2 public-keyParameters
userSpecify the user name. Must be an existing local user.
public-keySpecify the public key for SSH version 2 for the specified SSH user.
Usage Guidelines
The no command option disables the authorized-key encryption method.
Examples
amnesiac (config) # ssh client user admin authorized-key key sshv2 MyPublicKeyRelated Commands
ssc cloud-reg create
Creates a cloud registration resource on the Services Director. This is required during automated self-registration of vTMs.
Syntax
ssc cloud-reg create reg-policy registration-policy [e-mail email-address] [owner owner] [[tag name]Parameters
reg-policy registration-policySelect a self-registration policy for the cloud registration resource. This is the self-registration policy that will be used during the evaluation of a cloud-based vTM's self-registration.
e-mail email-addressOptionally, specify a valid e-mail address that will be used to contact an administrator if required.
ownerSpecify an owner for the cloud registration resource. This property is optional when the resource is created, but there is a mandatory validation of this property during the evaluation of a cloud-based vTM's self-registration.
tagOptionally, enter a unique name for the cloud registration resource.
Usage Guidelines
Once you have created the cloud registration resource, you must use the show ssc cloud-reg user-data command to display the user data for the cloud registration resource. This text is required during the AWS instance creation wizard for the first cloud-based vTM in a cluster. See the Services Director Getting Started Guide for full details of this process.
You cannot update a cloud registration resource once it is created.
Examples
*** list cloud registration resources ***
amnesiac (config) # ssc cloud-reg list
+-----------------+
| Message |
+-----------------+
| No record found |
+-----------------+
*** create a new cloud registration ***
amnesiac (config) # ssc cloud-reg create reg-policy self-reg-01 owner JK tag jk-cloud-reg-01
+---------------------+------------------------------+
| Field | Value |
+---------------------+------------------------------+
| tag | jk-cloud-reg-01 |
| owner | Owner-S5HZ-52G9-HZS2-KIAO |
| email_address | |
| registration_policy | Policy-SH1M-L5BD-5L9L-YFKK |
| date_created | 2016-09-07 13:34:32.404407 |
| user_data_id | UserData-Z28S-AXW9-PAVA-3YE3 |
+---------------------+------------------------------+
*** list cloud registration resources again ***
amnesiac (config) # ssc cloud-reg list
+------------------------------+-----------------+
| ID | Tag |
+------------------------------+-----------------+
| UserData-Z28S-AXW9-PAVA-3YE3 | jk-cloud-reg-01 |
+------------------------------+-----------------+Related Commands
ssc cloud-reg delete
Deletes a cloud registration resource on the Services Director.
Syntax
ssc cloud-reg delete id cloud-reg-idParameters
id cloud-reg-idSelect a cloud-registration resource that you want to delete.
Examples
*** list all cloud registration resources ***
amnesiac (config) # ssc cloud-reg list
+------------------------------+-------------------+
| ID | Tag |
+------------------------------+-------------------+
| UserData-ORI9-YXGU-37VY-3OPQ | jk-cloud-reg-01 |
| UserData-NVF1-TLGP-R7EY-RUUY | cloud-reg-demo-01 |
+------------------------------+-------------------+
*** delete a cloud registration resource ***
amnesiac (config) # ssc cloud-reg delete id jk-cloud-reg-01
+---------------------------------------------------------+
| Deleted |
+---------------------------------------------------------+
| Cloud Registration UserData-ORI9-YXGU-37VY-3OPQ deleted |
+---------------------------------------------------------+
*** list all cloud registration resources again ***
amnesiac (config) # ssc cloud-reg list
+------------------------------+-------------------+
| ID | Tag |
+------------------------------+-------------------+
| UserData-NVF1-TLGP-R7EY-RUUY | cloud-reg-demo-01 |
+------------------------------+-------------------+Related Commands
ssc cloud-reg list
Displays a list of cloud registration resources on the Services Director.
Syntax
ssc cloud-reg listExamples
amnesiac (config) # ssc cloud-reg list
+------------------------------+-------------------+
| ID | Tag |
+------------------------------+-------------------+
| UserData-ORI9-YXGU-37VY-3OPQ | jk-cloud-reg-01 |
| UserData-NVF1-TLGP-R7EY-RUUY | cloud-reg-demo-01 |
+------------------------------+-------------------+Related Commands
show ssc cloud-reg, show ssc cloud-reg user-data id, ssc cloud-reg create, ssc cloud-reg delete
ssc cluster create cluster-name
Creates a User Created Services Director cluster.
Syntax
[no] ssc cluster create cluster-name name [schedule schedule_id] [owner cluster-owner] [analytics-profile profile-id]Parameters
nameSpecify a unique name for the cluster.
schedule schedule_idOptionally, specify an existing backup schedule for the cluster.
owner ownerOptionally, specify an owner for the cluster.
analytics-profile profile-idOptionally, specify an analytics profile for the cluster.
Usage Guidelines
This cluster is available for use by deployed vTMs only.
You cannot create a Discovered cluster using the CLI.
To delete an empty cluster, use the no ssc cluster cluster-name command.
Examples
amnesiac (config) # ssc cluster create cluster-name JK-Cluster-01 schedule sched-user-01
+----------------------+------------------------------------+
| Field | Value |
+----------------------+------------------------------------+
| status | Active |
| next_backup_time | 2017-07-17 02:00:00 |
| share_tips | True |
| cluster_port_offset | None |
| in_use | False |
| cluster_type | User Created |
| user_data | None |
| task | None |
| number_backups | 5 |
| schedule_id | BackupSchedule-L1X2-UPEN-9O7Q-3X2I |
| tag | JK-Cluster-01 |
| members | [] |
| owner | |
| children | None |
| analytics_profile_id | None |
+----------------------+------------------------------------+Related Commands
show ssc cluster cluster-name, show ssc backup vtm-cluster schedules, ssc cluster list, ssc cluster update cluster-name
ssc cluster create template-name
Creates a User Created Services Director cluster based on a specified template.
Syntax
ssc cluster create template-name name [cluster-name cluster-id] [owner owner-id] [schedule schedule-id]Parameters
template-name nameIdentify the template you want to use.
cluster-name cluster-id(Optional) Specify a cluster name. This will be used in preference to any template value.
owner owner-id(Optional) Specify an owner for the cluster. This will be used in preference to any template value.
schedule schedule-id(Optional) Specify a backup schedule for the cluster. This will be used in preference to any template value.
Usage Guidelines
Create clusters using parameters 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 create the command. You have the option to replace or add extra parameters that exist in the specified template (that is, add extra arguments).
This cluster is available for use by deployed vTMs only.
You cannot create a Discovered cluster using the CLI.
Examples
amnesiac (config) # ssc cluster create template-name cluster-temp cluster-name Example2
+----------------------+--------------+
| Field | Value |
+----------------------+--------------+
| status | Active |
| next_backup_time | None |
| share_tips | True |
| cluster_port_offset | None |
| in_use | False |
| cluster_type | User Created |
| user_data | None |
| task | None |
| number_backups | 5 |
| schedule_id | None |
| tag | Example2 |
| members | [] |
| owner | |
| children | None |
| analytics_profile_id | None |
+----------------------+--------------+Related Commands
show ssc cluster cluster-name, show ssc backup vtm-cluster schedules, ssc cluster update template-name
ssc cluster list
Lists current clusters. This includes both Discovered and User Created clusters.
Syntax
ssc cluster listExamples
amnesiac (config) # ssc cluster list
+-----------------------------+
| Cluster |
+-----------------------------+
| TK-327 |
| Violet-Cluster |
| TK-421 |
| Cluster-A1BQ-V577-V8NY-UIDZ |
+-----------------------------+Related Commands
show ssc cluster cluster-name, show ssc backup vtm-cluster schedules, ssc cluster create cluster-name, ssc cluster update cluster-name
ssc cluster update cluster-name
Updates a Services Director cluster.
Syntax
ssc cluster update cluster-name name [schedule schedule_id] [new-cluster-name name] [status [Active | Inactive]]Parameters
nameSpecify the cluster name.
new-cluster-nameSpecify a new tag for the cluster.
scheduleSpecify a backup schedule for the cluster.
status [Active | Inactive]Specify the status of the cluster:
- Active: Activates the cluster.
- Inactive: Deactivates the cluster. A cluster cannot be marked as Inactive if it is in use. A cluster cannot be reactivated after Inactive status has been specified.
analytics-profile(Discovered clusters only) Specify an analytics profile for the cluster, using its tag or UUID. See also Usage Guidelines.
Usage Guidelines
Use the ssc cluster update cluster-name <cluster_id> schedule null command to detach delete the specified schedule.
Adding an analytics profile to a cluster will enable analytics on all vTMs in the cluster, providing that all required resources (analytics profiles, collection endpoints, search endpoints, and log-export resources) are defined. See the Services Director Getting Started Guide for full details of this process.
Updating the selected analytics profile for a cluster will change the analytics configuration of all vTMs in the cluster.
Examples
*** list all clusters ***
amnesiac (config) # ssc cluster list
+-----------+
| Cluster |
+-----------+
| Vermilion |
| Cerulean |
| Emerald |
+-----------+
*** show properties for a specific cluster ***
amnesiac (config) # 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 |
+----------------------+-----------------------------------+
*** update the cluster ***
amnesiac (config) # ssc cluster update cluster-name Cerulean new-cluster-name Cerulean-Cluster
+----------------------+-----------------------------------+
| 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-Cluster |
| members | [u'Instance-92Y7-JVCE-00TW-UY1N'] |
| owner | Owner-F4MQ-6X5X-S07W-B0RI |
| children | None |
| analytics_profile_id | None |
+----------------------+-----------------------------------+
*** list all clusters ***
amnesiac (config) # ssc cluster list
+------------------+
| Cluster |
+------------------+
| Vermilion |
| Cerulean-Cluster |
| Emerald |
+------------------+Related Commands
show ssc cluster cluster-name, show ssc backup vtm-cluster schedules, ssc backup vtm-cluster create schedule
ssc cluster update template-name
Updates a Services Director cluster based on the specified template.
Syntax
ssc cluster update template-name template-name [new-cluster-name name] [schedule backup-schedule-id] [analytics-profile profile-id]Parameters
template-nameSpecify the template you want to use.
new-cluster-nameSpecify a new tag for the cluster. This will be used in preference to any template value.
scheduleSpecify a backup schedule for the cluster. This will be used in preference to any template value.
analytics-profile(Discovered clusters only) Specify an analytics profile for the cluster, using its tag or UUID. This will be used in preference to any template value. See also Usage Guidelines.
Usage Guidelines
Update a cluster 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).
Adding an analytics profile to a cluster will enable analytics on all vTMs in the cluster, providing that all required resources (analytics profiles, collection endpoints, search endpoints, and log-export resources) are defined. See the Services Director Getting Started Guide for full details of this process.
Updating the selected analytics profile for a cluster will change the analytics configuration of all vTMs in the cluster.
Examples
amnesiac (config) # ssc cluster update template-name cluster-temp cluster-name Cerulean-Cluster schedule sched-user-01
+----------------------+------------------------------------+
| Field | Value |
+----------------------+------------------------------------+
| status | Active |
| next_backup_time | 2017-07-17 02:00:00 |
| share_tips | True |
| cluster_port_offset | None |
| in_use | True |
| cluster_type | Discovered |
| user_data | None |
| task | None |
| number_backups | 5 |
| schedule_id | BackupSchedule-L1X2-UPEN-9O7Q-3X2I |
| tag | Cerulean-Cluster |
| members | [u'Instance-92Y7-JVCE-00TW-UY1N'] |
| owner | Owner-F4MQ-6X5X-S07W-B0RI |
| children | None |
| analytics_profile_id | None |
+----------------------+------------------------------------+Related Commands
ssc collection-endpoint create
Creates a new Collection Endpoint resource. This resource is used for vTM analytics.
Syntax
ssc collection-endpoint create txn-export-address address txn-tls Boolean log-export-address address auth-type value [auth-username username auth-password password] [auth-token HEC-token] [txn-tls-verify Boolean] [txn-export-cert Certificate] [log-export-cert Certificate] [name value]Parameters
txn-export-addressThe address that transaction data is exported to, in the form <server>:<port>.
For example: demo.com:7090
txn-tlsIndicates whether transaction data requires secure transmission. If true, you must also specify txn-export-cert, and you can optionally specify txn-tls-verify.
log-export-addressThe address that log data is exported to, in the form <protocol><server>:<port><filepath>, where <protocol> can be either http:// or https://.
For example: http://demo.com:8080/logs/collector.
If protocol is set to https://, you must also specify log-export-cert.
auth-type valueThe required authorization. This can be set to:
- "None": This indicates no authorization is required.
- "Basic": This indicates that basic HTTP authorization is required. You must also specify auth-username and auth-password.
- "Splunk": This indicates that authorization is performed on the Splunk®1platform. You must also specify auth-token.
auth-usernameThe username for HTTP Basic authentication. This is required when auth-type is Basic.
auth-passwordThe password for HTTP Basic authentication. This is required when auth-type is Basic.
auth-tokenThe HEC authorization token required by the Splunk platform. This is required when auth-type is "Splunk".
txn-tls-verify(Optional) If true, indicates that verification of the secure connection to the transaction collection endpoint is required.
log-tls-verify(Optional) If true, indicates that verification of the secure connection to the log collection endpoint is required.
txn-export-certThe certificate of the transaction export collection endpoint. This is required if txn-tls is true.
log-export-certThe certificate of the log export collection endpoint. This is required if the <protocol> in log-export-address is https://.
name(Optional) The customer-facing name for the collection endpoint resource. If this is not set, the tag is set to the UUID value for the resource.
Usage Guidelines
This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command.
Examples
*** add a collection endpoint resource that uses no authorization ***
amnesiac (config) # ssc collection-endpoint create txn-export-address demo.com:7090 txn-tls true log-export-address http://demo.com:8080/logs/collector auth-type none log-tls-verify false name JK-Collection-03
+----------------------------------+-----------------------------------------+
| Field | Value |
+----------------------------------+-----------------------------------------+
| transaction_tls_verify | False |
| auth_type | none |
| transaction_export_address | demo.com:7090 |
| log_export_address | http://demo.com:8080/logs/collector |
| auth_token | |
| collection_endpoint_id | Collection-Endpoint-U3FX-MTKU-WSY6-WZ99 |
| transaction_endpoint_certificate | |
| transaction_export_tls | True |
| log_endpoint_certificate | |
| tag | JK-Collection-03 |
| log_tls_verify | False |
| auth_password | |
| auth_username | |
+----------------------------------+-----------------------------------------+
*** add a collection endpoint resource that uses HTTP-based authorization ***
amnesiac (config) # ssc collection-endpoint create txn-export-address demo.com:7091 txn-tls true log-export-address http://demo.com:8080/logs/collector auth-type basic auth-username admin auth-password password name JK-Collection-04
+----------------------------------+-----------------------------------------+
| Field | Value |
+----------------------------------+-----------------------------------------+
| transaction_tls_verify | False |
| auth_type | basic |
| transaction_export_address | demo.com:7091 |
| log_export_address | http://demo.com:8080/logs/collector |
| auth_token | |
| collection_endpoint_id | Collection-Endpoint-4N4H-0NL1-T02T-PZZ7 |
| transaction_endpoint_certificate | |
| transaction_export_tls | True |
| log_endpoint_certificate | |
| tag | JK-Collection-04 |
| log_tls_verify | False |
| auth_password | password |
| auth_username | admin |
+----------------------------------+-----------------------------------------+
*** add a collection endpoint resource that uses analytics system authorization ***
amnesiac (config) # ssc collection-endpoint create txn-export-address demo.com:7092 txn-tls true log-export-address http://demo.com:8080/logs/collector auth-type Splunk auth-token token name JK-Collection-05
+----------------------------------+-----------------------------------------+
| Field | Value |
+----------------------------------+-----------------------------------------+
| transaction_tls_verify | False |
| auth_type | Splunk |
| transaction_export_address | demo.com:7092 |
| log_export_address | http://demo.com:8080/logs/collector |
| auth_token | token |
| collection_endpoint_id | Collection-Endpoint-YKKP-2S6C-VLMM-7L76 |
| transaction_endpoint_certificate | |
| transaction_export_tls | True |
| log_endpoint_certificate | |
| tag | JK-Collection-05 |
| log_tls_verify | False |
| auth_password | |
| auth_username | |
+----------------------------------+-----------------------------------------+
*** 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 |
| Collection-Endpoint-YKKP-2S6C-VLMM-7L76 | JK-Collection-05 |
+-----------------------------------------+------------------+Related Commands
show ssc collection-endpoint, ssc collection-endpoint delete, ssc collection-endpoint list, ssc collection-endpoint update
ssc collection-endpoint delete
Delete a Collection Endpoint resource. This resource is used for vTM analytics.
Syntax
ssc collection-endpoint delete name endpoint-idParameters
name endpoint-idThe identifier for the collection endpoint resource, either its tag or its UUID.
Usage Guidelines
This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command.
Examples
*** 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 |
| Collection-Endpoint-YKKP-2S6C-VLMM-7L76 | JK-Collection-05 |
+-----------------------------------------+------------------+
*** delete an endpoint ***
amnesiac (config) # ssc collection-endpoint delete name JK-Collection-05
+--------------------------------------------------------------------+
| Deleted |
+--------------------------------------------------------------------+
| Analytics Endpoint Collection-Endpoint-YKKP-2S6C-VLMM-7L76 deleted |
+--------------------------------------------------------------------+
*** list all collection endpoints to confirm deletion ***
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 |
+-----------------------------------------+------------------+Related Commands
show ssc collection-endpoint, ssc collection-endpoint create, ssc collection-endpoint list, ssc collection-endpoint update
ssc collection-endpoint list
Lists all Collection Endpoint resources. These resources are used for vTM analytics.
Syntax
ssc collection-endpoint listUsage Guidelines
This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command.
Examples
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 |
| Collection-Endpoint-YKKP-2S6C-VLMM-7L76 | JK-Collection-05 |
+-----------------------------------------+------------------+Related Commands
show ssc collection-endpoint, ssc collection-endpoint create, ssc collection-endpoint delete, ssc collection-endpoint update
ssc collection-endpoint update
Updates a Collection Endpoint resource. This resource is used for vTM analytics.
Syntax
ssc collection-endpoint update name endpoint-id [txn-export-address address] [txn-tls Boolean] [log-export-address address] [auth-type value] [auth-username username] [auth-password password] [auth-token HEC-token] [txn-tls-verify Boolean] [txn-export-cert Certificate] [log-export-cert Certificate] [new-name value]Parameters
nameSpecify a unique identifier for the collection endpoint, either its tag or UUID.
txn-export-addressThe address that transaction data is exported to, in the form <server>:<port>.
For example: demo.com:7090
txn-tlsIndicates whether transaction data requires secure transmission. If true, txn-export-cert is required, and txn-tls-verify is optional.
log-export-addressThe address that log data is exported to, in the form <protocol><server>:<port><filepath>, where <protocol> can be either http:// or https://.
For example: http://demo.com:8080/logs/collector.
If protocol is set to https://, log-export-cert is required.
auth-typeThe required authorization. This can be set to:
- "None": This indicates no authorization is required.
- "Basic": This indicates that basic HTTP authorization is required. If used, auth-username and auth-password are required.
- "Splunk": This indicates that authorization is performed on the Splunk platform. You must also specify auth-token.
auth-usernameThe username for HTTP Basic authentication. This is required when auth-type is "Basic".
auth-passwordThe password for HTTP Basic authentication. This is required when auth-type is "Basic".
auth-tokenThe HEC token from your Splunk platform. This is required when auth-type is "Splunk".
txn-tls-verifyIf true, indicates that verification of the secure connection to the transaction collection endpoint is required.
log-tls-verifyIf true, indicates that verification of the secure connection to the log collection endpoint is required.
txn-export-certThe certificate of the transaction export collection endpoint. This is required if txn-tls is true.
log-export-certThe certificate of the log export collection endpoint. This is required if the <protocol> in log-export-address is https://.
new-name(Optional) A replacement name for the collection endpoint resource.
Usage Guidelines
This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command.
Examples
*** 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 |
| Collection-Endpoint-YKKP-2S6C-VLMM-7L76 | JK-Collection-05 |
+-----------------------------------------+------------------+
*** show details for a listed 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:7070 |
| 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 | |
+----------------------------------+-----------------------------------------+
*** update the collection endpoint, renaming it and changing the port ***
amnesiac (config) # ssc collection-endpoint update name JK-Collection-01 new-name JK-C-Endpoint-9999 txn-export-address demo.com:9999
+----------------------------------+-----------------------------------------+
| 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-C-Endpoint-9999 |
| log_tls_verify | False |
| auth_password | |
| auth_username | |
+----------------------------------+-----------------------------------------+
*** 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-C-Endpoint-9999 |
| Collection-Endpoint-1EGK-KLKN-R6RB-JDLK | JK-Collection-02 |
| Collection-Endpoint-U3FX-MTKU-WSY6-WZ99 | JK-Collection-03 |
| Collection-Endpoint-YKKP-2S6C-VLMM-7L76 | JK-Collection-05 |
+-----------------------------------------+--------------------+Related Commands
show ssc collection-endpoint, ssc collection-endpoint create, ssc collection-endpoint delete, ssc collection-endpoint list
ssc database local bind-address
Sets the local MySQL database bind address.
Syntax
[no] ssc database local bind-address ip-addrParameters
ip-addrSpecify the IP address.
Usage Guidelines
Use the no command option to delete the bind address.
Examples
amnesiac (config) # ssc database local bind-address 10.0.0.1Related Commands
ssc database local db-file delete
Deletes saved Services Director database file.
Syntax
ssc database local db-file delete filenameParameters
filenameSpecify the file name for the database.
Examples
amnesiac (config) # ssc database local db-file delete dbtestRelated Commands
ssc database local db-file export
Exports the Services Director database to a file.
Syntax
ssc database local db-file exportUsage Guidelines
The name of the exported file is calculated automatically using the following format:
sscdb_dump_<SSC VA version string>_<timestamp>.sqlExamples
amnesiac (config) # ssc database local db-file exportRelated Commands
ssc database local db-file import
Imports the Services Director database from a file.
Syntax
ssc database local db-file import filenameParameters
filenameSpecify the file name for the database.
Examples
amnesiac (config) # ssc database local db-file import dbtestRelated Commands
ssc database local port
Sets the local MySQL database port.
Syntax
[no] ssc database local port portParameters
portSpecify the port for the database.
Usage Guidelines
Use the no command option to delete the port.
Examples
amnesiac (config) # ssc database local port 1234Related Commands
ssc database local username
Sets the local MySQL database username and password.
Syntax
ssc database local username name password passwordParameters
nameSpecify the username for the local database.
passwordSpecify the password for the local database.
Examples
amnesiac (config) # ssc database local username ssc password abcd1234
+-------------+-------------+
| DB Username | DB Password |
+-------------+-------------+
| ssc | abcd1234 |
+-------------+-------------+Related Commands
ssc database remote address
Sets the hostname or IP address of the remote database.
Syntax
[no] ssc database remote address addressParameters
addressSpecify the hostname or IP address of the remote database.
Usage Guidelines
Use the no command option to delete the remote database address.
Examples
*** specify a hostname ***
amnesiac (config) # ssc database remote address dmankievicz-03.cam.demo.com
*** specify an IP address ***
amnesiac (config) # ssc database remote address 10.11.12.13Related Commands
ssc database remote db-user-name
Sets the user with privileges for the remote database.
Syntax
ssc database remote db-user-name nameParameters
nameSpecify the database user name.
Examples
amnesiac (config) # ssc database remote db-user-name dbadminRelated Commands
ssc database remote db-user-pwd
Sets the password for the user with privileges for the remote database.
Syntax
ssc database remote db-user-pwd passwordParameters
passwordSpecify the user password.
Examples
amnesiac (config) # ssc database remote db-user-pwd db1234Related Commands
ssc database remote port
Sets the remote database port.
Syntax
[no] ssc database remote port portParameters
portSpecify the port for the remote database.
Usage Guidelines
Use the no command option to delete the remote port.
Examples
amnesiac (config) # ssc database remote port 1234Related Commands
ssc database use-local
Sets the Services Director to use the local MySQL database.
Syntax
[no] ssc database use-localUsage Guidelines
Use the no command option to stop using the local MySQL database.
Examples
amnesiac (config) # ssc database use-localRelated Commands
ssc feature-pack create fpname
Creates a Feature Pack resource for the Services Director.
Syntax
ssc feature-pack create fpname name [skus sku-list |[stm-sku sku-name [add-on-skus add-on-SKU-list]] [excluded feature-list] [info description]Parameters
nameSpecify a unique name for the Feature Pack.
skus(For newer SKUs) Specify a base SKU and one or more additional SKUs. This is a comma-separated list enclosed in double quotes.
stm-sku(Older base SKUs) Specify the base SKU on which the Feature Pack is based. This is limited to SKUs compatible with your Services Director license. If you specify this, you can also specify add-on-skus.
excluded list(Optional) Specify a comma-separated list of features in double quote marks from the base SKU that are excluded. This includes:
- ts: Excludes TrafficScript
- comp: Excludes compression
- cache: Excludes caching
- glb: Excludes global load balancing
- bwm: Excludes bandwidth management classes
- rate: Excludes rate shaping classes
- slm: Excludes service level monitoring
- auto: Excludes autoscaling
- afm: Excludes use of SAF
- apt: Excludes use of Aptimizer.
This list is a comma-separated list enclosed in double quote marks. A complete list can be seen using the show ssc sku sku-name command for your SKU.
add-on-skus(Older base SKUs) Optionally, specify a list of feature SKUs to be associated with the stm-sku base SKU. This includes:
- ADD-FIPS: Federal Information Processing Standards (FIPs)
- ADD-WAF: Virtual Web Application Firewall
- ADD-WEBACCEL: Web Content Accelerator.
This list is a comma-separated list enclosed in double quote marks.
infoOptionally, specify information about the feature pack.
Usage Guidelines
A Feature Pack is a subset (or total set) of the features in a Traffic Manager SKU. The Feature Pack can be applies to vTM instances.
You can view a list of available features for your SKU using the show ssc sku sku-name. You can then specify any of these for exclusion.
The properties that you specify will depend on your base SKU:
- For older SKUs (such as STM-400), you specify the stm-sku and add-on-skus properties.
- For newer SKUs (such as ENT-ADVANCED), you specify the skus property. This is a comma-separated list of SKUs enclosed in double quote marks.
Examples
*** list available Feature Packs ***
amnesiac (config) # ssc feature-pack list
+-------------------+
| FeaturePack |
+-------------------+
| ENT-ADVANCED_full |
+-------------------+
*** list available SKUs ***
amnesiac (config) # ssc sku list
+----------------+
| Sku |
+----------------+
| ENT-ADVANCED |
| ENT-ENTERPRISE |
| ENT-ENTM |
| ENT-WAFPROXY |
| STM-100 |
| STM-200 |
| STM-300 |
| STM-400 |
| STM-WAFPROXY |
+----------------+
*** show details for your SKU to see its list of available features ***
amnesiac (config) # show ssc sku sku-name ENT-ADVANCED
+---------------------+-----------------------------------------------------------
| Field | Value
+---------------------+-----------------------------------------------------------
| status | Active
| pricing_model | prepaid
| add_on_skus | []
| feature_tier | Advanced
| 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.
| | 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 only ...
| | lbrnd : Random.
| | lbrob : Round robin.
| | lbrsp : Fastest response times.
| | lbwcon: Weighted least connection based.
| | lbwrob: Weighted round robin.
| | loca : Enable Location support.
| | moni : Enable Active Monitors
| | rate : Enable Rate Shaping classes.
| | rb : Do not limit the user to RuleBuilder for ...
| | rhi : Route Health Injection.
| | slm : Enable Service Level Monitoring.
| | ssl : Enable SSL
| | svcprt: Enable Service Protection classes
| | ts : Enable TrafficScript
| | xml : Enable XML functions in TrafficScript.
| info | ENT Advanced
| stm_sku | ENT-ADVANCED
| fixed_resource_usage| None
| ent | True
| resource_unit | Mbps
| csp | False
+---------------------+-----------------------------------------------------------
*** create a Feature Pack for analytics, based on the ENT-ADVANCED base SKU and an additional ENT-EMTM SKU ***
amnesiac (config) # ssc feature-pack create fpname ENT-Analytics skus "ENT-ADVANCED,ENT-ENTM"
+-------------+--------------------------------+
| Field | Value |
+-------------+--------------------------------+
| info | |
| status | Active |
| stm_sku | ENT-ADVANCED |
| add_on_skus | [] |
| excluded | |
| skus | [u'ENT-ADVANCED', u'ENT-ENTM'] |
+-------------+--------------------------------+
*** create a Feature Pack, excluding some features***
amnesiac (config) # ssc feature-pack create fpname ENT-ADVANCED-NoRobin stm-sku ENT-ADVANCED excluded "lbrob" info "ENT-ADVANCED without Round-Robin Load Balancing"
+-------------+-------------------------------------------------+
| Field | Value |
+-------------+-------------------------------------------------+
| info | ENT-ADVANCED without Round-Robin Load Balancing |
| status | Active |
| stm_sku | ENT-ADVANCED |
| add_on_skus | [] |
| excluded | lbrob |
| skus | [u'ENT-ADVANCED'] |
+-------------+-------------------------------------------------+
*** confirm addition of the Feature Pack ***
amnesiac (config) # ssc feature-pack list
+----------------------+
| FeaturePack |
+----------------------+
| ENT-ADVANCED-NoRobin |
| ENT-Analytics |
| ENT-ADVANCED_full |
+----------------------+Related Commands
ssc feature-pack create template-name
Creates a feature pack based on an existing template.
Syntax
ssc feature-pack create template-name name | [fpname name] | [stm-sku sku-name] | [excluded comma-separated-list] | [info description] | [add-on-skus name]Parameters
nameSpecify a unique name for the feature pack template.
fpname nameSpecify a unique name for the feature pack.
stm-sku sku-nameSpecify the SKU Traffic Manager on which the feature pack is based. This is limited to SKUs compatible with your Services Director license.
excluded list]Optionally, specify a list of features from the parent SKU that are excluded. These features include:
- afm: Excludes use of SAF.
- apt: Excludes use of Aptimizer
- auto: Excludes autoscaling
- bwm: Excludes bandwidth management classes
- comp: Excludes compression
- cache: Excludes caching
- glb: Excludes global load balancing
- rate: Excludes rate shaping classes
- slm: Excludes service level monitoring
- ts: Excludes TrafficScript
This list is a comma-separated list enclosed in double quote marks. A complete list can be seen using the show ssc sku sku-name command for your SKU.
info descriptionOptionally, specify information about the feature pack.
add-on-skus listOptionally, specify a list of feature SKUs to be associated with the parent SKU:
- ADDFIPS: Federal Information Processing Standards (FIPs)
- ADDWAF: Virtual Web Application Firewall
- ADDWEBACCEL: Web Content Accelerator
This list is a comma-separated list enclosed in double quote marks.
Usage Guidelines
A feature pack is a subset of a Traffic Manager SKU. A SKU contains a defined feature set for the Traffic Manager that you can apply to instances.
You can view a list of available features for your SKU using the show ssc sku sku-name command. You can then specify any of these for exclusion.
Create feature-packs 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 create the command. You have the option to replace or add extra parameters that exist in the specified template (that is, add extra arguments).
Examples
amnesiac (config) # ssc feature-pack create template-name fptemp-1 fpname fp-1Related Commands
ssc feature-pack list
Lists Services Director feature packs.
Syntax
ssc feature-pack listExamples
amnesiac (config) # ssc feature-pack list
+-------------------+
| FeaturePack |
+-------------------+
| ENT-Analytics |
| ENT-ADVANCED_full |
+-------------------+Related Commands
ssc feature-pack update fpname
Updates a Services Director feature pack.
Syntax
ssc feature-pack update fpname name [info description] [status [Active | Inactive]]Parameters
nameIdentify the Feature Pack using its tag or UUID.
infoSpecify a description of the feature pack.
statusSpecify the status:
- Active: Activates a resource.
- Inactive: Deactivates a resource. A resource cannot be marked as Inactive if it is in use. The resource cannot be reactivated.
Usage Guidelines
You can update a limited number of Feature Pack properties.
You cannot update the majority of properties for a Feature Pack, such as the SKUs that it uses. You must instead create a new Feature Pack and apply it to affected vTMs. This may be required when enabling analytics on a cluster of vTMs. Refer to the Services Director Getting Started Guide for full details.
You cannot delete a Feature Pack. However, you can permanently set its status to Inactive.
Examples
amnesiac (config) # ssc feature-pack update fpname ENT-ADVANCED-NoRobin status Inactive
+-------------+-------------------------------------------------+
| Field | Value |
+-------------+-------------------------------------------------+
| info | ENT-ADVANCED without Round-Robin Load Balancing |
| status | Inactive |
| stm_sku | ENT-ADVANCED |
| add_on_skus | [] |
| excluded | lbrob |
| skus | [u'ENT-ADVANCED'] |
+-------------+-------------------------------------------------+Related Commands
ssc feature-pack update template-name
Updates a Services Director feature pack based on the specified template.
Syntax
ssc feature-pack update template-name name | [fpname name] | [info description] | [status Active | Inactive]]Parameters
nameSpecify the template name.
nameSpecify the feature pack name.
info descriptionSpecify information about the feature pack.
statusSpecify the status:
- Active: Activates a resource.
- Inactive: Deactivates a resource. A resource cannot be marked as Inactive if it is in use. The resource cannot be reactivated Inactive status has been specified.
Usage Guidelines
Update a feature-pack 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
amnesiac (config) # ssc feature-pack update template-name fptemp fpname fp1 status InactiveRelated Commands
ssc high-avail certificate
Displays the high availability certificate for a high availability node.
Syntax
ssc high-avail certificate host-or-ip-addrParameters
host-or-ip-addrSpecify the host name or IP address of a high availability node.
Usage Guidelines
This command is identical to the show ssc high-avail list command.
Examples
amnesiac (config) # show ssc high-avail certificate host-01.example.domain.com
+---------------------+--------------------------------------------------------
| Certificate Details | host-01.example.domain.com
+---------------------+--------------------------------------------------------
| Server IP/Name | host-01.example.domain.com
| Fingerprint | 25:99:36:10:4E:9A:FB:23:8E:8F:37:FD:17:3B:34:4A:6E:...
| |
| Issued To |
| Common Name | amnesiac
| Organization | amnesiac
| Organization Unit | Created Sat Aug 29 02:14:29 2015
| Country | XX
| |
| Issued By |
| Common Name | amnesiac
| Organization | amnesiac
| Organization Unit | Created Sat Aug 29 02:14:29 2015
| Country | XX
| |
| Validity |
| Effective On | Sat, 29 Aug 2015 01:59:30 GMT
| Expires On | Tue, 26 Aug 2025 01:59:30 GMT
| |
| Key |
| Type | sha1withRSAEncryption
| Size | 2048
| |
| PEM | -----BEGIN CERTIFICATE-----
| | MIIDXTCCAkUCCEs9poyyQcRZMA0GCSqGSIb3DQEBBQUAMHExSDFGFJ
| | .
| | . (certificate)
| | .
| | f6vS3P/U3/sIH3aJMQwD11+zNeQ/FXC+CCdFPx2qLvZ2Kpk3La153
| | 7cbGLjCk+QaRhA==
| | -----END CERTIFICATE-----
+---------------------+------------------------------------------------------Related Commands
ssc high-avail file-replication reset
Resets the file replication service for the current HA pair.
Syntax
ssc high-avail file-replication resetExamples
amnesiac (config) # ssc high-avail file-replication resetRelated Commands
ssc high-avail create
Creates a Primary standalone Services Director from the current node. This command is useful to change the role of a Services Director after an ejection or other failure.
Syntax
ssc high-avail create traffic-ip IP-or-hostnameParameters
traffic-ipThe IP address or host name of the required Service Endpoint Address.
Usage Guidelines
This command will be destructive to an HA pair if the current node is in an HA pair.
If you want to change the Standby node of an HA pair into an Active node, use the ssc high-avail force-failover command.
This command completes in the background. Use ssc high-avail reset to check its progress.
Examples
*** current HA status of current node (was a Standby) after ejection ***
amnesiac (config) # ssc high-avail list
+---+-----------------+-----+----------+------+----------- ...
| # | Cluster IP/Name | TIP | Database | Role | DB Health ...
+---+-----------------+-----+----------+------+----------- ...
+---+-----------------+-----+----------+------+----------- ...
... -+-------------------+----------------+--------+----------+--------+
... | Gluster FS Health | SSC Web Health | System | Serial # | Status |
... -+-------------------+----------------+--------+----------+--------+
... -+-------------------+----------------+--------+----------+--------+
*** initiate the change to a standalone Primary for the current node ***
amnesiac (config) # ssc high-avail create traffic-ip 10.62.167.203
+---+-----------------+-----+----------+------+----------- ...
| # | Cluster IP/Name | TIP | Database | Role | DB Health ...
+---+-----------------+-----+----------+------+----------- ...
| | 10.62.167.199 | | | | ...
+---+-----------------+-----+----------+------+----------- ...
... +-------------------+----------------+--------+----------+----------+
... | Gluster FS Health | SSC Web Health | System | Serial # | Status |
... +-------------------+----------------+--------+----------+----------+
... | | | | | Creating |
... +-------------------+----------------+--------+----------+----------+
*** after completion, a standalone Primary is reported ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
| 1 | 10.62.167.199 | 10.62.167.195 | 10.62.167.194:3306 ...
+---+-----------------+---------------+-------------------- ...
... +---------+-----------+-------------------+---------------- ...
... | Role | DB Health | Gluster FS Health | SSC Web Health ...
... +---------+-----------+-------------------+---------------- ...
... | Active | Healthy | Healthy | Healthy ...
... +---------+-----------+-------------------+---------------- ...
... +------------------------------+--------------+--------+
... | System | Serial # | Status |
... +------------------------------+--------------+--------+
... | rbt_ssc 2.3.0-mainline #134 | 005056A652CD | Active |
... +------------------------------+--------------+--------+Related Commands
ssc high-avail diagnose
Diagnoses causes for HA pair errors on the current node, and proposes available solutions.
Syntax
ssc high-avail diagnoseUsage Guidelines
This command can be run on either the Active or Standby nodes. The diagnostic inspects the states of the three modules:
- web service
- database
- filestore replication
Based on the health of each module, the diagnostic command returns an instruction set which the user can follow to troubleshoot the issues.
Examples
*** When there are errors (example) ***
amnesiac (config) # ssc high-avail diagnose
+-----------+------------+-------------------+
| DB Status | SSC Status | Traffic IP Status |
+-----------+------------+-------------------+
| ok | failed | failed |
+-----------+------------+-------------------+
+-------------------------------+------------------------------------------+
| Solutions | Steps |
+-------------------------------+------------------------------------------+
| Demote current node to backup | 1: Release traffic ip on current node; |
| | 2: Demote db to backup on current node; |
+-------------------------------+------------------------------------------+
*** When there are no errors ***
amnesiac (config) # ssc high-avail diagnose
+-----------+------------+-------------------+
| DB Status | SSC Status | Traffic IP Status |
+-----------+------------+-------------------+
| ok | ok | ok |
+-----------+------------+-------------------+
+-----------+-------+
| Solutions | Steps |
+-----------+-------+
+-----------+-------+Related Commands
ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail discover
Displays Primary Services Director nodes in the current subnet that do not belong to an HA pair.
Syntax
ssc high-avail discoverExamples
amnesiac (config) # ssc high-avail disc
+------------------+---------------------+
| Primary Hostname | Primary Server's IP |
+------------------+---------------------+
| axon-08 | 10.62.98.88 |
| axon-0b | 10.62.98.91 |
| dvenkman-0f | 10.62.98.79 |
| jsorrentino-01 | 10.62.99.193 |
| jsorrentino-03 | 10.62.99.195 |
| tkumar-24 | 10.62.99.164 |
| jsorrentino-1f | 10.62.101.255 |
| jwhitehouse-1a | 10.62.101.42 |
+------------------+---------------------+Related Commands
ssc high-avail diagnose, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail eject
Ejects a specified Standby node from the current HA pair.
Syntax
ssc high-avail eject IP-or-hostnameParameters
IP-or-hostnameThe IP address or host name of the Standby node to be ejected.
Usage Guidelines
This command must be used from the Active node.
Services Director supports a single Standby node.
Examples
*** check current HA configuration from Active node ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+-------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+-------- ...
| 1 | 10.62.167.201 | 10.62.167.202 | 10.62.167.201:3306 | Active ...
| 2 | 10.62.167.199 | | 10.62.167.199:3306 | Standby ...
+---+-----------------+---------------+--------------------+-------- ...
*** eject the Standby node ***
amnesiac (config) # ssc high-avail eject 10.62.167.199
+---+-----------------+---------------+--------------------+-------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+-------- ...
| 1 | 10.62.167.201 | 10.62.167.202 | 10.62.167.201:3306 | Active ...
+---+-----------------+---------------+--------------------+-------- ...Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail ejectall
Ejects all Standby nodes, and tidies all the Standby node metadata/configurations from the Active node. This command can be run even when there is no Standby node.
Syntax
ssc high-avail ejectallUsage Guidelines
This command must be used from the Active node.
Services Director supports a single Standby node.
Examples
*** check current HA configuration from Active node ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+-------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+-------- ...
| 1 | 10.62.167.201 | 10.62.167.202 | 10.62.167.201:3306 | Active ...
| 2 | 10.62.167.199 | | 10.62.167.199:3306 | Standby ...
+---+-----------------+---------------+--------------------+-------- ...
*** eject the Standby node ***
amnesiac (config) # ssc high-avail ejectall
+---+-----------------+---------------+--------------------+-------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+-------- ...
| 1 | 10.62.167.201 | 10.62.167.202 | 10.62.167.201:3306 | Active ...
+---+-----------------+---------------+--------------------+-------- ...Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail failover
This command performs a failover from the Standby node of an HA pair.
Syntax
ssc high-avail failover backup-node IP-or-hostnameParameters
backup-node IP-or-hostnameThe IP address or host name of the Standby node. You must issue this command from this Standby node.
Usage Guidelines
Both Active and Standby nodes must be healthy to perform a failover.
As a result of the failover:
- The current Active and Standby nodes will exchange roles.
- The new Active node takes control of the HA pair for all purposes.
- The SEA/TIP points to the now-Active node.
This command completes in the background. Use ssc high-avail reset to check its progress.
Examples
*** current status of the HA pair ***
+---+-----------------+---------------+--------------------+- ...
| # | Cluster IP/Name | TIP | Database | ...
+---+-----------------+---------------+--------------------+- ...
| 1 | 10.62.167.201 | 10.62.167.202 | 10.62.167.201:3306 | ...
| 2 | 10.62.167.199 | | 10.62.167.199:3306 | ...
+---+-----------------+---------------+--------------------+- ...
... --------+-----------+-------------------+----------------+- ...
... Role | DB Health | Gluster FS Health | SSC Web Health | ...
... --------+-----------+-------------------+----------------+- ...
... Active | Healthy | Healthy | Healthy | ...
... Standby | Healthy | Healthy | Healthy | ...
... --------+-----------+-------------------+----------------+- ...
... -----------------------------+--------------+--------+
... System | Serial # | Status |
... -----------------------------+--------------+--------+
... rbt_ssc 2.3.0-mainline #134 | 005056A60F7D | Active |
... rbt_ssc 2.3.0-mainline #134 | 005056A677D3 | Active |
... -----------------------------+--------------+--------+
*** initiate failover from the Standby node ***
amnesiac (config) # ssc high-avail failover backup-node 10.62.167.199
Successfully initiated failover on Standby node(10.62.167.199).
Please check [ssc high-avail list] for status
*** check progress to confirm completion of the failover ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+- ...
| # | Cluster IP/Name | TIP | Database | ...
+---+-----------------+---------------+--------------------+- ...
| 1 | 10.62.167.201 | | 10.62.167.201:3306 | ...
| 2 | 10.62.167.199 | 10.62.167.202 | 10.62.167.199:3306 | ...
+---+-----------------+---------------+--------------------+- ...
... --------+-----------+-------------------+----------------+- ...
... Role | DB Health | Gluster FS Health | SSC Web Health | ...
... --------+-----------+-------------------+----------------+- ...
... Standby | Healthy | Healthy | Healthy | ...
... Active | Healthy | Healthy | Healthy | ...
... --------+-----------+-------------------+----------------+- ...
... -----------------------------+--------------+--------+
... System | Serial # | Status |
... -----------------------------+--------------+--------+
... rbt_ssc 2.3.0-mainline #134 | 005056A60F7D | Active |
... rbt_ssc 2.3.0-mainline #134 | 005056A677D3 | Active |
... -----------------------------+--------------+--------+
*** Active and Standby have exchanged places, and SEA/TIP has moved ***Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail force-failover
This command enables you to perform a failover operation from a healthy Standby node after the Active node becomes unhealthy.
Syntax
ssc high-avail force-failoverUsage Guidelines
This command is different from a regular failover, because the Active node is unhealthy in this case. A regular failover is only supported when both the Active and Standby nodes are healthy.
As a result of the forced failover:
- The current Standby nodes becomes the Active node.
- The SEA/TIP points to the now-Active node.
- The outcome on the unhealthy Active node depends on whether it can be contacted. If the unhealthy Active node can be contacted, it will become the Standby node. The Standby node remains unhealthy until repaired. If the unhealthy Active node cannot be contacted, it will remain as an Active node. When this node is repaired and returned to a healthy state, a "split brain" scenario will result. That is, two healthy nodes in an HA pair both believe themselves to be the Active node, and that the other node is the Standby.
See ssc high-avail join for details of the "split brain" scenario, and for instructions on how to recover from it.
This command completes in the background. Use ssc high-avail reset to check its progress.
Examples
In this example:
- The unhealthy Active node is amnesiac-01 (10.62.167.193).
- The healthy Standby node is amnesiac-02 (10.62.167.194)
- The Service Endpoint Address (TIP) is 10.62.167.195.
*** View the status of the HA pair from the healthy Standby node ***
*** The Active node is unhealthy, the Standby node is healthy ***
amnesiac-02 (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+--------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+--------- ...
| 1 | 10.62.167.194 | | 10.62.167.194:3306 | Standby ...
| 2 | 10.62.167.193 | 10.62.167.195 | N/A | Active ...
+---+-----------------+---------------+--------------------+--------- ...
... +-----------+-------------------+---------------- ...
... | DB Health | Gluster FS Health | SSC Web Health ...
... +-----------+-------------------+---------------- ...
... | Healthy | Healthy | Healthy ...
... | Degraded | Degraded | Degraded ...
... +-----------+-------------------+---------------- ...
... +---------------------------------------------------------------------+
... | Status |
... +---------------------------------------------------------------------+
... | Active |
... | There was a problem communicating with machine 10.62.167.193:9080 |
... +---------------------------------------------------------------------+
*** perform a force-failover to make the Standby node into the Active node ***
amnesiac-02 (config) # ssc high-avail force-failover 10.62.167.194
*** monitor progress of the forced failover until complete ***
amnesiac-02 (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+--------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+--------- ...
| 1 | 10.62.167.194 | 10.62.167.195 | 10.62.167.194:3306 | Active ...
| 2 | 10.62.167.193 | | N/A | Active ...
+---+-----------------+---------------+--------------------+--------- ...
... +-----------+-------------------+---------------- ...
... | DB Health | Gluster FS Health | SSC Web Health ...
... +-----------+-------------------+---------------- ...
... | Healthy | Healthy | Healthy ...
... | Degraded | Degraded | Degraded ...
... +-----------+-------------------+---------------- ...
... +---------------------------------------------------------------------+
... | Status |
... +---------------------------------------------------------------------+
... | Active |
... | There was a problem communicating with machine 10.62.167.193:9080 |
... +---------------------------------------------------------------------+Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail force-standby
Performs a forced standby of an Active node.
Syntax
ssc high-avail force-standbyUsage Guidelines
This command is intended as a way to recover from the "split brain" scenario. That is, two healthy nodes in an HA pair both believe themselves to be the Active node, and that the other node is the Standby.
This scenario is possible after a failed force-failover command (see ssc high-avail force-failover).
After this failure:
- The original Active node is unhealthy/uncontactable, and still configured as the Active node in an HA pair. Once repaired, it will show as healthy.
- The original Standby node is now the healthy current Active node.
To confirm this, log into both the Active and the Standby and check the list the high availability status of each. Each will show itself as Active and healthy. To resolve the "split brain", perform a force-standby on the original Active node. This performs the following actions:
- Switches the original Active node to be the new Standby.
- The HA pair reforms.
This command completes in the background. Use ssc high-avail reset to check its progress.
Examples
In this example:
- The original Active node (which failed by is now repaired) is amnesiac-01 (10.62.167.193).
- The new Active node (the original Standby) is amnesiac-02 (10.62.167.194)
- The Service Endpoint Address (TIP) is 10.62.167.195.
*** check the HA status of the original (repaired) Active node ***
amnesiac-01 (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+--------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+--------- ...
| 1 | 10.62.167.194 | | 10.62.167.194:3306 | Standby ...
| 2 | 10.62.167.193 | 10.62.167.195 | 10.62.167.193:3306 | Active ...
+---+-----------------+---------------+--------------------+--------- ...
*** check the high availability status of the new Active node ***
amnesiac-02 (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+--------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+--------- ...
| 1 | 10.62.167.194 | 10.62.167.195 | 10.62.167.194:3306 | Active ...
| 2 | 10.62.167.193 | | N/A | N/A ...
+---+-----------------+---------------+--------------------+--------- ...
*** initiate the force-standby from the original Active node ***
amnesiac-01 (config) # ssc high-avail force-standby
*** from the new Active node, check status - the HA pair dissolves ***
amnesiac-02 (config) # ssc high-avail list
+---+-----------------+----- ... -+-----------------------+
| # | Cluster IP/Name | TIP ... | Status |
+---+-----------------+----- ... -+-----------------------+
| 1 | 10.62.167.194 | 10. ... | Active |
| 1 | 10.62.167.193 | ... | File System detaching |
+---+-----------------+----- ... -+-----------------------+
*** The HA pair begins to reform ***
amnesiac-02 (config) # ssc high-avail list
+---+-----------------+----- ... -+----------+
| # | Cluster IP/Name | TIP ... | Status |
+---+-----------------+----- ... -+----------+
| 1 | 10.62.167.194 | ... | Creating |
| 1 | 10.62.167.193 | ... | Creating |
+---+-----------------+----- ... -+----------+
*** after a few minutes, the force-standby completes ***
amnesiac-02 (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+--------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+--------- ...
| 1 | 10.62.167.194 | 10.62.167.195 | 10.62.167.193:3306 | Active ...
| 2 | 10.62.167.193 | | 10.62.167.194:3306 | Standby ...
+---+-----------------+---------------+--------------------+--------- ...
*** confirm this result from the new Standby node ***
amnesiac-01 (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+--------- ...
| # | Cluster IP/Name | TIP | Database | Role ...
+---+-----------------+---------------+--------------------+--------- ...
| 1 | 10.62.167.194 | 10.62.167.195 | 10.62.167.193:3306 | Active ...
| 2 | 10.62.167.193 | | 10.62.167.194:3306 | Standby ...
+---+-----------------+---------------+--------------------+--------- ...Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail join, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail join
Joins the current unpaired Services Director node to a specified Primary Services Director node.
Syntax
ssc high-avail join IP-or-hostnameParameters
IP-or-hostnameThe IP address or host name of the Primary node.
Usage Guidelines
This command initially reports that an attempt to join is in progress, but completes in the background. Use ssc high-avail reset to check the progress of the join process.
Examples
*** confirm node is not in an HA pair ***
amnesiac (config) # ssc high-avail list
+---+-----------------+-----+----------+------+- ...
| # | Cluster IP/Name | TIP | Database | Role |
+---+-----------------+-----+----------+------+- ...
+---+-----------------+-----+----------+------+- ...
amnesiac (config) # ssc high-avail discover
+------------------+---------------------+
| Primary Hostname | Primary Server's IP |
+------------------+---------------------+
| jsorrentino-08 | 10.62.166.200 |
| jkumar-24 | 10.62.167.164 |
| jkelly-09 | 10.62.167.201 |
| jsorrentino-14 | 10.62.168.244 |
| jwhitehouse-1a | 10.62.168.42 |
+------------------+---------------------+
amnesiac (config) # ssc high-avail join 10.62.167.201
+---+-----------------+-----+- ... -+--------------+
| # | Cluster IP/Name | TIP | ... | Status |
+---+-----------------+-----+- ... -+--------------+
| 1 | 10.62.167.199 | | ... | Node joining |
+---+-----------------+-----+- ... -+--------------+
amnesiac (config) # ssc high-avail list
+---+-----------------+-----+ ... -+---------------------+
| # | Cluster IP/Name | TIP | ... | Status |
+---+-----------------+-----+- ... -+---------------------+
| 1 | 10.62.167.199 | | ... | File System joining |
+---+-----------------+-----+- ... -+---------------------+
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+--------------------+- ...
| # | Cluster IP/Name | TIP | Database | ...
+---+-----------------+---------------+--------------------+- ...
| 1 | 10.62.167.201 | 10.62.167.202 | 10.62.167.201:3306 | ...
| 2 | 10.62.167.199 | | 10.62.167.199:3306 | ...
+---+-----------------+---------------+--------------------+- ...
... +---------+-----------+-------------------+---------------- ...
... | Role | DB Health | Gluster FS Health | SSC Web Health ...
... +---------+-----------+-------------------+---------------- ...
... | Active | Healthy | Healthy + Healthy ...
... | Standby | Healthy | Healthy + Healthy ...
... +---------+-----------+-------------------+---------------- ...
... -----------------------------+--------------+--------+
... System | Serial # | Status |
... -----------------------------+--------------+--------+
... rbt_ssc 2.3.0-mainline #134 | 005056A60F7D | Active |
... rbt_ssc 2.3.0-mainline #134 | 005056A677D3 | Active |
... -----------------------------+--------------+--------+Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail list, ssc high-avail reset, ssc high-avail update
ssc high-avail list
Displays a list of nodes in the current HA pair.
Syntax
ssc high-avail listUsage Guidelines
For a standalone Services Director, only one node is listed.
This command is identical to the show ssc host host-name command.
Examples
*** for an HA pair ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
| 1 | jacaranda | 10.62.167.195 | 10.62.167.194:3306 ...
| 2 | amnesiac | | 10.62.167.193:3306 ...
+---+-----------------+---------------+-------------------- ...
... +---------+-----------+-------------------+---------------- ...
... | Role | DB Health | Gluster FS Health | SSC Web Health ...
... +---------+-----------+-------------------+---------------- ...
... | Active | Healthy | Healthy + Healthy ...
... | Standby | Healthy | Healthy + Healthy ...
... +---------+-----------+-------------------+---------------- ...
... +------------------------------+--------------+--------+
... | System | Serial # | Status |
... +------------------------------+--------------+--------+
... | rbt_ssc 2.3.0-mainline #134 | 005056A652CD | Active |
... | rbt_ssc 2.3.0-mainline #134 | 005056A66723 | Active |
... +------------------------------+--------------+--------+
*** for a standalone node ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
| 1 | jacaranda | 10.62.167.195 | 10.62.167.194:3306 ...
+---+-----------------+---------------+-------------------- ...
... +---------+-----------+-------------------+---------------- ...
... | Role | DB Health | Gluster FS Health | SSC Web Health ...
... +---------+-----------+-------------------+---------------- ...
... | Active | Healthy | Healthy + Healthy ...
... +---------+-----------+-------------------+---------------- ...
... +------------------------------+--------------+--------+
... | System | Serial # | Status |
... +------------------------------+--------------+--------+
... | rbt_ssc 2.3.0-mainline #134 | 005056A652CD | Active |
... +------------------------------+--------------+--------+
*** for a node that is not in an HA pair ***
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
+---+-----------------+---------------+-------------------- ...
... +---------+-----------+-------------------+---------------- ...
... | Role | DB Health | Gluster FS Health | SSC Web Health ...
... +---------+-----------+-------------------+---------------- ...
... +---------+-----------+-------------------+---------------- ...
... +------------------------------+--------------+--------+
... | System | Serial # | Status |
... +------------------------------+--------------+--------+
... +------------------------------+--------------+--------+Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail reset, ssc high-avail update
ssc high-avail reset
Performs a factory reset on the current high availability node. This erases the entire HA configuration.
Syntax
ssc high-avail resetUsage Guidelines
After this command completes, the Services Director must be restarted.
After using this command, you can use:
- ssc high-avail diagnose to create a standalone node.
- ssc high-avail list to join an HA pair.
Examples
*** logged in on Standby, display current state of HA pair ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
| 1 | jacaranda | 10.62.167.195 | 10.62.167.194:3306 ...
| 2 | amnesiac | | 10.62.167.193:3306 ...
+---+-----------------+---------------+-------------------- ...
... +---------+-----------+-------------------+---------------- ...
... | Role | DB Health | Gluster FS Health | SSC Web Health ...
... +---------+-----------+-------------------+---------------- ...
... | Active | Healthy | Healthy + Healthy ...
... | Standby | Healthy | Healthy + Healthy ...
... +---------+-----------+-------------------+---------------- ...
... +------------------------------+--------------+--------+
... | System | Serial # | Status |
... +------------------------------+--------------+--------+
... | rbt_ssc 2.3.0-mainline #134 | 005056A652CD | Active |
... | rbt_ssc 2.3.0-mainline #134 | 005056A66723 | Active |
... +------------------------------+--------------+--------+
*** remove this node (Standby) from its HA pair ***
amnesiac (config) # ssc high-avail reset
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
+---+-----------------+---------------+-------------------- ...
... +---------+-----------+-------------------+---------------- ...
... | Role | DB Health | Gluster FS Health | SSC Web Health ...
... +---------+-----------+-------------------+---------------- ...
... +---------+-----------+-------------------+---------------- ...
... +------------------------------+--------------+--------+
... | System | Serial # | Status |
... +------------------------------+--------------+--------+
... +------------------------------+--------------+--------+Related Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail update
ssc high-avail token
Displays the current high availability access token. This is present on nodes within HA pairs, and on standalone nodes. Paired nodes must share a high availability access token, which is used to enable authenticated communication between the HA nodes.
Syntax
ssc high-avail tokenUsage Guidelines
This command is identical to the ssc high-avail token remove command.
Examples
amnesiac (config) # ssc high-avail token
+--------------------------------------+------------------------- ...
| Token ID | Access Token ...
+--------------------------------------+------------------------- ...
| 3f4a1f71-665c-46e7-aa30-11f2abd6a06d | eyJhdWQiOiAiaHgJaTgRdPcA ...
| | ZW4iLCAiaXNzIjHGwEFggTAf ...
| | ZG1pbiIsICJqdGKjHgkkjGhj ...
| | ZDZhMDZkIiwgImLjhFerwFGH ...
+--------------------------------------+------------------------- ...
... -----------------------+-------------+
... | Description |
... -----------------------+-------------+
... BpL2NvbW1vbi8xLjAvdG9r | cluster |
... AxIiwgInBybiI6ICJsai1h | |
... 00NmU3LWFhMzAtMTFmMmFi | |
... IxNDQxMjYyMTc2In0= | |
... -----------------------+-------------+Related Commands
ssc high-avail token add, ssc high-avail token generate, ssc high-avail token list, ssc high-avail token remove
ssc high-avail token add
Adds a token to the current high availability access token. This can be either a node in an HA pair, or standalone node.
Syntax
ssc high-avail token addUsage Guidelines
This command can only be used when there is no assigned token. Use ssc high-avail update to remove the current token.
Examples
*** confirm no token currently set ***
amnesiac (config) # ssc high-avail token
+----------+--------------+-------------+
| Token ID | Access Token | Description |
+----------+--------------+-------------+
+----------+--------------+-------------+
*** add different token ***
amnesiac (config) # ssc high-avail token add description cluster_token access-token eyJhdWQiOiAiaH...QxMjc5MTczIn0=
Access token added successfully.
*** confirm addition of new token ***
amnesiac (config) # ssc high-avail token
+--------------------------------------+--------------- ...
| Token ID | Access Token ...
+--------------------------------------+--------------- ...
| f134a204-6b89-46b5-b796-8ddd06377eb6 | eyJhdWQiOiAiaH ...
| | ZW4iLCAiaXNzIj ...
| | biIsICJqdGkiOi ...
| | ZWI2IiwgImV4cC ...
+--------------------------------------+--------------- ...
... ----------------------+---------------+
... | Description |
... ----------------------+---------------+
... pL2NvbW1vbi8xLjAvdG9r | cluster_token |
... xIiwgInBybiI6ICJhZG1p | |
... 1LWI3OTYtOGRkZDA2Mzc3 | |
... xMjc5MTczIn0= | |
... ----------------------+---------------+Related Commands
ssc high-avail token, ssc high-avail token generate, ssc high-avail token list, ssc high-avail token remove
ssc high-avail token generate
Generates a new high availability access token for the current node. This can be either a node in an HA pair, and on standalone node.
Syntax
ssc high-avail token generateExamples
amnesiac (config) # ssc high-avail token generate
+--------------------------------------+------------------------- ...
| Token ID | Access Token ...
+--------------------------------------+------------------------- ...
| 3f4a1f71-665c-46e7-aa30-11f2abd6a06d | eyJhdWQiOiAiaHgJaTgRdPcA ...
| | ZW4iLCAiaXNzIjHGwEFggTAf ...
| | ZG1pbiIsICJqdGKjHgkkjGhj ...
| | ZDZhMDZkIiwgImLjhFerwFGH ...
+--------------------------------------+------------------------- ...
... -----------------------+-------------+
... | Description |
... -----------------------+-------------+
... BpL2NvbW1vbi8xLjAvdG9r | cluster |
... AxIiwgInBybiI6ICJsai1h | |
... 00NmU3LWFhMzAtMTFmMmFi | |
... IxNDQxMjYyMTc2In0= | |
... -----------------------+-------------+Related Commands
ssc high-avail token, ssc high-avail token add, ssc high-avail token list, ssc high-avail token remove
ssc high-avail token list
Displays the current high availability access token.
Usage Guidelines
This command is identical to the ssc high-avail token add command.
ssc high-avail token remove
Removes the high availability access token from the current node. This can be either a node in an HA pair, and on standalone node.
Syntax
ssc high-avail token token-idParameters
token token-idThe token ID. Use ssc high-avail token add to display this for the current node.
Examples
*** list current token ***
amnesiac (config) # ssc high-avail token
+--------------------------------------+------------------------- ...
| Token ID | Access Token ...
+--------------------------------------+------------------------- ...
| 3f4a1f71-665c-46e7-aa30-11f2abd6a06d | eyJhdWQiOiAiaHgJaTgRdPcA ...
| | ZW4iLCAiaXNzIjHGwEFggTAf ...
| | ZG1pbiIsICJqdGKjHgkkjGhj ...
| | ZDZhMDZkIiwgImLjhFerwFGH ...
+--------------------------------------+------------------------- ...
... -----------------------+-------------+
... | Description |
... -----------------------+-------------+
... BpL2NvbW1vbi8xLjAvdG9r | cluster |
... AxIiwgInBybiI6ICJsai1h | |
... 00NmU3LWFhMzAtMTFmMmFi | |
... IxNDQxMjYyMTc2In0= | |
... -----------------------+-------------+
*** remove current HA access token ***
amnesiac (config) # ssc high-avail token remove 3f4a1f71-665c-46e7-aa30-11f2abd6a06d
Token ID '3f4a1f71-665c-46e7-aa30-11f2abd6a06d' removed successfully.
*** confirm removal ***
amnesiac (config) # ssc high-avail token
+----------+--------------+-------------+
| Token ID | Access Token | Description |
+----------+--------------+-------------+
+----------+--------------+-------------+Related Commands
ssc high-avail token, ssc high-avail token add, ssc high-avail token generate, ssc high-avail token list
ssc high-avail update
Updates the Service Endpoint Address of an HA pair (or standalone Services Director).
Syntax
ssc high-avail update traffic-ip IP-or-hostnameParameters
traffic-ipThe IP address or host name of the new Service Endpoint Address.
Usage Guidelines
This command can be issued from either the Active or the Standby node.
Do not use this command from the Service Endpoint Address node. The command will fail.
This command affects FLA licensing for vTMs:
- Any Legacy FLA licenses that were created to service the current Service Endpoint Address will fail when the Service Endpoint Address changes. To fix this, generate a new Legacy FLA based on the new Service Endpoint Address.
- Any Universal FLA licenses that are tied to the current Service Endpoint Address will need to be relicensed (see ssc instance relicense instance-name).
After this command completes, a restart of your Services Director service is required.
Examples
*** display the current Service Endpoint Address (TIP) ***
amnesiac (config) # ssc high-avail list
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
| 1 | 10.62.167.201 | 10.62.167.200 | 10.62.167.201:3306 ...
| 2 | 10.62.167.199 | | 10.62.167.199:3306 ...
+---+-----------------+---------------+-------------------- ...
*** change the Service Endpoint Address (TIP) ***
amnesiac (config) # ssc high-avail update traffic-ip 10.62.167.202
+---+-----------------+---------------+-------------------- ...
| # | Cluster IP/Name | TIP | Database ...
+---+-----------------+---------------+-------------------- ...
| 1 | 10.62.167.201 | 10.62.167.202 | 10.62.167.201:3306 ...
| 2 | 10.62.167.199 | | 10.62.167.199:3306 ...
+---+-----------------+---------------+-------------------- ...
*** restart the service ***
amnesiac (config) # ssc service restartRelated Commands
ssc high-avail diagnose, ssc high-avail discover, ssc high-avail eject, ssc high-avail ejectall, ssc high-avail failover, ssc high-avail force-failover, ssc high-avail force-standby, ssc high-avail join, ssc high-avail list, ssc high-avail reset
ssc host add host-name
Adds a Services Director instance host.
Syntax
ssc host add host-name name host-user name host-pass password username name | [usage-info description] | [retained-info-dir directory] | [max-instances number] | [cpu-cores string] | [info description]Parameters
host-name nameSpecify a unique name for this resource.
host-user name(DEPRECATED) Specify the host administrator user name; you must specify sscadmin.
host-pass password(DEPRECATED) Specify the host administrator password; the default value is password.
username userSpecify the user for SSH access; this user must be root.
usage-info description(DEPRECATED) This property is not used.
retained-info-dir directory(DEPRECATED) This property is not used.
max-instances numberThe number of instances that you can create on this host.
cpu-cores string(DEPRECATED) This property is not used.
info description(Optional) Specify descriptive information.
Usage Guidelines
Use the no ssc host hostname <name> to delete the host.
Examples
amnesiac (config) # ssc host add host-name test-demo1 host-user sscadmin host-pass password username rootRelated Commands
ssc host add template-name
Adds a Services Director host based on a template. Optionally, adds or changes the current values for the new host.
Syntax
ssc host add template-name name | [host-name name] | [host-user name] | [host-pass password] | [username user] | [usage-info description] | [retained-info-dir number] | [max-instances number] | [cpu-cores string] | [info description]Parameters
nameSpecify the unique name for the template.
host-name nameOptionally, specify the host name.
host-user nameOptionally, specify the administrator user name. The default value is sscadmin.
host-pass admin-passwordOptionally, specify the administrator password; the default value is password.
username userOptionally, specify the user for SSH access; this user must be root.
retained-info-dir directoryThis property is not used.
usage-info descriptionThis property is not used.
max-instances numberThe number of instances that you can create on this host.
cpu-cores stringThis property is not used.
info descriptionOptionally, specify descriptive information about the new host.
Usage Guidelines
Before you can use this command, you must first create a host template using the ssc template create command. Optionally, you can add or modify the current values the specified for the new host.
Examples
amnesiac (config) # ssc host add template-name htemp1 host-name test-demo username rootRelated Commands
ssc host host-migrate
Migrate vTM instances between hosts within the same subnet.
Syntax
ssc host host-migrate from name-or-ip-addr-from to ip-addr-to [force yes-or-no]Parameters
name-or-ip-addr-fromSpecify the name of the instance host where the Traffic Manager is migrating from.
ip-addr-toOptionally, specify the IP address or the name of the instance host where the Traffic Manager is migrating to.
force yes-or-noForces migration of Traffic Managers regardless of the network topology.
Examples
amnesiac (config) # ssc host host-migrate from 10.0.0.1 to 10.0.05 force yesRelated Commands
ssc host host-name dns
Configures instance host DNS settings.
Syntax
ssc host host-name name dns dns-nameservers dns-name-servers | [dns-search dnsfixes]Parameters
nameSpecify a unique name for the host.
dns-nameservers dns-name-serversSpecify the DNS name server.
dns-search dns-suffixesOptionally, specify a comma separated list of searched domain suffixes.
Examples
amnesiac (config) # ssc host host-name test dns dns-nameservers dnstest