--- title: Config-Mode Commands slug: ps/help/en_us/sd/25x/cli/config-mode-commands docTags: createdAt: 2026-10-06T15:00:40.030Z --- ### ssc analytics-profile delete :::Paragraph{indent="1"} Delete a specified analytics profile resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc analytics-profile delete id profile-id ``` ### Parameters ```bash id profile-id ``` :::Paragraph{indent="1"} The identifier for the analytics profile resource, either its** tag** or its UUID. ::: ### Examples ```bash *** list all analytics profiles *** amnesiac (config) # ssc analytics-profile list +---------------------------------------+------------------------+ | ID | Tag | +---------------------------------------+------------------------+ | Analytics-Profile-6IQG-F6UQ-8C11-7G8F | Audit + System | | Analytics-Profile-F5V3-S912-G3UP-HPNR | Event | | Analytics-Profile-XNAH-H9J1-0MQM-BK59 | Audit | | Analytics-Profile-I6DJ-RRQV-KQ5Z-HY7J | Event + System | | Analytics-Profile-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 :::Paragraph{indent="1"} [show ssc analytics-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile create](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc analytics-profile update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc analytics-profile list :::Paragraph{indent="1"} Lists all analytics profile resources. These resources are used for vTM analytics. ::: ### Syntax ```bash ssc analytics-profile list ``` ### Examples ```bash amnesiac (config) # ssc analytics-profile list +---------------------------------------+------------------------+ | ID | Tag | +---------------------------------------+------------------------+ | Analytics-Profile-6IQG-F6UQ-8C11-7G8F | Audit + System | | Analytics-Profile-F5V3-S912-G3UP-HPNR | Event | | Analytics-Profile-XNAH-H9J1-0MQM-BK59 | Audit | | Analytics-Profile-I6DJ-RRQV-KQ5Z-HY7J | Event + System | | Analytics-Profile-V613-KAI2-4N49-MTL6 | Audit + Event + System | | Analytics-Profile-SXSR-UCDA-JJDS-1Q3K | Audit + Event | | Analytics-Profile-CHM8-D0PC-58BW-I8GI | System | +---------------------------------------+------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc analytics-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile create](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc analytics-profile update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc analytics-profile update :::Paragraph{indent="1"} Updates an analytics profile resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc analytics-profile update id profile-id [logs-to-export log-list] [tag value] [txn-export Boolean] ``` ### Parameters ```bash id profile-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the analytics profile, either its tag or UUID. ::: ```bash logs-to-export ``` :::Paragraph{indent="1"} A comma-separated list of identifiers for log-export resources. By default, this list can include the following log-export resources: ::: :::Paragraph{listStyleType="disc" indent="3"} `Audit Log` ::: :::Paragraph{listStyleType="disc" indent="3"} `Application Firewall` ::: :::Paragraph{listStyleType="disc" indent="3"} `Process Monitor` ::: :::Paragraph{listStyleType="disc" indent="3"} `Admin Server Access` ::: :::Paragraph{listStyleType="disc" indent="3"} `System - syslog` ::: :::Paragraph{listStyleType="disc" indent="3"} `Event Log` ::: :::Paragraph{listStyleType="disc" indent="3"} `Routing Software` ::: :::Paragraph{listStyleType="disc" indent="3"} `Data Plane Acceleration` ::: :::Paragraph{listStyleType="disc" indent="3"} `System - authentication log` ::: :::Paragraph{indent="1"} For example: "Audit Log","Event Log","System - authentication log" ::: :::Paragraph{indent="1"} For details of these logs, see the Virtual Traffic Manager documentation. ::: ```bash tag ``` :::Paragraph{indent="1"} The customer-facing name for the analytics-profile resource. If this is not set, the tag is set to the UUID value for the resource. ::: ```bash txn-export ``` :::Paragraph{indent="1"} If true, the analytics profile will record that transaction data is enabled. This ensures that any vTM configured using this profile will transmit transaction data (in addition to its assigned logs) to its assigned endpoint. ::: ### Examples ```bash *** list all analytics profiles *** amnesiac (config) # ssc analytics-profile list +---------------------------------------+------------------------+ | ID | Tag | +---------------------------------------+------------------------+ | Analytics-Profile-6IQG-F6UQ-8C11-7G8F | Audit + System | | Analytics-Profile-F5V3-S912-G3UP-HPNR | Event | | Analytics-Profile-XNAH-H9J1-0MQM-BK59 | Audit | | Analytics-Profile-I6DJ-RRQV-KQ5Z-HY7J | Event + System | | Analytics-Profile-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 :::Paragraph{indent="1"} [show ssc analytics-profile](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile create](docId\:Daj0PxouZD3s712K5TKUW), [ssc analytics-profile delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc analytics-profile list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc app-template import :::Paragraph{indent="1"} Import an application template (a .ZIP file) into Services Director. ::: ### Syntax ```bash ssc app-template import template-url URL ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no ssc app-template** command deletes an imported application template. ::: ### Parameters ```bash URL ``` :::Paragraph{indent="1"} URL of the application template. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc app-template ](docId\:Daj0PxouZD3s712K5TKUW), [show ssc app-template-instance](docId\:Daj0PxouZD3s712K5TKUW), [ssc app-template list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc app-template list :::Paragraph{indent="1"} Lists all application template resources. ::: ### Syntax ```bash ssc app-template list ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no ssc app-template** command deletes an imported application template. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc app-template ](docId\:Daj0PxouZD3s712K5TKUW), [show ssc app-template-instance](docId\:Daj0PxouZD3s712K5TKUW), [ssc app-template import](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc app-template-instance create :::Paragraph{indent="1"} Instantiate a named application template instance, performing both of the following actions: ::: :::Paragraph{listStyleType="disc" indent="2"} Creates a template instance on Services Director. ::: :::Paragraph{listStyleType="disc" indent="2"} Applies the configuration of the template instance to the specified vTM cluster. ::: ### Syntax ```bash ssc app-template-instance create template-instance-name instance-name template-name template-id cluster-id cluster-id parameters parameters ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no ssc app-template-instance** command deletes a template instance. ::: ### Parameters ```bash instance-name ``` :::Paragraph{indent="1"} Specify a new name for the application template instance. ::: ```bash template-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the application template, either its tag or UUID. ::: ```bash cluster-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the vTM cluster, either its tag or UUID. ::: ```bash parameters ``` :::Paragraph{indent="1"} A list of all parameters for the selected application template. ::: :::hint{type="info"} 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 ```bash *** 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 :::Paragraph{indent="1"} [show ssc app-template ](docId\:Daj0PxouZD3s712K5TKUW), [show ssc app-template-instance](docId\:Daj0PxouZD3s712K5TKUW), [ssc app-template import](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc app-template-instance list :::Paragraph{indent="1"} 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 ```bash ssc app-template-instance list ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no ssc app-template-instance** command deletes a template instance. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc app-template ](docId\:Daj0PxouZD3s712K5TKUW), [show ssc app-template-instance](docId\:Daj0PxouZD3s712K5TKUW), [ssc app-template import](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc app-template-instance update :::Paragraph{indent="1"} Update an application template instance, and re-apply it to the vTM cluster. ::: :::hint{type="info"} You cannot update the selected vTM cluster using this command. Instead, you should create a new template instance, see [ssc app-template-instance create](docId\:LLjz7el7U_q1thWAbTl0A). ::: ### Syntax ```bash ssc app-template-instance update template-instance-name instance-name template-name template-name parameters parameters ``` ### Parameters ```bash instance-name ``` :::Paragraph{indent="1"} Specify a new name for the application template instance. ::: ```bash template-name ``` :::Paragraph{indent="1"} Specify a unique identifier for the application template, either its tag or UUID. ::: ```bash parameters ``` :::Paragraph{indent="1"} A formatted list of all parameters for the selected application template. ::: :::hint{type="info"} 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 ```bash *** 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 :::Paragraph{indent="1"} [show ssc app-template ](docId\:Daj0PxouZD3s712K5TKUW), [show ssc app-template-instance](docId\:Daj0PxouZD3s712K5TKUW), [ssc app-template import](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc app-template-instance list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va config clear :::Paragraph{indent="1"} Clears the backup service configuration for the Services Director. The configuration of the remote system is unaffected. ::: ### Syntax ```bash ssc backup sd-va config clear ``` ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va config create :::Paragraph{indent="1"} 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 ```bash 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 frequency ``` ### Parameters ```bash remote-sys profile-id ``` :::Paragraph{indent="1"} IP address of the remote system. ::: ```bash remote-sys-path path ``` :::Paragraph{indent="1"} Remote directory for backup files. For example, "/var/home/root". ::: ```bash remote-sys-user user ``` :::Paragraph{indent="1"} Remote username. ::: ```bash remote-sys-pass password ``` :::Paragraph{indent="1"} Password for the remote user. ::: ```bash backup-data-trans protocol ``` :::Paragraph{indent="1"} The protocol to perform the remote transfer ("scp" or "ftp"). 2 ::: ```bash backup-freq frequency ``` :::Paragraph{indent="1"} The backup frequency (to local), expressed as a number of units. Units are days (d), hours (h) and minutes (m). For example, "6h" represents six hours. ::: ```bash backup-retain number ``` :::Paragraph{indent="1"} The number of local backup files to be retained. For example, 3. ::: ```bash remote-sync-freq frequency ``` :::Paragraph{indent="1"} The synchronization frequency (local to remote), expressed as a number of units. Units are days (d), hours (h) and minutes (m). For example, "2d" represents two days. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va config update :::Paragraph{indent="1"} Updates the backup service configuration for the Services Director. ::: ### Syntax ```bash 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 ```bash remote-sys ``` :::Paragraph{indent="1"} IP address of the remote system. ::: ```bash remote-sys-path ``` :::Paragraph{indent="1"} Remote directory for backup files. For example, "/var/home/root". ::: ```bash remote-sys-user ``` :::Paragraph{indent="1"} Remote username. ::: ```bash remote-sys-pass ``` :::Paragraph{indent="1"} Password for the remote user. ::: ```bash backup-data-trans ``` :::Paragraph{indent="1"} The protocol to perform the transfer to the remote system ("scp" or "ftp"). 2 ::: ```bash backup-freq ``` :::Paragraph{indent="1"} The backup frequency (to local), expressed as a number of units. Units are days (d), hours (h) and minutes (m). For example, "6h" represents six hours. ::: ```bash backup-retain ``` :::Paragraph{indent="1"} The number of local backup files to be retained. For example, 3. ::: ```bash remote-sync-freq ``` :::Paragraph{indent="1"} The synchronization frequency (local to remote), expressed as a number of units. Units are days (d), hours (h) and minutes (m). For example, "2d" represents two days. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va restore local :::Paragraph{indent="1"} Restores the Services Director using a local backup file (created by the Services Director backup service). ::: ### Syntax ```bash ssc backup sd-va restore local backup-name filename master-password password ``` ### Parameters ```bash backup-name filename ``` :::Paragraph{indent="1"} Specify a backup file from the local backup configuration. ::: ```bash master-password password ``` :::Paragraph{indent="1"} Specify the master password that was current when the backup was made. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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 ```bash 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.tgz ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va restore remote :::Paragraph{indent="1"} Restores the Services Director from a remote backup file. ::: ### Syntax ```bash ssc backup sd-va restore remote backup-name filename master-password password ``` ### Parameters ```bash backup-name filename ``` :::Paragraph{indent="1"} A backup file from the remote backup configuration. ::: ```bash master-password password ``` :::Paragraph{indent="1"} Specify the master password that was current when the backup was made. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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 ```bash 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.tgz ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va restore remotecfg clear :::Paragraph{indent="1"} Clears the remote system definition that is used to restore a Services Director. ::: ### Syntax ```bash ssc backup sd-va restore remotecfg clear ``` ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va restore remotecfg create :::Paragraph{indent="1"} Specifies the remote system from which a restore of the Services Director is performed. ::: ### Syntax ```bash 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 ```bash remote-sys ``` :::Paragraph{indent="1"} IP address of the remote system. ::: ```bash remote-sys-path ``` :::Paragraph{indent="1"} Remote directory for backup files. For example, "/var/home/root". ::: ```bash remote-sys-user ``` :::Paragraph{indent="1"} Remote username. ::: ```bash remote-sys-pass ``` :::Paragraph{indent="1"} Password for the remote user. ::: ```bash backup-data-trans ``` :::Paragraph{indent="1"} The protocol to perform the transfer from the remote system ("scp" or "ftp"). ::: ### Usage Guidelines :::Paragraph{indent="1"} The restore process itself is performed using [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A). ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va restore remotecfg update :::Paragraph{indent="1"} Updates the remote system configuration from which a restore of the Services Director is performed. ::: ### Syntax ```bash 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 ```bash remote-sys ``` :::Paragraph{indent="1"} IP address of the remote system. ::: ```bash remote-sys-path ``` :::Paragraph{indent="1"} Remote directory for backup files. For example, "/var/home/root". ::: ```bash remote-sys-user ``` :::Paragraph{indent="1"} Remote username. ::: ```bash remote-sys-pass ``` :::Paragraph{indent="1"} Password for the remote user. ::: ```bash backup-data-trans ``` :::Paragraph{indent="1"} The protocol to perform the transfer from the remote system ("scp" or "ftp"). ::: ### Usage Guidelines :::Paragraph{indent="1"} The restore process itself is performed using [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A). ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va service enable :::Paragraph{indent="1"} Enables the backup service for the Services Director. ::: ### Syntax ```bash ssc backup sd-va service enable ``` ### Usage Guidelines :::Paragraph{indent="1"} Use the **no ssc backup sd-va service** command to disable the backup service. ::: ### Examples ```bash *** 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 disabled ``` ### Related Commands :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service status](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup sd-va service status :::Paragraph{indent="1"} Displays the status of the backup service for the Services Director. ::: ### Syntax ```bash ssc backup sd-va service status ``` ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc backup sd-va config](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup sd-va config clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va config create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore local](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remote](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg clear](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va restore remotecfg update](docId\:LLjz7el7U_q1thWAbTl0A), [ssc backup sd-va service enable](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup vtm-cluster cluster-name backup now :::Paragraph{indent="1"} Performs an immediate backup for the specified cluster. ::: ### Syntax ```bash ssc backup vtm-cluster cluster-name cluster-id backup now ``` ### Parameters ```bash cluster-id ``` :::Paragraph{indent="1"} Specify the name of the required cluster. ::: ### Usage Guidelines :::Paragraph{indent="1"} The cluster must have a defined backup schedule for this command to succeed. ::: :::Paragraph{indent="1"} When this command is used, a task is created to perform the backup. ::: :::Paragraph{indent="1"} Use the **show ssc backup vtm-cluster cluster-name \ task \** command to check the status of the backup task. ::: ### Examples ```bash 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 task " +---------------+---------------------------------------+ | 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 :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc backup vtm-cluster cluster-name restore backup-name :::Paragraph{indent="1"} For a specified cluster, restores an existing backup from that cluster. ::: ### Syntax ```bash ssc backup vtm-cluster cluster-name source_cluster-id restore backup-name backup_id target-cluster target_cluster_id ``` ### Parameters ```bash source_cluster-id ``` :::Paragraph{indent="1"} Specify the name of the cluster from which the backup was taken. ::: ```bash backup_id ``` :::Paragraph{indent="1"} Specify the name of the required backup. ::: ```bash target_cluster-id ``` :::Paragraph{indent="1"} Specify the name of the cluster upon which the backup will be used. ::: ### Usage Guidelines :::Paragraph{indent="1"} When this command is used, a task is created to perform the restore. ::: :::Paragraph{indent="1"} Use the **show ssc backup vtm-cluster cluster-name \ task \** command to check the status of the restore task. ::: ### Examples ```bash 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 task " +---------------+---------------------------------------+ | 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 :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc backup vtm-cluster cluster-name task retry :::Paragraph{indent="1"} Re-attempt a failed backup task. ::: ### Syntax ```bash ssc backup vtm-cluster cluster-name cluster-id task task_id retry ``` ### Parameters ```bash cluster-id ``` :::Paragraph{indent="1"} Specify the name of the cluster upon which the failed task was performed. ::: ```bash task_id ``` :::Paragraph{indent="1"} Specify the name of the failed task. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **show ssc backup vtm-cluster cluster-name \ task \ **command to check the progress of the task. ::: :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster cluster-name \ task \** command to delete a failed task if required. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name tasks](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc backup vtm-cluster cluster-name upload backup-name :::Paragraph{indent="1"} Transfers a backup file (in TAR format) to a specified Traffic Manager instance. This file is not used in any way. ::: ### Syntax ```bash ssc backup vtm-cluster cluster-name source_cluster-id upload backup-name backup_id target-cluster target_cluster_id target-vTM instance_id ``` ### Parameters ```bash source_cluster-id ``` :::Paragraph{indent="1"} Specify the name of the cluster from which the backup was taken. ::: ```bash backup_id ``` :::Paragraph{indent="1"} Specify the name of the required backup. ::: ```bash target_cluster-id ``` :::Paragraph{indent="1"} Specify the name of the cluster upon which the backup will be used. ::: ```bash instance_id ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager instance to which the backup file (in TAR format) will be loaded. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} When this command is used, a task is created to perform the restore. ::: :::Paragraph{indent="1"} Use the **show ssc backup vtm-cluster cluster-name \ task \** command to check the status of the restore task. ::: ### Examples ```bash 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 task " +---------------+---------------------------------------+ | 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 :::Paragraph{indent="1"} [show ssc backup vtm-cluster cluster-name backups](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc backup vtm-cluster create schedule :::Paragraph{indent="1"} Creates a backup schedule. ::: ### Syntax ```bash ssc backup vtm-cluster create schedule schedule_id frequency frequency [offset offset] [backup_time time] [info description] ``` ### Parameters ```bash schedule_id ``` :::Paragraph{indent="1"} Specify a unique name for the required backup schedule. ::: ```bash frequency frequency ``` :::Paragraph{indent="1"} Specify the basic frequency of the backup. ::: :::Paragraph{listStyleType="disc" indent="3"} daily: A daily frequency. This requires a backup\_time but not an offset. ::: :::Paragraph{listStyleType="disc" indent="3"} hourly: An hourly frequency. This requires an offset but not a backup\_time. ::: :::Paragraph{listStyleType="disc" indent="3"} monthly: A monthly frequency. This requires both an offset and a backup\_time. ::: :::Paragraph{listStyleType="disc" indent="3"} weekly: A weekly frequency. This requires both an offset and a backup\_time. ::: :::Paragraph{listStyleType="disc" indent="3"} user\_defined: A customized frequency. This requires an offset but not a backup\_time. ::: ```bash backup_time time ``` :::Paragraph{indent="1"} Specify the backup time (HH\:MM) for the schedule. This is supported for daily, weekly and monthly schedules only. ::: ```bash offset ``` :::Paragraph{indent="1"} Specify an offset for the selected frequency type, which more closely specifies the point at which the backup will be taken: ::: :::Paragraph{listStyleType="disc" indent="3"} For daily schedules, no offset is supported. ::: :::Paragraph{listStyleType="disc" indent="3"} For an hourly schedule, the offsets represent every quarter of an hour, expressed as minutes. That is: 0, 15, 30 and 45. ::: :::Paragraph{listStyleType="disc" indent="3"} For monthly schedules, the offset is the day number on which the backup should be taken. This is limited to between 1 and 28. ::: :::Paragraph{listStyleType="disc" indent="3"} 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. ::: :::Paragraph{listStyleType="disc" indent="3"} For user defined schedules, various offsets are available: 15min, hour, 12hour, week, month. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify a description for the schedule. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster create schedule \** command to delete a specified schedule. You cannot delete a schedule that is in use. ::: :::Paragraph{indent="1"} Once the schedule is created, you can associate it with one or more clusters using the **ssc cluster create cluster-name \ schedule \** command. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup vtm-cluster update schedule](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cluster update cluster-name](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc backup vtm-cluster update schedule :::Paragraph{indent="1"} Updates a backup schedule. ::: ### Syntax ```bash ssc backup vtm-cluster update schedule schedule_id [new_name new_schedule_id] [frequency frequency] [offset offset] [backup_time time] [info description] ``` ### Parameters ```bash schedule_id ``` :::Paragraph{indent="1"} Specify the required backup schedule. ::: ```bash new_name new_schedule_id ``` :::Paragraph{indent="1"} Optionally, specify a new name for the schedule. This is supported for all schedules. ::: ```bash frequency frequency ``` :::Paragraph{indent="1"} Optionally, specify a new frequency for the backup. ::: :::Paragraph{listStyleType="disc" indent="3"} daily: A daily frequency. This requires a backup\_time but not an offset. ::: :::Paragraph{listStyleType="disc" indent="3"} hourly: An hourly frequency. This requires an offset but not a backup\_time. ::: :::Paragraph{listStyleType="disc" indent="3"} monthly: A monthly frequency. This requires both an offset and a backup\_time. ::: :::Paragraph{listStyleType="disc" indent="3"} weekly: A weekly frequency. This requires both an offset and a backup\_time. ::: :::Paragraph{listStyleType="disc" indent="3"} user\_defined: A customized frequency. This requires an offset but not a backup\_time. ::: ```bash backup_time time ``` :::Paragraph{indent="1"} Optionally, specify a new backup time (HH\:MM) for the schedule. This is supported for daily, weekly and monthly schedules only. ::: ```bash offset ``` :::Paragraph{indent="1"} Optionally, specify a new offset for the selected frequency type, which more closely specifies the point at which the backup will be taken: ::: :::Paragraph{listStyleType="disc" indent="3"} For daily schedules, no offset is supported. ::: :::Paragraph{listStyleType="disc" indent="3"} For an hourly schedule, the offsets represent every quarter of an hour, expressed as minutes. That is: 0, 15, 30 and 45. ::: :::Paragraph{listStyleType="disc" indent="3"} For monthly schedules, the offset is the day number on which the backup should be taken. This is limited to between 1 and 28. ::: :::Paragraph{listStyleType="disc" indent="3"} 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. ::: :::Paragraph{listStyleType="disc" indent="3"} For user defined schedules, various offsets are available: 15min, hour, 12hour, week, month. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify a new description for the schedule. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no ssc backup vtm-cluster create schedule \** command to delete a specified schedule. You cannot delete a schedule that is in use. ::: :::Paragraph{indent="1"} You can associate a schedule with one or more clusters using the **ssc cluster create cluster-name \ schedule \ **command. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup vtm-cluster update schedule](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cluster update cluster-name](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssh client generate identity user :::Paragraph{indent="1"} Generates SSH client identity keys for the specified user. SSH provides secure log in for Windows and UNIX clients and servers. ::: ### Syntax ```bash ssh client generate identity user user ``` ### Parameters ```bash user ``` :::Paragraph{indent="1"} Specify the client user login. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no ssh client identity user \** command disables SSH client identity keys for a specified user. ::: ### Examples ```bash amnesiac (config) # ssh client generate identity user test ``` ### Related Commands :::Paragraph{indent="1"} [show ssh client](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### ssh client user authorized-key key sshv2 :::Paragraph{indent="1"} Sets the RSA encryption method by RSA Security and authorized-key for the SSH user. ::: ### Syntax ```bash [no] ssh client user user authorized-key key sshv2 public-key ``` ### Parameters ```bash user ``` :::Paragraph{indent="1"} Specify the user name. Must be an existing local user. ::: ```bash public-key ``` :::Paragraph{indent="1"} Specify the public key for SSH version 2 for the specified SSH user. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the authorized-key encryption method. ::: ### Examples ```bash amnesiac (config) # ssh client user admin authorized-key key sshv2 MyPublicKey ``` ### Related Commands :::Paragraph{indent="1"} [show ssh client](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### ssc cloud-reg create :::Paragraph{indent="1"} Creates a cloud registration resource on the Services Director. This is required during automated self-registration of vTMs. ::: ### Syntax ```bash ssc cloud-reg create reg-policy registration-policy [e-mail email-address] [owner owner] [[tag name] ``` ### Parameters ```bash reg-policy registration-policy ``` :::Paragraph{indent="1"} Select 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. ::: ```bash e-mail email-address ``` :::Paragraph{indent="1"} Optionally, specify a valid e-mail address that will be used to contact an administrator if required. ::: ```bash owner ``` :::Paragraph{indent="1"} Specify 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. ::: ```bash tag ``` :::Paragraph{indent="1"} Optionally, enter a unique name for the cloud registration resource. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} You cannot update a cloud registration resource once it is created. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc cloud-reg](docId\:Daj0PxouZD3s712K5TKUW), [show ssc cloud-reg user-data id](docId\:Daj0PxouZD3s712K5TKUW), [ssc cloud-reg delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cloud-reg list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc cloud-reg delete :::Paragraph{indent="1"} Deletes a cloud registration resource on the Services Director. ::: ### Syntax ```bash ssc cloud-reg delete id cloud-reg-id ``` ### Parameters ```bash id cloud-reg-id ``` :::Paragraph{indent="1"} Select a cloud-registration resource that you want to delete. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc cloud-reg](docId\:Daj0PxouZD3s712K5TKUW), [show ssc cloud-reg user-data id](docId\:Daj0PxouZD3s712K5TKUW), [ssc cloud-reg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cloud-reg list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc cloud-reg list :::Paragraph{indent="1"} Displays a list of cloud registration resources on the Services Director. ::: ### Syntax ```bash ssc cloud-reg list ``` ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc cloud-reg](docId\:Daj0PxouZD3s712K5TKUW), [show ssc cloud-reg user-data id](docId\:Daj0PxouZD3s712K5TKUW), [ssc cloud-reg create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cloud-reg delete](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc cluster create cluster-name :::Paragraph{indent="1"} Creates a User Created Services Director cluster. ::: ### Syntax ```bash [no] ssc cluster create cluster-name name [schedule schedule_id] [owner cluster-owner] [analytics-profile profile-id] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the cluster. ::: ```bash schedule schedule_id ``` :::Paragraph{indent="1"} Optionally, specify an existing backup schedule for the cluster. ::: ```bash owner owner ``` :::Paragraph{indent="1"} Optionally, specify an owner for the cluster. ::: ```bash analytics-profile profile-id ``` :::Paragraph{indent="1"} Optionally, specify an analytics profile for the cluster. ::: ### Usage Guidelines :::Paragraph{indent="1"} This cluster is available for use by deployed vTMs only. ::: :::Paragraph{indent="1"} You cannot create a Discovered cluster using the CLI. ::: :::Paragraph{indent="1"} To delete an empty cluster, use the **no ssc cluster cluster-name** command. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc cluster cluster-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW), [ssc cluster list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cluster update cluster-name](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc cluster create template-name :::Paragraph{indent="1"} Creates a User Created Services Director cluster based on a specified template. ::: ### Syntax ```bash ssc cluster create template-name name [cluster-name cluster-id] [owner owner-id] [schedule schedule-id] ``` ### Parameters ```bash template-name name ``` :::Paragraph{indent="1"} Identify the template you want to use. ::: ```bash cluster-name cluster-id ``` :::Paragraph{indent="1"} (Optional) Specify a cluster name. This will be used in preference to any template value. ::: ```bash owner owner-id ``` :::Paragraph{indent="1"} (Optional) Specify an owner for the cluster. This will be used in preference to any template value. ::: ```bash schedule schedule-id ``` :::Paragraph{indent="1"} (Optional) Specify a backup schedule for the cluster. This will be used in preference to any template value. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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). ::: :::Paragraph{indent="1"} This cluster is available for use by deployed vTMs only. ::: :::Paragraph{indent="1"} You cannot create a Discovered cluster using the CLI. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc cluster cluster-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW), [ssc cluster update template-name](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc cluster list :::Paragraph{indent="1"} Lists current clusters. This includes both Discovered and User Created clusters. ::: ### Syntax ```bash ssc cluster list ``` ### Examples ```bash amnesiac (config) # ssc cluster list +-----------------------------+ | Cluster | +-----------------------------+ | TK-327 | | Violet-Cluster | | TK-421 | | Cluster-A1BQ-V577-V8NY-UIDZ | +-----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc cluster cluster-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW), [ssc cluster create cluster-name](docId\:LLjz7el7U_q1thWAbTl0A), [ssc cluster update cluster-name](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc cluster update cluster-name :::Paragraph{indent="1"} Updates a Services Director cluster. ::: ### Syntax ```bash ssc cluster update cluster-name name [schedule schedule_id] [new-cluster-name name] [status [Active | Inactive]] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the cluster name. ::: ```bash new-cluster-name ``` :::Paragraph{indent="1"} Specify a new tag for the cluster. ::: ```bash schedule ``` :::Paragraph{indent="1"} Specify a backup schedule for the cluster. ::: ```bash status [Active | Inactive] ``` :::Paragraph{indent="1"} Specify the status of the cluster: ::: :::Paragraph{listStyleType="disc" indent="3"} Active: Activates the cluster. ::: :::Paragraph{listStyleType="disc" indent="3"} 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. ::: ```bash analytics-profile ``` :::Paragraph{indent="1"} (Discovered clusters only) Specify an analytics profile for the cluster, using its tag or UUID. See also Usage Guidelines. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the ssc cluster update cluster-name \ schedule null command to detach delete the specified schedule. ::: :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} Updating the selected analytics profile for a cluster will change the analytics configuration of all vTMs in the cluster. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc cluster cluster-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc backup vtm-cluster schedules](docId\:Daj0PxouZD3s712K5TKUW), [ssc backup vtm-cluster create schedule](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc cluster update template-name :::Paragraph{indent="1"} Updates a Services Director cluster based on the specified template. ::: ### Syntax ```bash ssc cluster update template-name template-name [new-cluster-name name] [schedule backup-schedule-id] [analytics-profile profile-id] ``` ### Parameters ```bash template-name ``` :::Paragraph{indent="1"} Specify the template you want to use. ::: ```bash new-cluster-name ``` :::Paragraph{indent="1"} Specify a new tag for the cluster. This will be used in preference to any template value. ::: ```bash schedule ``` :::Paragraph{indent="1"} Specify a backup schedule for the cluster. This will be used in preference to any template value. ::: ```bash analytics-profile ``` :::Paragraph{indent="1"} (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 :::Paragraph{indent="1"} 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). ::: :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} Updating the selected analytics profile for a cluster will change the analytics configuration of all vTMs in the cluster. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc cluster cluster-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc collection-endpoint create :::Paragraph{indent="1"} Creates a new Collection Endpoint resource. This resource is used for vTM analytics. ::: ### Syntax ```bash 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 ```bash txn-export-address ``` :::Paragraph{indent="1"} The address that transaction data is exported to, in the form \:\. ::: :::Paragraph{indent="1"} For example: demo.com:7090 ::: ```bash txn-tls ``` :::Paragraph{indent="1"} Indicates whether transaction data requires secure transmission. If true, you must also specify txn-export-cert, and you can optionally specify txn-tls-verify. ::: ```bash log-export-address ``` :::Paragraph{indent="1"} The address that log data is exported to, in the form \\:\\, where \ can be either http\:// or https\://. ::: :::Paragraph{indent="1"} For example: http\://demo.com:8080/logs/collector. ::: :::Paragraph{indent="1"} If protocol is set to https\://, you must also specify log-export-cert. ::: ```bash auth-type value ``` :::Paragraph{indent="1"} The required authorization. This can be set to: ::: :::Paragraph{listStyleType="disc" indent="3"} "None": This indicates no authorization is required. ::: :::Paragraph{listStyleType="disc" indent="3"} "Basic": This indicates that basic HTTP authorization is required. You must also specify auth-username and auth-password. ::: :::Paragraph{listStyleType="disc" indent="3"} "Splunk": This indicates that authorization is performed on the Splunk®1platform. You must also specify auth-token. ::: ```bash auth-username ``` :::Paragraph{indent="1"} The username for HTTP Basic authentication. This is required when auth-type is Basic. ::: ```bash auth-password ``` :::Paragraph{indent="1"} The password for HTTP Basic authentication. This is required when auth-type is Basic. ::: ```bash auth-token ``` :::Paragraph{indent="1"} The HEC authorization token required by the Splunk platform. This is required when auth-type is "Splunk". ::: ```bash txn-tls-verify ``` :::Paragraph{indent="1"} (Optional) If true, indicates that verification of the secure connection to the transaction collection endpoint is required. ::: ```bash log-tls-verify ``` :::Paragraph{indent="1"} (Optional) If true, indicates that verification of the secure connection to the log collection endpoint is required. ::: ```bash txn-export-cert ``` :::Paragraph{indent="1"} The certificate of the transaction export collection endpoint. This is required if txn-tls is true. ::: ```bash log-export-cert ``` :::Paragraph{indent="1"} The certificate of the log export collection endpoint. This is required if the \ in log-export-address is https\://. ::: ```bash name ``` :::Paragraph{indent="1"} (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 :::Paragraph{indent="1"} This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [show ssc collection-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc collection-endpoint delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc collection-endpoint delete :::Paragraph{indent="1"} Delete a Collection Endpoint resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc collection-endpoint delete name endpoint-id ``` ### Parameters ```bash name endpoint-id ``` :::Paragraph{indent="1"} The identifier for the collection endpoint resource, either its** tag** or its UUID. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command. ::: ### Examples ```bash *** list all collection endpoints *** amnesiac (config) # ssc collection-endpoint list +-----------------------------------------+------------------+ | ID | Tag | +-----------------------------------------+------------------+ | Collection-Endpoint-4N4H-0NL1-T02T-PZZ7 | JK-Collection-04 | | Collection-Endpoint-9D37-B16X-75XG-3K8W | JK-Collection-01 | | Collection-Endpoint-1EGK-KLKN-R6RB-JDLK | JK-Collection-02 | | Collection-Endpoint-U3FX-MTKU-WSY6-WZ99 | JK-Collection-03 | | 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 :::Paragraph{indent="1"} [show ssc collection-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc collection-endpoint create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc collection-endpoint list :::Paragraph{indent="1"} Lists all Collection Endpoint resources. These resources are used for vTM analytics. ::: ### Syntax ```bash ssc collection-endpoint list ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc collection-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc collection-endpoint create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc collection-endpoint update :::Paragraph{indent="1"} Updates a Collection Endpoint resource. This resource is used for vTM analytics. ::: ### Syntax ```bash 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 ```bash name ``` :::Paragraph{indent="1"} Specify a unique identifier for the collection endpoint, either its tag or UUID. ::: ```bash txn-export-address ``` :::Paragraph{indent="1"} The address that transaction data is exported to, in the form \:\. ::: :::Paragraph{indent="1"} For example: demo.com:7090 ::: ```bash txn-tls ``` :::Paragraph{indent="1"} Indicates whether transaction data requires secure transmission. If true, txn-export-cert is required, and txn-tls-verify is optional. ::: ```bash log-export-address ``` :::Paragraph{indent="1"} The address that log data is exported to, in the form \\:\\, where \ can be either http\:// or https\://. ::: :::Paragraph{indent="1"} For example: http\://demo.com:8080/logs/collector. ::: :::Paragraph{indent="1"} If protocol is set to https\://, **log-export-cert** is required. ::: ```bash auth-type ``` :::Paragraph{indent="1"} The required authorization. This can be set to: ::: :::Paragraph{listStyleType="disc" indent="3"} "None": This indicates no authorization is required. ::: :::Paragraph{listStyleType="disc" indent="3"} "Basic": This indicates that basic HTTP authorization is required. If used, auth-username and auth-password are required. ::: :::Paragraph{listStyleType="disc" indent="3"} "Splunk": This indicates that authorization is performed on the Splunk platform. You must also specify auth-token. ::: ```bash auth-username ``` :::Paragraph{indent="1"} The username for HTTP Basic authentication. This is required when auth-type is "Basic". ::: ```bash auth-password ``` :::Paragraph{indent="1"} The password for HTTP Basic authentication. This is required when auth-type is "Basic". ::: ```bash auth-token ``` :::Paragraph{indent="1"} The HEC token from your Splunk platform. This is required when auth-type is "Splunk". ::: ```bash txn-tls-verify ``` :::Paragraph{indent="1"} If true, indicates that verification of the secure connection to the transaction collection endpoint is required. ::: ```bash log-tls-verify ``` :::Paragraph{indent="1"} If true, indicates that verification of the secure connection to the log collection endpoint is required. ::: ```bash txn-export-cert ``` :::Paragraph{indent="1"} The certificate of the transaction export collection endpoint. This is required if txn-tls is true. ::: ```bash log-export-cert ``` :::Paragraph{indent="1"} The certificate of the log export collection endpoint. This is required if the \ in log-export-address is https\://. ::: ```bash new-name ``` :::Paragraph{indent="1"} (Optional) A replacement name for the collection endpoint resource. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Collection Endpoint resources. Search Endpoint resources are handled separately, by an equivalent "search-endpoint" command. ::: ### Examples ```bash *** list all collection endpoints *** amnesiac (config) # ssc collection-endpoint list +-----------------------------------------+------------------+ | ID | Tag | +-----------------------------------------+------------------+ | Collection-Endpoint-4N4H-0NL1-T02T-PZZ7 | JK-Collection-04 | | Collection-Endpoint-9D37-B16X-75XG-3K8W | JK-Collection-01 | | Collection-Endpoint-1EGK-KLKN-R6RB-JDLK | JK-Collection-02 | | Collection-Endpoint-U3FX-MTKU-WSY6-WZ99 | JK-Collection-03 | | 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 :::Paragraph{indent="1"} [show ssc collection-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc collection-endpoint create](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint delete](docId\:LLjz7el7U_q1thWAbTl0A), [ssc collection-endpoint list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc database local bind-address :::Paragraph{indent="1"} Sets the local MySQL database bind address. ::: ### Syntax ```bash [no] ssc database local bind-address ip-addr ``` ### Parameters ```bash ip-addr ``` :::Paragraph{indent="1"} Specify the IP address. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no** command option to delete the bind address. ::: ### Examples ```bash amnesiac (config) # ssc database local bind-address 10.0.0.1 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database local](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database local db-file delete :::Paragraph{indent="1"} Deletes saved Services Director database file. ::: ### Syntax ```bash ssc database local db-file delete filename ``` ### Parameters ```bash filename ``` :::Paragraph{indent="1"} Specify the file name for the database. ::: ### Examples ```bash amnesiac (config) # ssc database local db-file delete dbtest ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database local](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database local db-file export :::Paragraph{indent="1"} Exports the Services Director database to a file. ::: ### Syntax ```bash ssc database local db-file export ``` ### Usage Guidelines :::Paragraph{indent="1"} The name of the exported file is calculated automatically using the following format: ::: ```bash sscdb_dump__.sql ``` ### Examples ```bash amnesiac (config) # ssc database local db-file export ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database local db-file](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database local db-file import :::Paragraph{indent="1"} Imports the Services Director database from a file. ::: ### Syntax ```bash ssc database local db-file import filename ``` ### Parameters ```bash filename ``` :::Paragraph{indent="1"} Specify the file name for the database. ::: ### Examples ```bash amnesiac (config) # ssc database local db-file import dbtest ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database local db-file](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database local port :::Paragraph{indent="1"} Sets the local MySQL database port. ::: ### Syntax ```bash [no] ssc database local port port ``` ### Parameters ```bash port ``` :::Paragraph{indent="1"} Specify the port for the database. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no** command option to delete the port. ::: ### Examples ```bash amnesiac (config) # ssc database local port 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database local db-file](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database local username :::Paragraph{indent="1"} Sets the local MySQL database username and password. ::: ### Syntax ```bash ssc database local username name password password ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the username for the local database. ::: ```bash password ``` :::Paragraph{indent="1"} Specify the password for the local database. ::: ### Examples ```bash amnesiac (config) # ssc database local username ssc password abcd1234 +-------------+-------------+ | DB Username | DB Password | +-------------+-------------+ | ssc | abcd1234 | +-------------+-------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database local credentials](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database remote address :::Paragraph{indent="1"} Sets the hostname or IP address of the remote database. ::: ### Syntax ```bash [no] ssc database remote address address ``` ### Parameters ```bash address ``` :::Paragraph{indent="1"} Specify the hostname or IP address of the remote database. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the** no** command option to delete the remote database address. ::: ### Examples ```bash *** 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.13 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database remote](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database remote db-user-name :::Paragraph{indent="1"} Sets the user with privileges for the remote database. ::: ### Syntax ```bash ssc database remote db-user-name name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the database user name. ::: ### Examples ```bash amnesiac (config) # ssc database remote db-user-name dbadmin ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database remote](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database remote db-user-pwd :::Paragraph{indent="1"} Sets the password for the user with privileges for the remote database. ::: ### Syntax ```bash ssc database remote db-user-pwd password ``` ### Parameters ```bash password ``` :::Paragraph{indent="1"} Specify the user password. ::: ### Examples ```bash amnesiac (config) # ssc database remote db-user-pwd db1234 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database remote](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database remote port :::Paragraph{indent="1"} Sets the remote database port. ::: ### Syntax ```bash [no] ssc database remote port port ``` ### Parameters ```bash port ``` :::Paragraph{indent="1"} Specify the port for the remote database. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no** command option to delete the remote port. ::: ### Examples ```bash amnesiac (config) # ssc database remote port 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database remote](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc database use-local :::Paragraph{indent="1"} Sets the Services Director to use the local MySQL database. ::: ### Syntax ```bash [no] ssc database use-local ``` ### Usage Guidelines :::Paragraph{indent="1"} Use the **no** command option to stop using the local MySQL database. ::: ### Examples ```bash amnesiac (config) # ssc database use-local ``` ### Related Commands :::Paragraph{indent="1"} [show ssc database remote](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc feature-pack create fpname :::Paragraph{indent="1"} Creates a Feature Pack resource for the Services Director. ::: ### Syntax ```bash 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 ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the Feature Pack. ::: ```bash skus ``` :::Paragraph{indent="1"} (For newer SKUs) Specify a base SKU and one or more additional SKUs. This is a comma-separated list enclosed in double quotes. ::: ```bash stm-sku ``` :::Paragraph{indent="1"} (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. ::: ```bash excluded list ``` :::Paragraph{indent="1"} (Optional) Specify a comma-separated list of features in double quote marks from the base SKU that are excluded. This includes: ::: :::Paragraph{listStyleType="disc" indent="3"} ts: Excludes TrafficScript ::: :::Paragraph{listStyleType="disc" indent="3"} comp: Excludes compression ::: :::Paragraph{listStyleType="disc" indent="3"} cache: Excludes caching ::: :::Paragraph{listStyleType="disc" indent="3"} glb: Excludes global load balancing ::: :::Paragraph{listStyleType="disc" indent="3"} bwm: Excludes bandwidth management classes ::: :::Paragraph{listStyleType="disc" indent="3"} rate: Excludes rate shaping classes ::: :::Paragraph{listStyleType="disc" indent="3"} slm: Excludes service level monitoring ::: :::Paragraph{listStyleType="disc" indent="3"} auto: Excludes autoscaling ::: :::Paragraph{listStyleType="disc" indent="3"} afm: Excludes use of SAF ::: :::Paragraph{listStyleType="disc" indent="3"} apt: Excludes use of Aptimizer. ::: :::Paragraph{indent="1"} 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. ::: ```bash add-on-skus ``` :::Paragraph{indent="1"} (Older base SKUs) Optionally, specify a list of feature SKUs to be associated with the stm-sku base SKU. This includes: ::: :::Paragraph{listStyleType="disc" indent="3"} ADD-FIPS: Federal Information Processing Standards (FIPs) ::: :::Paragraph{listStyleType="disc" indent="3"} ADD-WAF: Virtual Web Application Firewall ::: :::Paragraph{listStyleType="disc" indent="3"} ADD-WEBACCEL: Web Content Accelerator. ::: :::Paragraph{indent="1"} This list is a comma-separated list enclosed in double quote marks. ::: ```bash info ``` :::Paragraph{indent="1"} Optionally, specify information about the feature pack. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} The properties that you specify will depend on your base SKU: ::: :::Paragraph{listStyleType="disc" indent="2"} For older SKUs (such as STM-400), you specify the stm-sku and add-on-skus properties. ::: :::Paragraph{listStyleType="disc" indent="2"} 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 ```bash *** 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 :::Paragraph{indent="1"} [show ssc feature-pack fpname](docId\:Daj0PxouZD3s712K5TKUW), [ssc feature-pack list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc feature-pack update fpname](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc feature-pack create template-name :::Paragraph{indent="1"} Creates a feature pack based on an existing template. ::: ### Syntax ```bash ssc feature-pack create template-name name | [fpname name] | [stm-sku sku-name] | [excluded comma-separated-list] | [info description] | [add-on-skus name] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the feature pack template. ::: ```bash fpname name ``` :::Paragraph{indent="1"} Specify a unique name for the feature pack. ::: ```bash stm-sku sku-name ``` :::Paragraph{indent="1"} Specify the SKU Traffic Manager on which the feature pack is based. This is limited to SKUs compatible with your Services Director license. ::: ```bash excluded list] ``` :::Paragraph{indent="1"} Optionally, specify a list of features from the parent SKU that are excluded. These features include: ::: :::Paragraph{listStyleType="disc" indent="3"} afm: Excludes use of SAF. ::: :::Paragraph{listStyleType="disc" indent="3"} apt: Excludes use of Aptimizer ::: :::Paragraph{listStyleType="disc" indent="3"} auto: Excludes autoscaling ::: :::Paragraph{listStyleType="disc" indent="3"} bwm: Excludes bandwidth management classes ::: :::Paragraph{listStyleType="disc" indent="3"} comp: Excludes compression ::: :::Paragraph{listStyleType="disc" indent="3"} cache: Excludes caching ::: :::Paragraph{listStyleType="disc" indent="3"} glb: Excludes global load balancing ::: :::Paragraph{listStyleType="disc" indent="3"} rate: Excludes rate shaping classes ::: :::Paragraph{listStyleType="disc" indent="3"} slm: Excludes service level monitoring ::: :::Paragraph{listStyleType="disc" indent="3"} ts: Excludes TrafficScript ::: :::Paragraph{indent="1"} 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. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify information about the feature pack. ::: ```bash add-on-skus list ``` :::Paragraph{indent="1"} Optionally, specify a list of feature SKUs to be associated with the parent SKU: ::: :::Paragraph{listStyleType="disc" indent="3"} ADDFIPS: Federal Information Processing Standards (FIPs) ::: :::Paragraph{listStyleType="disc" indent="3"} ADDWAF: Virtual Web Application Firewall ::: :::Paragraph{listStyleType="disc" indent="3"} ADDWEBACCEL: Web Content Accelerator ::: :::Paragraph{indent="1"} This list is a comma-separated list enclosed in double quote marks. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} 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 ```bash amnesiac (config) # ssc feature-pack create template-name fptemp-1 fpname fp-1 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc feature-pack fpname](docId\:Daj0PxouZD3s712K5TKUW), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc feature-pack list :::Paragraph{indent="1"} Lists Services Director feature packs. ::: ### Syntax ```bash ssc feature-pack list ``` ### Examples ```bash amnesiac (config) # ssc feature-pack list +-------------------+ | FeaturePack | +-------------------+ | ENT-Analytics | | ENT-ADVANCED_full | +-------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc feature-pack fpname](docId\:Daj0PxouZD3s712K5TKUW), [ssc feature-pack create fpname](docId\:LLjz7el7U_q1thWAbTl0A), [ssc feature-pack update fpname](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc feature-pack update fpname :::Paragraph{indent="1"} Updates a Services Director feature pack. ::: ### Syntax ```bash ssc feature-pack update fpname name [info description] [status [Active | Inactive]] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Identify the Feature Pack using its tag or UUID. ::: ```bash info ``` :::Paragraph{indent="1"} Specify a description of the feature pack. ::: ```bash status ``` :::Paragraph{indent="1"} Specify the status: ::: :::Paragraph{listStyleType="disc" indent="3"} Active: Activates a resource. ::: :::Paragraph{listStyleType="disc" indent="3"} Inactive: Deactivates a resource. A resource cannot be marked as** Inactive** if it is in use. The resource cannot be reactivated. ::: ### Usage Guidelines :::Paragraph{indent="1"} You can update a limited number of Feature Pack properties. ::: :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} You cannot delete a Feature Pack. However, you can permanently set its status to Inactive. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc feature-pack fpname](docId\:Daj0PxouZD3s712K5TKUW), [ssc feature-pack create fpname](docId\:LLjz7el7U_q1thWAbTl0A), [ssc feature-pack list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc feature-pack update template-name :::Paragraph{indent="1"} Updates a Services Director feature pack based on the specified template. ::: ### Syntax ```bash ssc feature-pack update template-name name | [fpname name] | [info description] | [status Active | Inactive]] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash name ``` :::Paragraph{indent="1"} Specify the feature pack name. ::: ```bash info description ``` :::Paragraph{indent="1"} Specify information about the feature pack. ::: ```bash status ``` :::Paragraph{indent="1"} Specify the status: ::: :::Paragraph{listStyleType="disc" indent="3"} Active: Activates a resource. ::: :::Paragraph{listStyleType="disc" indent="3"} 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 :::Paragraph{indent="1"} 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 ```bash amnesiac (config) # ssc feature-pack update template-name fptemp fpname fp1 status Inactive ``` ### Related Commands :::Paragraph{indent="1"} [show ssc feature-pack fpname](docId\:Daj0PxouZD3s712K5TKUW), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc high-avail certificate :::Paragraph{indent="1"} Displays the high availability certificate for a high availability node. ::: ### Syntax ```bash ssc high-avail certificate host-or-ip-addr ``` ### Parameters ```bash host-or-ip-addr ``` :::Paragraph{indent="1"} Specify the host name or IP address of a high availability node. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is identical to the [show ssc high-avail list](docId\:Daj0PxouZD3s712K5TKUW) command. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [show ssc feature-pack fpname](docId\:Daj0PxouZD3s712K5TKUW), [ssc feature-pack create fpname](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail file-replication reset :::Paragraph{indent="1"} Resets the file replication service for the current HA pair. ::: ### Syntax ```bash ssc high-avail file-replication reset ``` ### Examples ```bash amnesiac (config) # ssc high-avail file-replication reset ``` ### Related Commands :::Paragraph{indent="1"} [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail create :::Paragraph{indent="1"} 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 ```bash ssc high-avail create traffic-ip IP-or-hostname ``` ### Parameters ```bash traffic-ip ``` :::Paragraph{indent="1"} The IP address or host name of the required Service Endpoint Address. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command will be destructive to an HA pair if the current node is in an HA pair. ::: :::hint{type="info"} If you want to change the Standby node of an HA pair into an Active node, use the [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A) command. ::: :::Paragraph{indent="1"} This command completes in the background. Use [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A) to check its progress. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail diagnose :::Paragraph{indent="1"} Diagnoses causes for HA pair errors on the current node, and proposes available solutions. ::: ### Syntax ```bash ssc high-avail diagnose ``` ### Usage Guidelines :::Paragraph{indent="1"} This command can be run on either the Active or Standby nodes. The diagnostic inspects the states of the three modules: ::: :::Paragraph{listStyleType="disc" indent="2"} web service ::: :::Paragraph{listStyleType="disc" indent="2"} database ::: :::Paragraph{listStyleType="disc" indent="2"} filestore replication ::: :::Paragraph{indent="1"} Based on the health of each module, the diagnostic command returns an instruction set which the user can follow to troubleshoot the issues. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail discover :::Paragraph{indent="1"} Displays Primary Services Director nodes in the current subnet that do not belong to an HA pair. ::: ### Syntax ```bash ssc high-avail discover ``` ### Examples ```bash 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail eject :::Paragraph{indent="1"} Ejects a specified Standby node from the current HA pair. ::: ### Syntax ```bash ssc high-avail eject IP-or-hostname ``` ### Parameters ```bash IP-or-hostname ``` :::Paragraph{indent="1"} The IP address or host name of the Standby node to be ejected. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command must be used from the Active node. ::: :::Paragraph{indent="1"} Services Director supports a single Standby node. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail ejectall :::Paragraph{indent="1"} 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 ```bash ssc high-avail ejectall ``` ### Usage Guidelines :::Paragraph{indent="1"} This command must be used from the Active node. ::: :::Paragraph{indent="1"} Services Director supports a single Standby node. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail failover :::Paragraph{indent="1"} This command performs a failover from the Standby node of an HA pair. ::: ### Syntax ```bash ssc high-avail failover backup-node IP-or-hostname ``` ### Parameters ```bash backup-node IP-or-hostname ``` :::Paragraph{indent="1"} The IP address or host name of the Standby node. You must issue this command from this Standby node. ::: ### Usage Guidelines :::Paragraph{indent="1"} Both Active and Standby nodes must be healthy to perform a failover. ::: :::Paragraph{indent="1"} As a result of the failover: ::: :::Paragraph{listStyleType="disc" indent="2"} The current Active and Standby nodes will exchange roles. ::: :::Paragraph{listStyleType="disc" indent="2"} The new Active node takes control of the HA pair for all purposes. ::: :::Paragraph{listStyleType="disc" indent="2"} The SEA/TIP points to the now-Active node. ::: :::Paragraph{indent="1"} This command completes in the background. Use [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A) to check its progress. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail force-failover :::Paragraph{indent="1"} This command enables you to perform a failover operation from a healthy Standby node after the Active node becomes unhealthy. ::: ### Syntax ```bash ssc high-avail force-failover ``` ### Usage Guidelines :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} As a result of the forced failover: ::: :::Paragraph{listStyleType="disc" indent="2"} The current Standby nodes becomes the Active node. ::: :::Paragraph{listStyleType="disc" indent="2"} The SEA/TIP points to the now-Active node. ::: :::Paragraph{listStyleType="disc" indent="2"} 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. ::: :::hint{type="info"} See [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A) for details of the "split brain" scenario, and for instructions on how to recover from it. ::: :::Paragraph{indent="1"} This command completes in the background. Use [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A) to check its progress. ::: ### Examples :::Paragraph{indent="1"} In this example: ::: :::Paragraph{listStyleType="disc" indent="2"} The unhealthy Active node is amnesiac-01 (10.62.167.193). ::: :::Paragraph{listStyleType="disc" indent="2"} The healthy Standby node is amnesiac-02 (10.62.167.194) ::: :::Paragraph{listStyleType="disc" indent="2"} The Service Endpoint Address (TIP) is 10.62.167.195. ::: ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail force-standby :::Paragraph{indent="1"} Performs a forced standby of an Active node. ::: ### Syntax ```bash ssc high-avail force-standby ``` ### Usage Guidelines :::Paragraph{indent="1"} 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. ::: :::Paragraph{indent="1"} This scenario is possible after a failed force-failover command (see [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A)). ::: :::Paragraph{indent="1"} After this failure: ::: :::Paragraph{listStyleType="disc" indent="2"} 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. ::: :::Paragraph{listStyleType="disc" indent="2"} The original Standby node is now the healthy current Active node. ::: :::Paragraph{indent="1"} 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: ::: :::Paragraph{listStyleType="disc" indent="2"} Switches the original Active node to be the new Standby. ::: :::Paragraph{listStyleType="disc" indent="2"} The HA pair reforms. ::: :::Paragraph{indent="1"} This command completes in the background. Use [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A) to check its progress. ::: ### Examples :::Paragraph{indent="1"} In this example: ::: :::Paragraph{listStyleType="disc" indent="2"} The original Active node (which failed by is now repaired) is amnesiac-01 (10.62.167.193). ::: :::Paragraph{listStyleType="disc" indent="2"} The new Active node (the original Standby) is amnesiac-02 (10.62.167.194) ::: :::Paragraph{listStyleType="disc" indent="2"} The Service Endpoint Address (TIP) is 10.62.167.195. ::: ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail join :::Paragraph{indent="1"} Joins the current unpaired Services Director node to a specified Primary Services Director node. ::: ### Syntax ```bash ssc high-avail join IP-or-hostname ``` ### Parameters ```bash IP-or-hostname ``` :::Paragraph{indent="1"} The IP address or host name of the Primary node. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command initially reports that an attempt to join is in progress, but completes in the background. Use [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A) to check the progress of the join process. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail list :::Paragraph{indent="1"} Displays a list of nodes in the current HA pair. ::: ### Syntax ```bash ssc high-avail list ``` ### Usage Guidelines :::Paragraph{indent="1"} For a standalone Services Director, only one node is listed. ::: :::Paragraph{indent="1"} This command is identical to the [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW) command. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail reset :::Paragraph{indent="1"} Performs a factory reset on the current high availability node. This erases the entire HA configuration. ::: ### Syntax ```bash ssc high-avail reset ``` ### Usage Guidelines :::Paragraph{indent="1"} After this command completes, the Services Director must be restarted. ::: :::Paragraph{indent="1"} After using this command, you can use: ::: :::Paragraph{listStyleType="disc" indent="2"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A) to create a standalone node. ::: :::Paragraph{listStyleType="disc" indent="2"} [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A) to join an HA pair. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail token :::Paragraph{indent="1"} 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 ```bash ssc high-avail token ``` ### Usage Guidelines :::Paragraph{indent="1"} This command is identical to the [ssc high-avail token remove](docId\:LLjz7el7U_q1thWAbTl0A) command. ::: ### Examples ```bash 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 :::Paragraph{indent="1"} [ssc high-avail token add](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token generate](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token remove](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail token add :::Paragraph{indent="1"} Adds a token to the current high availability access token. This can be either a node in an HA pair, or standalone node. ::: ### Syntax ```bash ssc high-avail token add ``` ### Usage Guidelines :::Paragraph{indent="1"} This command can only be used when there is no assigned token. Use [ssc high-avail update](docId\:LLjz7el7U_q1thWAbTl0A) to remove the current token. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail token](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token generate](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token remove](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail token generate :::Paragraph{indent="1"} 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 ```bash ssc high-avail token generate ``` ### Examples ```bash 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 :::Paragraph{indent="1"} [ssc high-avail token](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token add](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token remove](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail token list :::Paragraph{indent="1"} Displays the current high availability access token. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is identical to the [ssc high-avail token add](docId\:LLjz7el7U_q1thWAbTl0A) command. ::: ### ssc high-avail token remove :::Paragraph{indent="1"} 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 ```bash ssc high-avail token token-id ``` ### Parameters ```bash token token-id ``` :::Paragraph{indent="1"} The token ID. Use [ssc high-avail token add](docId\:LLjz7el7U_q1thWAbTl0A) to display this for the current node. ::: ### Examples ```bash *** 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 :::Paragraph{indent="1"} [ssc high-avail token](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token add](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token generate](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail token list](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc high-avail update :::Paragraph{indent="1"} Updates the Service Endpoint Address of an HA pair (or standalone Services Director). ::: ### Syntax ```bash ssc high-avail update traffic-ip IP-or-hostname ``` ### Parameters ```bash traffic-ip ``` :::Paragraph{indent="1"} The IP address or host name of the new Service Endpoint Address. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command can be issued from either the Active or the Standby node. ::: :::hint{type="info"} Do not use this command from the Service Endpoint Address node. The command will fail. ::: :::Paragraph{indent="1"} This command affects FLA licensing for vTMs: ::: :::Paragraph{listStyleType="disc" indent="2"} 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. ::: :::Paragraph{listStyleType="disc" indent="2"} Any Universal FLA licenses that are tied to the current Service Endpoint Address will need to be relicensed (see [ssc instance relicense instance-name](docId\:H010mqCIZJAevKMkPzNkS)). ::: :::hint{type="info"} After this command completes, a restart of your Services Director service is required. ::: ### Examples ```bash *** 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 restart ``` ### Related Commands :::Paragraph{indent="1"} [ssc high-avail diagnose](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail discover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail eject](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail ejectall](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-failover](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail force-standby](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail join](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail list](docId\:LLjz7el7U_q1thWAbTl0A), [ssc high-avail reset](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc host add host-name :::Paragraph{indent="1"} Adds a Services Director instance host. ::: ### Syntax ```bash 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 ```bash host-name name ``` :::Paragraph{indent="1"} Specify a unique name for this resource. ::: ```bash host-user name ``` :::Paragraph{indent="1"} (DEPRECATED) Specify the host administrator user name; you must specify** sscadmin**. ::: ```bash host-pass password ``` :::Paragraph{indent="1"} (DEPRECATED) Specify the host administrator password; the default value is** password**. ::: ```bash username user ``` :::Paragraph{indent="1"} Specify the user for SSH access; this user must be root. ::: ```bash usage-info description ``` :::Paragraph{indent="1"} (DEPRECATED) This property is not used. ::: ```bash retained-info-dir directory ``` :::Paragraph{indent="1"} (DEPRECATED) This property is not used. ::: ```bash max-instances number ``` :::Paragraph{indent="1"} The number of instances that you can create on this host. ::: ```bash cpu-cores string ``` :::Paragraph{indent="1"} (DEPRECATED) This property is not used. ::: ```bash info description ``` :::Paragraph{indent="1"} (Optional) Specify descriptive information. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the** no ssc host hostname \** to delete the host. ::: ### Examples ```bash amnesiac (config) # ssc host add host-name test-demo1 host-user sscadmin host-pass password username root ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc host update host-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc host add template-name :::Paragraph{indent="1"} Adds a Services Director host based on a template. Optionally, adds or changes the current values for the new host. ::: ### Syntax ```bash 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 ```bash name ``` :::Paragraph{indent="1"} Specify the unique name for the template. ::: ```bash host-name name ``` :::Paragraph{indent="1"} Optionally, specify the host name. ::: ```bash host-user name ``` :::Paragraph{indent="1"} Optionally, specify the administrator user name. The default value is** sscadmin**. ::: ```bash host-pass admin-password ``` :::Paragraph{indent="1"} Optionally, specify the administrator password; the default value is** password**. ::: ```bash username user ``` :::Paragraph{indent="1"} Optionally, specify the user for SSH access; this user must be** root**. ::: ```bash retained-info-dir directory ``` :::Paragraph{indent="1"} This property is not used. ::: ```bash usage-info description ``` :::Paragraph{indent="1"} This property is not used. ::: ```bash max-instances number ``` :::Paragraph{indent="1"} The number of instances that you can create on this host. ::: ```bash cpu-cores string ``` :::Paragraph{indent="1"} This property is not used. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify descriptive information about the new host. ::: ### Usage Guidelines :::Paragraph{indent="1"} 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 ```bash amnesiac (config) # ssc host add template-name htemp1 host-name test-demo username root ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc host host-migrate :::Paragraph{indent="1"} Migrate vTM instances between hosts within the same subnet. ::: ### Syntax ```bash ssc host host-migrate from name-or-ip-addr-from to ip-addr-to [force yes-or-no] ``` ### Parameters ```bash name-or-ip-addr-from ``` :::Paragraph{indent="1"} Specify the name of the instance host where the Traffic Manager is migrating from. ::: ```bash ip-addr-to ``` :::Paragraph{indent="1"} Optionally, specify the IP address or the name of the instance host where the Traffic Manager is migrating to. ::: ```bash force yes-or-no ``` :::Paragraph{indent="1"} Forces migration of Traffic Managers regardless of the network topology. ::: ### Examples ```bash amnesiac (config) # ssc host host-migrate from 10.0.0.1 to 10.0.05 force yes ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc host host-name dns :::Paragraph{indent="1"} Configures instance host DNS settings. ::: ### Syntax ```bash ssc host host-name name dns dns-nameservers dns-name-servers | [dns-search dnsfixes] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the host. ::: ```bash dns-nameservers dns-name-servers ``` :::Paragraph{indent="1"} Specify the DNS name server. ::: ```bash dns-search dns-suffixes ``` :::Paragraph{indent="1"} Optionally, specify a comma separated list of searched domain suffixes. ::: ### Examples ```bash amnesiac (config) # ssc host host-name test dns dns-nameservers dnstest ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW) :::