--- title: Config-Mode Commandnds slug: ps/help/en_us/sd/25x/cli/config-mode-commandnds docTags: createdAt: 2026-10-06T15:00:40.908Z --- ### ssc search-endpoint create :::Paragraph{indent="1"} Creates a new Search Endpoint resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc search-endpoint create search-endpoint-address address transactions-index index logs-index index use-tls Boolean tls-verify Boolean [name value] auth-username username auth-password password endpoint-cert certificate ``` ### Parameters ```bash search-endpoint-address ``` :::Paragraph{indent="1"} The address of the search endpoint in your analytics system, in the form \:\. ::: :::Paragraph{indent="1"} For example: demo.com:2020 ::: ```bash transactions-index ``` :::Paragraph{indent="1"} This is the index used for transactions on the Splunk platform. ::: :::Paragraph{indent="1"} For example, zxtm\_transactions. ::: ```bash logs-index ``` :::Paragraph{indent="1"} This is the index used for logs on the Splunk platform. ::: :::Paragraph{indent="1"} For example, zxtm\_logs. ::: ```bash use-tls ``` :::Paragraph{indent="1"} Indicates whether queries require secure transmission. If true, you must also specify **endpoint-cert**. ::: ```bash tls-verify ``` :::Paragraph{indent="1"} Indicates whether queries require verification. ::: ```bash name ``` :::Paragraph{indent="1"} (Optional) The customer-facing name for the search endpoint resource. If this is not set, the tag is set to the UUID value for the resource. ::: ```bash auth-username ``` :::Paragraph{indent="1"} The authorization username for the search endpoint. ::: ```bash auth-password ``` :::Paragraph{indent="1"} The authorization password for the search endpoint. ::: ```bash endpoint-cert ``` :::Paragraph{indent="1"} The certificate for the search endpoint. This is required if **use-tls **is true. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Search Endpoint resources. Collection Endpoint resources are handled separately, by an equivalent "collection-endpoint" command. ::: ### Examples ```bash *** list all search endpoints (empty) *** amnesiac (config) # ssc search-endpoint list +-----------------+ | Message | +-----------------+ | No record found | +-----------------+ *** add a search endpoint resource *** amnesiac (config) # ssc search-endpoint create search-endpoint-address demo.com:2020 transactions-index zxtm_transactions logs-index zxtm_logs use-tls true tls-verify true name JK-EP-Search-01 auth-username admin auth-password password endpoint-cert "LS0tLS1CRUdJTiBDRVJUSAUG5T...SVElGSUNBVEUtLS0tLQo=" +-----------------------------+---------------------------------------------------- | Field | Value +-----------------------------+---------------------------------------------------- | verify_tls | True | tag | JK-EP-Search-01 | search_endpoint_id | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | auth_password | password | auth_username | admin | search_endpoint_address | demo.com:2020 | use_tls | True | search_endpoint_certificate | LS0tLS1CRUdJTiBDRVJUSAUG5T...SVElGSUNBVEUtLS0tLQo= | transactions_index | zxtm_transactions | logs_index | zxtm_logs +-----------------------------+---------------------------------------------------- *** list all search endpoints to confirm the addition *** amnesiac (config) # ssc search-endpoint list +-------------------------------------+-----------------+ | ID | Tag | +-------------------------------------+-----------------+ | Search-Endpoint-OFFO-I80A-RVLP-4C49 | JK-EP-Search-01 | +-------------------------------------+-----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc search-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc search-endpoint delete](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc search-endpoint delete :::Paragraph{indent="1"} Delete a Search Endpoint resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc search-endpoint delete name endpoint-id ``` ### Parameters ```bash name endpoint-id ``` :::Paragraph{indent="1"} The identifier for the search endpoint resource, either its** tag** or its UUID. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Search Endpoint resources. Collection Endpoint resources are handled separately, by an equivalent "collection-endpoint" command. ::: ### Examples ```bash *** display a list of all (typically one) search endpoint *** amnesiac (config) # ssc search-endpoint list +-------------------------------------+-----------------+ | ID | Tag | +-------------------------------------+-----------------+ | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | JK-EP-Search-01 | +-------------------------------------+-----------------+ *** Delete a search endpoint *** amnesiac (config) # ssc search-endpoint delete name JK-EP-Search-01 +-------------------------------------------------------------+ | Deleted | +-------------------------------------------------------------+ | Search Endpoint Search-Endpoint-P5Y0-8JS4-X0BS-2P9M deleted | +-------------------------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc search-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc search-endpoint create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc search-endpoint list :::Paragraph{indent="1"} Lists all Search Endpoint resources. These resources are used for vTM analytics. ::: ### Syntax ```bash ssc search-endpoint list ``` ### Usage Guidelines :::Paragraph{indent="1"} Typically, there is a single search endpoint. ::: :::Paragraph{indent="1"} This command is only used for Search Endpoint resources. Collection Endpoint resources are handled separately, by an equivalent "collection-endpoint" command. ::: ### Examples ```bash amnesiac (config) # ssc search-endpoint list +-------------------------------------+-----------------+ | ID | Tag | +-------------------------------------+-----------------+ | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | JK-EP-Search-01 | +-------------------------------------+-----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc search-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc search-endpoint create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint delete](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc search-endpoint update :::Paragraph{indent="1"} Updates a Search Endpoint resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc search-endpoint update name endpoint-id [search-endpoint-address address] [use-tls Boolean] [tls-verify Boolean] [endpoint-cert certificate] [auth-username username] [auth-password password] [new-name value] ``` ### Parameters ```bash name endpoint-id ``` :::Paragraph{indent="1"} Specify a unique identifier for the search-endpoint resource, either its tag or UUID. ::: ```bash search-endpoint-address ``` :::Paragraph{indent="1"} The address of the search endpoint on the Splunk platform, in the form \:\. ::: :::Paragraph{indent="1"} For example: demo.com:2020 ::: ```bash transactions-index ``` :::Paragraph{indent="1"} This is the index used for transactions on the Splunk platform. ::: :::Paragraph{indent="1"} For example, zxtm\_transactions. ::: ```bash logs-index ``` :::Paragraph{indent="1"} This is the index used for logs on the Splunk platform. ::: :::Paragraph{indent="1"} For example, zxtm\_logs. ::: ```bash use-tls ``` :::Paragraph{indent="1"} Indicates whether queries require secure transmission. If true, you must also specify **endpoint-cert**. ::: ```bash tls-verify ``` :::Paragraph{indent="1"} Indicates whether queries require verification. ::: ```bash endpoint-cert ``` :::Paragraph{indent="1"} The certificate for the search endpoint. This is required if **use-tls **is true. ::: ```bash auth-username ``` :::Paragraph{indent="1"} The authorization username for the search endpoint. ::: ```bash auth-password ``` :::Paragraph{indent="1"} The authorization password for the search endpoint. ::: ```bash new-name ``` :::Paragraph{indent="1"} (Optional) A replacement name for the search endpoint resource. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is only used for Search Endpoint resources. Collection Endpoint resources are handled separately, by an equivalent "collection-endpoint" command. ::: ### Examples ```bash *** list all search endpoints *** amnesiac (config) # ssc search-endpoint list +-------------------------------------+-----------------+ | ID | Tag | +-------------------------------------+-----------------+ | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | JK-EP-Search-01 | +-------------------------------------+-----------------+ *** display details for a specific search endpoint *** amnesiac (config) # show ssc search-endpoint name JK-EP-Search-01 +-----------------------------+---------------------------------------------------- | Field | Value +-----------------------------+---------------------------------------------------- | verify_tls | True | tag | JK-EP-Search-01 | search_endpoint_id | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | auth_password | password | auth_username | admin | search_endpoint_address | demo.com:2020 | use_tls | True | search_endpoint_certificate | LS0tLS1CRUdJTiBDRVJUSAUG5T...SVElGSUNBVEUtLS0tLQo= | transactions_index | zxtm_transactions | logs_index | zxtm_logs +-----------------------------+---------------------------------------------------- *** update a search endpoint to disable verification *** amnesiac (config) # ssc search-endpoint update name JK-EP-Search-01 tls-verify false +-----------------------------+---------------------------------------------------- | Field | Value +-----------------------------+---------------------------------------------------- | verify_tls | False | tag | JK-EP-Search-01 | search_endpoint_id | Search-Endpoint-P5Y0-8JS4-X0BS-2P9M | auth_password | password | auth_username | admin | search_endpoint_address | demo.com:2020 | use_tls | True | search_endpoint_certificate | LS0tLS1CRUdJTiBDRVJUSAUG5T...SVElGSUNBVEUtLS0tLQo= | transactions_index | zxtm_transactions | logs_index | zxtm_logs +-----------------------------+---------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc search-endpoint](docId\:Daj0PxouZD3s712K5TKUW), [ssc search-endpoint create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint delete](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc search-endpoint list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc server rest-port-num :::Paragraph{indent="1"} Configures the Services Director REST API port number. ::: ### Syntax ```bash [no] ssc server rest-port-num port-number ``` ### Parameters ```bash port-number ``` :::Paragraph{indent="1"} Specify the REST API port number. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no** command option to delete the REST API port number. ::: ### Examples ```bash amnesiac (config) # ssc server rest-port-num 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc service enable :::Paragraph{indent="1"} Starts the Services Director service. ::: ### Syntax ```bash [no] ssc service enable ``` ### Usage Guidelines :::Paragraph{indent="1"} Use the **no** command option disable the service. ::: ### Examples ```bash amnesiac (config) # ssc service enable ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc service restart :::Paragraph{indent="1"} Restarts the Services Director service. ::: ### Syntax ```bash ssc service restart ``` ### Examples ```bash amnesiac (config) # ssc service restart ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings analytics update :::Paragraph{indent="1"} Sets the transaction type to match the setting on your vTM analytics platform. ::: ### Syntax ```bash sssc settings analytics update transaction-source-type source-type ``` ### Parameters ```bash transaction-source-type source-type ``` :::Paragraph{indent="1"} Specify the text of the transaction type on your Analytics System. ::: ### Examples ```bash *** view current setting *** amnesiac (config) # show ssc settings analytics +-------------------------+-------------------+ | Field | Value | +-------------------------+-------------------+ | transaction_source_type | zxtm_transactions | +-------------------------+-------------------+ *** change the default setting to match a tailored analytics system *** amnesiac (config) # ssc settings analytics update transaction-source-type xxx_transactions +-------------------------+------------------+ | Field | Value | +-------------------------+------------------+ | transaction_source_type | xxx_transactions | +-------------------------+------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings analytics](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings con-lic update exp-warningdays :::Paragraph{indent="1"} Sets expiration days for a warning to be sent for the Services Director license. ::: ### Syntax ```bash ssc settings con-lic update exp-warningdays number-of-days ``` ### Parameters ```bash number-of-days ``` :::Paragraph{indent="1"} Specify the number of days in advance to warn before Services Director license expires. ::: ### Examples ```bash amnesiac (config) # ssc settings con-lic update exp-warningdays 30 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings con-lic](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings con-lic update template-name :::Paragraph{indent="1"} Updates Services Director license expiration settings based on the specified template. ::: ### Syntax ```bash ssc settings con-lic update template-name name | exp-warningdays number-of-days ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash number-of-days ``` :::Paragraph{indent="1"} Specify the number of days in advance to warn before Services Director license expires. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates a Services Director license expiration settings 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 settings con-lic update template-name con-lic-temp1 exp-warningdays 30 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings licensing](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings deployment update max-instances :::Paragraph{indent="1"} Sets the maximum number of deployable instances. ::: ### Syntax ```bash ssc settings deployment update max-instances integer ``` ### Parameters ```bash integer ``` :::Paragraph{indent="1"} Specify maximum number of deployable instances, 0 equals no limit. ::: ### Usage Guidelines :::Paragraph{indent="1"} Typically, zero is the correct value for most deployments. Instances that have been deleted do not count towards the limit. Instances that have been deployed but are not active (that is, have not been started) do count towards the limit. If you create a new instance in excess of this number, the instance is rejected with an error message. If this property is set to a lower number than the number of currently deployed instances then there is no immediate effect but subsequent deployment requests are rejected. ::: ### Examples ```bash amnesiac (config) # ssc settings deployment update max-instances 0 ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings deployment update template-name :::Paragraph{indent="1"} Updates a Services Director deployment based on the specified template. ::: ### Syntax ```bash ssc settings deployment update template-name name | max-instances integer ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash integer ``` :::Paragraph{indent="1"} Specify the maximum number of Traffic Manager instances that can be deployed. The default value zero (0) equals no limit. The value must be a positive integer. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates a deployment settings 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 settings deployment update template-name deploytemp1 max-instances 0 ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings external-ip :::Paragraph{indent="1"} Sets the external IP corresponding to the Services Endpoint Address when Services Director is running in a private network behind a NAT. ::: ### Syntax ```bash [no] ssc settings external-ip ``` ### Usage Guidelines :::Paragraph{indent="1"} The** no** command option clears the set external IP address. ::: ### Examples ```bash amnesiac (config) # ssc settings external-ip 10.62.150.30 +-------------+--------------+ | Field | Value | +-------------+--------------+ | external_ip | 10.62.150.30 | +-------------+--------------+ amnesiac (config) # no ssc settings external-ip +-------------+-------+ | Field | Value | +-------------+-------+ | external_ip | None | +-------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings external-ip](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings fla-check enable :::Paragraph{indent="1"} Enables the FLA checker for the Services Director. ::: ### Syntax ```bash [no] ssc settings fla-check enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the FLA checker. ::: ### Examples ```bash amnesiac (config) # ssc settings fla-check enable +-------------------+-------+ | Field | Value | +-------------------+-------+ | fla_check_enabled | True | +-------------------+-------+ amnesiac (config) # no ssc settings fla-check enable +-------------------+-------+ | Field | Value | +-------------------+-------+ | fla_check_enabled | False | +-------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings fla-check](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings licensing update alert-threshold :::Paragraph{indent="1"} Updates Services Director licensing settings. ::: ### Syntax ```bash ssc settings licensing update alert-threshold integer alert-thld-itvl seconds ``` ### Parameters ```bash integer ``` :::Paragraph{indent="1"} Specify the number of alerts that can be sent. The range is 1-3600, inclusive; the value must be a positive integer. ::: ```bash alert-thld-itvl seconds ``` :::Paragraph{indent="1"} Specify the period of time, in seconds, between alerts. The default value is 3600 seconds (1 hour). The range is 1-3600, inclusive; the value must be a positive integer. ::: ### Usage Guidelines :::Paragraph{indent="1"} The threshold and interval settings enable you to specify the time interval before an alert email is sent to the configured alert email addresses. The threshold and interval is reached then an alert message is sent. At most one message is sent per hour, to protect against a flood of messages being sent in the case of complete failure of the primary license server on a busy system. ::: ### Examples ```bash amnesiac (config) # ssc settings licensing update alert-threshold 10 alert-thld-itvl 3600 ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings licensing update template-name :::Paragraph{indent="1"} Updates Services Director licensing settings based on the specified template. ::: ### Syntax ```bash ssc settings licensing update template-name name alert-threshold integer alert-thld-itvl seconds ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash alert-threshold integer ``` :::Paragraph{indent="1"} Specify the number of alerts that can be sent. The range is 1-3600, inclusive; the value must be a positive integer. ::: ```bash alert-thld-itvl seconds ``` :::Paragraph{indent="1"} Specify the period of time, in seconds, between alerts. The default value is 3600 seconds (1 hour). The range is 1-3600, inclusive; the value must be a positive integer. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates a licensing settings 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"} The threshold and interval settings enable you to specify the time interval before an alert email is sent to the configured alert email addresses. The threshold and interval is reached then an alert message is sent. At most one message is sent per hour, to protect against a flood of messages being sent in the case of complete failure of the primary license server on a busy system. ::: ### Examples ```bash amnesiac (config) # ssc settings licensing update template-name lictemp1 alert-threshold 5 alert-thld-itvl 1600 ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings list :::Paragraph{indent="1"} Lists Services Director settings. ::: ### Syntax ```bash ssc settings list ``` ### Examples ```bash amnesiac (config) # ssc settings list +-------------------------+ | Settings | +-------------------------+ | master_password | | logging | | fla_check | | controller_licensing | | metering | | phone_home | | licensing | | deployment | | monitoring | | bandwidthpack_licensing | +-------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings logging update :::Paragraph{indent="1"} Updates Services Director logging settings. ::: ### Syntax ```bash ssc settings logging update | [license-log integer] | [metering-log integer] | [inventory-log integer] ``` ### Parameters ```bash license-log integer ``` :::Paragraph{indent="1"} Specify the license value. The range is 0-10. The default value is 0, which equals no logging. A log level of 3+ causes responses to license server requests to be logged in full, including the feature values set by the feature pack and bandwidth associated with the instance making the request. The value must be a positive integer; there is no upper limit. ::: ```bash metering-log integer ``` :::Paragraph{indent="1"} Specify the metering logging value. The range is 0-10. The default value is 0 which equals no logging. A log level of 5+ gives a summary of the activities of the metering thread (that is, starting metering, stopping metering, and so forth), while a log level of 9+ provides a detailed logging of each instance being metered. The value must be a positive integer; there is no upper limit. ::: ```bash inventory-log integer ``` :::Paragraph{indent="1"} Specify the metering logging value. The range is 0-10. The default value is 0, which equals no logging. A log level of 1+ causes inventory changes to be logged (the equivalent of the audit records). A log level of 3+ causes logging of all deployment and action commands. A log level of 8+ causes logging of the output from all deployment and actions. The value must be a positive integer; there is no upper limit. ::: ### Examples ```bash amnesiac (config) # ssc settings logging update license-log 5 ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings logging update template-name :::Paragraph{indent="1"} Updates Services Director logging settings based on the specified template. ::: ### Syntax ```bash ssc settings logging update template-name name | [license-log integer] | [metering-log integer] | [inventory-log integer] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash license-log integer ``` :::Paragraph{indent="1"} Specify the license value. The range is 0-10. The default value is 0, which equals no logging. A log level of 3+ causes responses to license server requests to be logged in full, including the feature values set by the feature pack and bandwidth associated with the instance making the request. The value must be a positive integer; there is no upper limit. ::: ```bash metering-log integer ``` :::Paragraph{indent="1"} Specify the metering logging value. The range is 0-10. The default value is 0 which equals no logging. A log level of 5+ gives a summary of the activities of the metering thread (that is, starting metering, stopping metering, and so forth), while a log level of 9+ provides a detailed logging of each instance being metered. The value must be a positive integer; there is no upper limit. ::: ```bash inventory-log integer ``` :::Paragraph{indent="1"} Specify the metering logging value. The range is 0-10. The default value is 0, which equals no logging. A log level of 1+ causes inventory changes to be logged (the equivalent of the audit records). A log level of 3+ causes logging of all deployment and action commands. A log level of 8+ causes logging of the output from all deployment and actions. The value must be a positive integer; there is no upper limit. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates logging 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 settings logging update template-name tempset1 settemp1 license-log 7 ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings master-password reset :::Paragraph{indent="1"} This command resets the master password for a Services Director if it in unknown or lost. This command should only be used as a final resort to re-establish a master password. ::: ### Syntax ```bash ssc settings master-password reset password new-password [force [true | false]] ``` ### Parameters ```bash new-password ``` :::Paragraph{indent="1"} Specify the new master password. This must be at least 8 characters long, and must have at least: ::: :::Paragraph{listStyleType="disc" indent="3"} One lower case character. ::: :::Paragraph{listStyleType="disc" indent="3"} One upper case character. ::: :::Paragraph{listStyleType="disc" indent="3"} One digit. ::: :::Paragraph{listStyleType="disc" indent="3"} One non-alphanumeric symbol. ::: ```bash force [true | false] ``` :::Paragraph{indent="1"} Specify** true** or** false**. If set to** true**, you can reset the password when there are Traffic Manager instances on the Services Director. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is invisible from the command line, but is available. ::: :::Paragraph{indent="1"} If you wish to change the master password (that is, you know what the current master password is), use the "ssc settings master-password update" on page 227. ::: :::Paragraph{indent="1"} If you have just upgraded from Services Director v2.2r1 or earlier, a default master password has been assigned automatically to the Services Director. The default master password is master1M\@. See the Services Director Advanced User Guide for details. ::: :::Paragraph{indent="1"} The master password is used to encrypt the passwords of all connected Traffic Manager instances. If you reset the master password, these Traffic Manager passwords are lost, and you must be re-enter the passwords manually. See [ssc instance update template-name](docId\:H010mqCIZJAevKMkPzNkS). ::: :::Paragraph{indent="1"} Where Traffic Manager instances are present on the Services Director, you must include the optional** force true** parameter in the command. This enables the reset to complete. An information message about updating passwords for registered instances is also displayed. ::: :::hint{type="info"} After resetting the master password on the Active Services Director, you must repeat the process for the Standby Services Director. ::: ### Examples ```bash *** attempt to reset *** amnesiac (config) # ssc settings master-password reset password Banj-axed27 Not resetting master password Ensure that "force true" is passed, to confirm that you wish to reset the master password *** attempt to reset, including the force true parameter *** amnesiac (config) # ssc settings master-password reset password Banj-axed27 force true Successfully reset master password You must manually update all passwords for registered instances ``` :::hint{type="info"} After resetting the master password on the Active Services Director, you must repeat the process for the Standby Services Director. ::: ### Related Commands :::Paragraph{indent="1"} [show ssc settings master-password](docId\:Daj0PxouZD3s712K5TKUW), [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc settings master-password update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings master-password update :::Paragraph{indent="1"} Updates the Services Director master password on a Services Director. ::: ### Syntax ```bash ssc settings master-password update current-password current-password new-password new-password ``` ### Parameters ```bash current-password current-password ``` :::Paragraph{indent="1"} Specify the current password. ::: ```bash new-password new-password ``` :::Paragraph{indent="1"} Specify the new password. This must be at least 8 characters long, and must have at least: ::: :::Paragraph{listStyleType="disc" indent="3"} One lower case character. ::: :::Paragraph{listStyleType="disc" indent="3"} One upper case character. ::: :::Paragraph{listStyleType="disc" indent="3"} One digit. ::: :::Paragraph{listStyleType="disc" indent="3"} One non-alphanumeric symbol. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command should be used on the Active node in an HA pair. ::: :::Paragraph{indent="1"} While the password change completes, the status displayed by the [show ssc settings metering](docId\:Daj0PxouZD3s712K5TKUW) command is Changing. Once complete, it becomes Active. ::: :::Paragraph{indent="1"} After you have updated the password on the ActiveServices Director node, repeat the command on the Standby node. ::: :::hint{type="info"} If you wish to reset the master password (that is, you do not know what the current master password is), use the "ssc settings master-password reset" on page 226. ::: ### Examples ```bash *** Change the password *** amnesiac (config) # ssc settings master-password update current-password P0s1-t1ve99 new-password Banj-axed27 +------------------+----------+ | Field | Value | +------------------+----------+ | status | Changing | | new_password | None | | current_password | None | +------------------+----------+ *** Monitor the password change while it completes *** *** (status of "Changing" becomes "Active") *** amnesiac (config) # show ssc settings master-password +------------------+----------+ | Field | Value | +------------------+----------+ | status | Active | | new_password | None | | current_password | None | +------------------+----------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings master-password](docId\:Daj0PxouZD3s712K5TKUW), [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings metering update :::Paragraph{indent="1"} Updates Services Director metering settings. ::: ### Syntax ```bash ssc settings metering update | [meter-interval integer] | [log-check-itvl seconds] | [snmp-enabled [true | false]] | [alerts-and-notifications [true | false]] ``` ### Parameters ```bash meter-interval integer ``` :::Paragraph{indent="1"} Specify the period of time, in seconds, between metering actions. The default value is 3600 seconds (1 hour). It cannot be set to more than 3600. The range is 1-3600, inclusive; the value must be a positive integer. ::: ```bash log-check-itvl seconds ``` :::Paragraph{indent="1"} Specify the period of time, in seconds, between checks for log-space. The default value is 3600 seconds (1 hour). The range is 1-3600, inclusive; the value must be a positive integer. ::: ```bash snmp-enabled [true | false] ``` :::Paragraph{indent="1"} Specify** true** or** false** to enable SNMP. By default, this is enabled. ::: ```bash alerts-and-notifications [true | false] ``` :::Paragraph{indent="1"} Specify** true** or** false** to enable alerts and notifications. By default, this is enabled. ::: ### Examples ```bash amnesiac (config) # ssc settings metering update meter-interval 1500 log-check-itvl 1500 snmp-enabled False alerts-and-notifications False +--------------------------+-------+ | Field | Value | +--------------------------+-------+ | alerts_and_notifications | False | | snmp_enabled | False | | log_check_interval | 1500 | | meter_interval | 1500 | +--------------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc dashboard](docId\:Daj0PxouZD3s712K5TKUW), [show ssc metering warning instance-name](docId\:Daj0PxouZD3s712K5TKUW), [show ssc settings metering](docId\:Daj0PxouZD3s712K5TKUW), [ssc metering warning list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc settings metering update template-name :::Paragraph{indent="1"} Updates Services Director metering settings based on the specified template. ::: ### Syntax ```bash ssc settings metering update template-name name | [meter-interval integer] | [log-check-itvl seconds] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash meter-interval integer ``` :::Paragraph{indent="1"} Specify the period of time, in seconds, between metering actions. The default value is 3600 seconds (1 hour). It cannot be set to more than 3600. The range is 1-3600, inclusive; the value must be a positive integer. ::: ```bash log-check-itvl seconds ``` :::Paragraph{indent="1"} Specify the period of time, in seconds, between checks for log-space. The default value is 3600 seconds (1 hour). The range is 1-3600, inclusive; the value must be a positive integer. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates metering 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 settings metering update template-name mettemp1 meter-interval 3600 ``` ### Related Commands :::Paragraph{indent="1"} [ssc settings list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc settings monitoring update :::Paragraph{indent="1"} Updates Services Director monitoring settings. ::: ### Syntax ```bash ssc settings monitoring update [cont-fail-period seconds] | [ins-fail-perid seconds] | [host-fail-period seconds] | [ovd-mon-warn-pd seconds] | [ins-mon-itvl seconds] | [cont-mon-itvl seconds] | [mon-email-itvl seconds] | [host-mon-itvl seconds] | [auto-cleanup-vtms setting] ``` ### Parameters ```bash cont-fail-perid seconds ``` :::Paragraph{indent="1"} Specify the number of seconds after which a Services Director is considered failed. The default value is 180. ::: ```bash ins-fail-perid seconds ``` :::Paragraph{indent="1"} Specify the number of seconds after which an instance is considered failed. The default value is 180. ::: ```bash host-fail-perid seconds ``` :::Paragraph{indent="1"} Specify the number of seconds after which a host is considered failed. The default value is 180. ::: ```bash cont-mon-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring Services Directors. The default value is 60. ::: ```bash ins-mon-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring instances. The default value is 60. ::: ```bash host-mon-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring hosts. The default value is 60. ::: ```bash ovd-mon-warn-pd seconds ``` :::Paragraph{indent="1"} Specify the number of seconds to consider monitoring overdue. The default value is 300. ::: ```bash mon-email-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring alert emails. The default value is 60. ::: ```bash auto-cleanup-vtms setting ``` :::Paragraph{indent="1"} Select the required setting for auto cleanup of failed vTMs: off, self\_registered\_vtms, all\_vtms. ::: ### Examples ```bash amnesiac (config) # ssc settings monitoring update host-mon-itvl 360 mon-email-itvl 3600 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings monitoring](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings monitoring update template-name :::Paragraph{indent="1"} Updates Services Director monitoring settings based on a specified template. ::: ### Syntax ```bash ssc settings monitoring update template-name name [cont-fail-period seconds] | [ins-fail-period seconds] | [host-fail-period seconds] | [ovd-mon-warn-pd seconds] | [ins-mon-itvl seconds] | [cont-mon-itvl seconds] | [mon-email-itvl seconds] | [host-mon-itvl seconds] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash cont-fail-period seconds ``` :::Paragraph{indent="1"} Specify the umber of seconds after which a Services Director is considered failed. The default value is 180 seconds. ::: ```bash ins-fail-period seconds ``` :::Paragraph{indent="1"} Specify the number of seconds after which an instance is considered failed. The default value is 180 seconds. ::: ```bash host-fail-period seconds ``` :::Paragraph{indent="1"} Specify the number of seconds after which a host is considered failed. The default value is 180 seconds. ::: ```bash ovd-mon-warn-pd seconds ``` :::Paragraph{indent="1"} Specify the number of seconds to consider monitoring overdue. The default value is 300 seconds. ::: ```bash ins-mon-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring instances. The default value is 60 seconds. ::: ```bash cont-mon-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring Services Directors. The default value is 60 seconds. ::: ```bash mon-email-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring alert emails. The default value is 60 seconds. ::: ```bash host-mon-itvl seconds ``` :::Paragraph{indent="1"} Specify the number of seconds between monitoring hosts. The default value is 60 seconds. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates metering 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 settings monitoring update template-name monitortemp1 host-mon-itvl 360 mon-email-itvl 360 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings monitoring](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings security update :::Paragraph{indent="1"} Updates Services Director security settings. ::: ### Syntax ```bash ssc settings monitoring update [user_lockout_duration_minutes minutes] | [max_login_attempts max_login_attempts] ``` ### Parameters ```bash user_lockout_duration_minutes minutes ``` :::Paragraph{indent="1"} Specify a suspension lockout duration (in minutes). If the max\_login\_attempts threshold limit is reached, the suspension duration lockout is applied. This has a default of 1 minute, and a maximum of 1440 minutes (equal to one day). ::: ```bash max_login_attempts max_login_attempts ``` :::Paragraph{indent="1"} Specify the maximum number of failed Services Director login attempts for a user. This has a default of zero, which indicates that there is no maximum. ::: ### Examples ```bash amnesiac (config) # ssc settings security update max-login-attempts 3 user-lockout-duration 15 +-------------------------------+-------+ | Field | Value | +-------------------------------+-------+ | user_lockout_duration_minutes | 15 | | max_login_attempts | 3 | +-------------------------------+-------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings security](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings telemetry update enabled :::Paragraph{indent="1"} Enables/Disables Services Director’s phone home telemetry feature. ::: :::Paragraph{indent="1"} When enabled, Services Director collects and exports phone home telemetry data to ivanti. ::: ### Syntax ```bash ssc settings telemetry update enabled [true | false] ``` ### Parameters ```bash true ``` :::Paragraph{indent="1"} Enables the phone home telemetry feature. ::: ```bash false ``` :::Paragraph{indent="1"} Disables the phone home telemetry feature. ::: ### Examples ```bash *** show phone home telemetry status *** enable amnesiac (config) # show ssc settings telemetry +--------------------+-----------------------------------------------------+ | Field | Value | +--------------------+-----------------------------------------------------+ | destination | https://telemetry.cam.demo.com/product-feedback/1.0 | | phone_home_enabled | False | +--------------------+-----------------------------------------------------+ *** Enable phone home telemetry *** enable amnesiac (config) # ssc settings telemetry update enabled true +--------------------+-----------------------------------------------------+ | Field | Value | +--------------------+-----------------------------------------------------+ | destination | https://telemetry.cam.demo.com/product-feedback/1.0 | | phone_home_enabled | True | +--------------------+-----------------------------------------------------+ *** Enable phone home telemetry *** enable amnesiac (config) # ssc settings telemetry update enabled false +--------------------+-----------------------------------------------------+ | Field | Value | +--------------------+-----------------------------------------------------+ | destination | https://telemetry.cam.zeus.com/product-feedback/1.0 | | phone_home_enabled | False | +--------------------+-----------------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings telemetry archives](docId\:Daj0PxouZD3s712K5TKUW), [show ssc settings telemetry archives](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings throughput update exp-warningdays :::Paragraph{indent="1"} Sets expiration days for a warning to be sent for the Services Director about of bandwidth pack licenses. ::: ### Syntax ```bash ssc settings throughput update exp-warningdays number-of-days ``` ### Parameters ```bash number-of-days ``` :::Paragraph{indent="1"} Specify the number of days in advance to warn before Services Director license expires. ::: ### Examples ```bash amnesiac (config) # ssc settings throughput update exp-warningdays 30 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings throughput](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc settings throughput update template-name :::Paragraph{indent="1"} Updates Services Director throughput expiration settings based on the specified template. ::: ### Syntax ```bash ssc settings throughput update template-name name | exp-warningdays number-of-days ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash number-of-days ``` :::Paragraph{indent="1"} Specify the number of days in advance to warn for throughput expiration. ::: ### Usage Guidelines :::Paragraph{indent="1"} Update a Services Director license expiration settings 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 settings throughput update template-name thrutemp1 exp-warningdays 30 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc settings throughput](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc sku list :::Paragraph{indent="1"} Lists Services Director SKUs. ::: ### Syntax ```bash ssc sku list [show-all [true | false] ``` ### Usage Guidelines :::Paragraph{indent="1"} By default, the list only includes SKUs that are compatible with your license. ::: :::Paragraph{indent="1"} If **show-all** is set to true, the list includes all SKUS, and not just those that are compatible with your license. ::: ### Examples ```bash *** show SKUs compatible with your license (default) *** amnesiac (config) # ssc sku list +-------------+ | Sku | +-------------+ | STM-200 | | STM-SAF-400 | | STM-100 | | STM-400 | | STM-SAF-300 | | STM-300 | +-------------+ *** show all SKUs, not just those that are compatible with your license *** amnesiac (config) # ssc sku list show-all true +----------------------------+ | Sku | +----------------------------+ | BR-ADC-UTILM-WAFP1G-U-01 | | BR-ADC-UTILM-WAFP3G-U-01 | | BR-ADC-UTILM-WAFP400M-U-01 | | BR-ADC-UTILM-WAFP50M-U-01 | | BR-ADC-UTILM-WAFP5G-U-01 | . . (truncated list) . | ENT-ADVANCED | | ENT-ENTERPRISE | | ENT-WAFPROXY | +----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc stm images](docId\:Daj0PxouZD3s712K5TKUW), [ssc feature-pack create fpname](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc stm import-image file :::Paragraph{indent="1"} Imports a vTM image. ::: ### Syntax ```bash ssc stm import-image file filename-or-remote-location ``` ### Parameters ```bash filename-or-remote-location ``` :::Paragraph{indent="1"} Specify the filename or the remote location of the Traffic Manager image, for example, http, ftp, or scp URL (scp\://username\:password\@host/path/filename). ::: ### Examples ```bash amnesiac (config) # ssc stm import-image file scp://root@sf.test.com/ssc_archive/ZeusTM_97_Linux-x86_64.tgz ``` ### Related Commands :::Paragraph{indent="1"} [show ssc stm images](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc stm import-lic :::Paragraph{indent="1"} Imports the vTM Flexible Licensing Architecture (FLA) license. ::: ### Syntax ```bash ssc stm import-lic local-license | [file remote-location license-name remote-license] ``` ### Parameters ```bash local-license ``` :::Paragraph{indent="1"} Specify the filename of a locally-accessible license. ::: ```bash remote-location ``` :::Paragraph{indent="1"} Specify the remote location of the license, for example for example, http, ftp, or scp URL (scp\://username\:password\@host/path/filename). ::: ```bash remote-license ``` :::Paragraph{indent="1"} Specify the filename of a remotely-accessible license. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command can be used to import a license either from a locally-accessible license file, or a remotely-accessible license file. ::: :::hint{type="info"} You must import the following files into the Services Director before you can create instances: SSL certificate and key, Services Director license, enterprise bandwidth license key, FLA license, and Traffic Manager image. If you have not received your license files, contact Ivanti Licensing for assistance. ::: ### Examples ```bash *** local file import *** amnesiac (config) # ssc stm import-lic license.txt *** remote file import *** amnesiac (config) # ssc stm import-lic file http://remote.example.com license-name license.txt ``` ### Related Commands :::Paragraph{indent="1"} [show ssc stm images](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc template copy source :::Paragraph{indent="1"} Creates a copy of a template. ::: ### Syntax ```bash ssc template copy source template-name destination new-name ``` ### Parameters ```bash template-name ``` :::Paragraph{indent="1"} Specify the template source name. ::: ```bash destination new-name ``` :::Paragraph{indent="1"} Specify the new template name. ::: ### Examples ```bash amnesiac (config) # ssc template copy source hosttemp1 destination hosttemp2 ``` ### Related Commands :::Paragraph{indent="1"} [ssc template list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc template create template-name :::Paragraph{indent="1"} Creates a template for Services Director resources. You use templates to save resource values for reuse later. ::: ### Syntax ```bash ssc template create template-name name [arguments] ``` ### Usage Guidelines :::Paragraph{indent="1"} This command must be used in conjunction with a Services Director CLI command (see below). ::: :::Paragraph{indent="1"} Create templates for resources with the predefined parameters for use later. The predefined parameters in the template are passed to the resource. You have the option to replace or add extra parameters that exist in the specified template (that is, add extra arguments) using the resource create and update commands. ::: :::Paragraph{indent="1"} To create a feature pack** fp-1** without using the template: ::: ```bash ssc feature-pack create fpname fp-1 stm-sku STM-200 excluded 'ts comp' ``` :::Paragraph{indent="1"} To create a feature-pack template** fptemp-1** : ::: ```bash ssc template create template-name fptemp-1 stm-sku STM-200 excluded 'ts comp' ``` :::Paragraph{indent="1"} To create a feature pack** fp-2** by using template** fptemp-1** : ::: ```bash ssc feature-pack create template-name fptemp-1 fpname fp-2 info test ``` :::Paragraph{indent="1"} Update the template** fptemp-1** with new values: ::: ```bash ssc template update template-name fptemp-1 stm-sku STM-300 ``` :::Paragraph{indent="1"} To show the updated template** fptemp-1** : ::: ```bash show ssc template template-name fptemp-1 +---------------+----------+ | Field | Value | +---------------+----------+ | stm-sku | STM-300 | | excluded | ts comp | | template-name | fptemp-1 | +---------------+----------+ ``` :::Paragraph{indent="1"} Use the** no template template-name \** command option to disable the template. ::: ### Examples ```bash amnesiac (config) # ssc template create template-name fptemp-1 stm-sku STM-200 excluded 'ts comp' ``` ### Related Commands :::Paragraph{indent="1"} [ssc template list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc template list :::Paragraph{indent="1"} Lists Services Director templates. ::: ### Syntax ```bash ssc template list ``` ### Examples ```bash amnesiac (config) # ssc template list +-----------------+ | Template | +-----------------+ | fptemp1 | | hosttemp1 | +-----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc user create template-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc template update template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc template update template-name :::Paragraph{indent="1"} Updates an existing Services Director template. ::: ### Syntax ```bash ssc template update template-name [arguments] ``` ### Usage Guidelines :::Paragraph{indent="1"} Update templates to add or change common input parameters for specific resources, for example to up date the existing template **fptemp-1** with new values: ::: ### Examples ```bash ssc template update template-name fptemp-1 stm-sku STM-300 +---------------+----------+ | Field | Value | +---------------+----------+ | stm-sku | STM-300 | | excluded | ts comp | | template-name | fptemp-1 | +---------------+----------+ amnesiac (config) # ssc template update template-name fptemp-1 stm-sku STM-300 ``` ### Related Commands :::Paragraph{indent="1"} [ssc template list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc user list :::Paragraph{indent="1"} Lists the Services Director user accounts. ::: ### Syntax ```bash ssc user list ``` ### Examples ```bash amnesiac (config) # ssc user list +-------+ | User | +-------+ | admin | +-------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc user create template-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc template update template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc user create template-name :::Paragraph{indent="1"} Creates a Services Director user account based on a template. ::: ### Syntax ```bash ssc user create template-name name user-name name password password ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the template. ::: ```bash name ``` :::Paragraph{indent="1"} Specify the user name. The default name is **sscadmin**. ::: ```bash password ``` :::Paragraph{indent="1"} Specify the password for the user. ::: ### Usage Guidelines :::Paragraph{indent="1"} Creates users 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 user create template-name usertemp1 user-name test password test123 ``` ### Related Commands :::Paragraph{indent="1"} [ssc user list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc user create user-name :::Paragraph{indent="1"} Creates a Services Director user account. ::: ### Syntax ```bash ssc user create user-name name password password ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the user name. The default name is **sscadmin**. ::: ```bash password ``` :::Paragraph{indent="1"} Specify the password for the user. ::: ### Examples ```bash amnesiac (config) # ssc user create user-name test password test123 ``` ### Related Commands :::Paragraph{indent="1"} [ssc user list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc user update template-name :::Paragraph{indent="1"} Updates user settings based on the specified template. ::: ### Syntax ```bash ssc user update template-name name | [user-name name] | [active [Active | Inactive]] | [password password] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash name ``` :::Paragraph{indent="1"} Specify the user name. The default name is **sscadmin**. ::: ```bash active ``` :::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. ::: ```bash password password ``` :::Paragraph{indent="1"} Specify the password for the user. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates user settings 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 user update template-name usertemp1 user-name admin1 ``` ### Related Commands :::Paragraph{indent="1"} [ssc user list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc user update user-name :::Paragraph{indent="1"} Updates user template. ::: ### Syntax ```bash ssc user update user-name name | [active [Active | Inactive] ] [password password] [aws-access-key aws-key] [aws-secret-access-key aws-secret-key] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the user name. The default name is **sscadmin**. ::: ```bash active ``` :::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 once **Inactive** status has been specified. ::: ```bash password password ``` :::Paragraph{indent="1"} Specify the password for the user. ::: ```bash aws-key ``` :::Paragraph{indent="1"} Specify the access key for your AWS credentials. ::: ```bash aws-secret-key ``` :::Paragraph{indent="1"} Specify the secret access key for your AWS credentials. ::: ### Examples ```bash amnesiac (config) # ssc user update user-name admin1 status Inactive ``` ### Related Commands :::Paragraph{indent="1"} [ssc user list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc version create template-name :::Paragraph{indent="1"} Creates a vTM version based on a template. ::: ### Syntax ```bash ssc version create template-name name vfilename name-of-version-tarball-file vdirectory name-of-directory-to-which-tarball-extracts | [info description] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the template. ::: ```bash name-of-version-tarball-file ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager image. ::: ```bash name-of-directory-to-which-tarball-extracts ``` :::Paragraph{indent="1"} Specify the name of directory to which Traffic Manager image extracts; if none, specify the tarball name. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify information about the template. ::: ### Usage Guidelines :::Paragraph{indent="1"} Creates versions 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 version create template-name vtemp1 vfilename stm97 vdirectory ZeusTM_97_Linux-x86_64.tgz ``` ### Related Commands :::Paragraph{indent="1"} [show ssc version version-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc version list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc version create :::Paragraph{indent="1"} Creates an version name for the vTM image or tarball. ::: ### Syntax ```bash ssc version create version-name name vfilename name-of-version-tarball-file vdirectory directory-or-tarball-name | [info description] ``` ### Parameters ```bash unique-name ``` :::Paragraph{indent="1"} Specify a unique name for the Traffic Manager image. ::: ```bash name-of-version-tarball-file ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager image. ::: ```bash directory-or-tarball-name ``` :::Paragraph{indent="1"} Specify the name of directory to which tarball extracts; if none, specify the tarball name. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify a description of the image. ::: ### Usage Guidelines :::Paragraph{indent="1"} Creates a version name for the Traffic Manager image or tarball. ::: ### Examples ```bash amnesiac (config) # ssc version create version-name stm97 vfilename ZeusTM_97_Linux-x86_64.tgz ``` ### Related Commands :::Paragraph{indent="1"} [show ssc version version-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc version list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc version list :::Paragraph{indent="1"} Lists the vTM images. ::: ### Syntax ```bash ssc version list ``` ### Examples ```bash amnesiac (config) # ssc version list +---------+ | Version | +---------+ | stm97 | +---------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc version create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc version update template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc version update template-name :::Paragraph{indent="1"} Updates the version settings based on the specified template. ::: ### Syntax ```bash ssc version update template-name name | [version-name name] | [vfilename image-filename]| | [status [Active | Inactive]] | [info description] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash name-of-version-tarball-file ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager image. ::: ```bash vdirectory name-of-directory-to-which-tarball-extracts ``` :::Paragraph{indent="1"} Specify the name of directory to which Traffic Manager image extracts; if none, specify the tarball name. ::: ```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. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify a description of the template. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates version settings 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 version update template-name vtemp1 status Inactive ``` ### Related Commands :::Paragraph{indent="1"} [show ssc version version-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc version list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc version update version-name :::Paragraph{indent="1"} Updates the version. ::: ### Syntax ```bash ssc version update version-name name | [vfilename image-filename] | | [status [Active | Inactive]] | [info description] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the version name. ::: ```bash name-of-version-tarball-file ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager image. ::: ```bash status [Active | Inactive] ``` :::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. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify a description of the template. ::: ### Examples ```bash amnesiac (config) # ssc version update version-name stm97 status Inactive ``` ### Related Commands :::Paragraph{indent="1"} [show ssc version version-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc version list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-admin-ca create :::Paragraph{indent="1"} Creates a vTM CA certificate that is for use with a secure LDAP server authenticator. ::: ### Syntax ```bash ssc vtm-admin-ca create admin-ca-name tag certificate-authority certificate-text ``` ### Parameters ```bash tag ``` :::Paragraph{indent="1"} A unique name for the CA certificate. ::: ```bash certificate-text ``` :::Paragraph{indent="1"} The text of the CA certificate. ::: ### Examples ```bash *** List all vTM CA certificates on Services Director *** amnesiac (config) # ssc vtm-admin-ca list +----------+----------------------------------+ | Name | Unique ID | +----------+----------------------------------+ | VTM-CA-1 | VTM-Admin-CA-KBBH-G7LT-K6SK-B6N4 | +----------+----------------------------------+ *** add a new certificate *** amnesiac (config) # ssc vtm-admin-ca create admin-ca-name VTM-CA-2 certificate-authority "-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE----- >" +----------------------------------------------+ | Created | +----------------------------------------------+ | admin certificate authority VTM-CA-2 created | +----------------------------------------------+ *** confirm creation *** amnesiac (config) # ssc vtm-admin-ca list +----------+----------------------------------+ | Name | Unique ID | +----------+----------------------------------+ | VTM-CA-1 | VTM-Admin-CA-KBBH-G7LT-K6SK-B6N4 | | VTM-CA-2 | VTM-Admin-CA-6J21-KKH3-VSAJ-3209 | +----------+----------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc vtm-admin-ca list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-admin-ca update](docId:2xtd8nOKdlgsAEu6GI3W6), [show ssc vtm-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator add ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-admin-ca list :::Paragraph{indent="1"} Lists all vTM CA certificate that are for use with a secure LDAP server authenticator. ::: ### Syntax ```bash ssc vtm-admin-ca list ``` ### Examples ```bash amnesiac (config) # ssc vtm-admin-ca list +----------+----------------------------------+ | Name | Unique ID | +----------+----------------------------------+ | VTM-CA-1 | VTM-Admin-CA-KBBH-G7LT-K6SK-B6N4 | | VTM-CA-2 | VTM-Admin-CA-6J21-KKH3-VSAJ-3209 | +----------+----------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc vtm-admin-ca create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-admin-ca update](docId:2xtd8nOKdlgsAEu6GI3W6), [show ssc vtm-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator add ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-admin-ca update :::Paragraph{indent="1"} Updates a vTM CA certificate that is for use with a secure LDAP server authenticator. ::: ### Syntax ```bash ssc vtm-admin-ca create admin-ca-name tag certificate-authority certificate-text new-admin-ca-name new-tag ``` ### Parameters ```bash tag ``` :::Paragraph{indent="1"} A unique name for the CA certificate. ::: ```bash certificate ``` :::Paragraph{indent="1"} The text of the CA certificate. ::: ```bash new-tag ``` :::Paragraph{indent="1"} A new unique name for the CA certificate. ::: ### Examples ```bash *** list certificates *** amnesiac (config) # ssc vtm-admin-ca list +----------+----------------------------------+ | Name | Unique ID | +----------+----------------------------------+ | VTM-CA-1 | VTM-Admin-CA-KBBH-G7LT-K6SK-B6N4 | | VTM-CA-2 | VTM-Admin-CA-6J21-KKH3-VSAJ-3209 | +----------+----------------------------------+ *** rename the CA-2 certificate *** amnesiac (config) # ssc vtm-admin-ca update admin-ca-name VTM-CA-2 new-admin-ca-name V-LDP2 +------------------------------------------+ | Updated | +------------------------------------------+ | admin certificate authority CA-2 updated | +------------------------------------------+ *** confirm update *** amnesiac (config) # ssc vtm-admin-ca list +----------+----------------------------------+ | Name | Unique ID | +----------+----------------------------------+ | VTM-CA-1 | VTM-Admin-CA-KBBH-G7LT-K6SK-B6N4 | | V-LDP2 | VTM-Admin-CA-6J21-KKH3-VSAJ-3209 | +----------+----------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc vtm-admin-ca create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-admin-ca list](docId:2xtd8nOKdlgsAEu6GI3W6), [show ssc vtm-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator add ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-authenticator add ldap auth-name :::Paragraph{indent="1"} Adds an LDAP-based vTM authenticator. This can be either secure on non-secure. ::: ### Syntax ```bash ssc vtm-authenticator add ldap auth-name authenticator-name server server dn-method method filter filter base-dn base-DN fallback-group fallback-group port port timeout timeout-period group-attribute group-attribute group-field group-field bind-dn bind-DN group-filter group-filter ssl ssl [search-dn search-DN search-password password] ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify a name for the LDAP vTM authenticator. ::: ```bash server ``` :::Paragraph{indent="1"} Specify the IP address or hostname of the LDAP server. ::: ```bash method ``` :::Paragraph{indent="1"} Specify how the bind DN for a user will be derived. Either: ::: :::Paragraph{listStyleType="disc" indent="3"} construct: the bind DN for a user can be constructed from a known string, (see \) ::: :::Paragraph{listStyleType="disc" indent="3"} search: the bind DN for a user can be searched for in the directory. This is necessary if you have users under different directory paths. ::: ```bash filter ``` :::Paragraph{indent="1"} Specify a filter that uniquely identifies a user located under the Base DN. ::: :::Paragraph{indent="1"} The string "%u" will be substituted with the username. For example: ::: :::Paragraph{listStyleType="disc" indent="3"} Active Directory: "sAMAccountName=%u" ::: :::Paragraph{listStyleType="disc" indent="3"} Unix LDAP: "uid=%u" ::: ```bash base-DN ``` :::Paragraph{indent="1"} Specify the base DN (Distinguished Name) for directory searches. ::: ```bash fallback-group ``` :::Paragraph{indent="1"} Specify a permission group. For example, "admin". If \ is not defined, or is not set for the user, this permission group will be used. If not specified, users with no attribute matching group-attribute will be denied access. ::: ```bash port ``` :::Paragraph{indent="1"} Specify the port used to connect to the LDAP server. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Specify the timeout period (in seconds) for a connection to the LDAP server. ::: ```bash group-attribute ``` :::Paragraph{indent="1"} Specify the LDAP attribute that gives a user's group. For example: "memberOf". If multiple values are returned by the LDAP server, the first valid one will be used. ::: ```bash group-field ``` :::Paragraph{indent="1"} Specify the sub-field of the group-attribute that gives a user's group. For example: if \ is "memberOf" which delivers "CN=mygroup, OU=groups, OU=users, DC=mycompany, DC=local", set group-field to "CN". The first matching field will be used. ::: ```bash bind-DN ``` :::Paragraph{indent="1"} Specify a template to construct the bind DN from the username. This is only used when \ is "construct". The string "%u" is replaced by the username. For example: ::: :::Paragraph{listStyleType="disc" indent="3"} "%u\@mycompany.local" ::: :::Paragraph{listStyleType="disc" indent="3"} "cn=%u,dn=mycompany,dn=local" ::: ```bash group-filter ``` :::Paragraph{indent="1"} Specify an alternative group search filter. This is only used when the user record returned by the LDAP filter does not contain the required group information. ::: :::Paragraph{indent="1"} This will typically be required if you have Unix/POSIX-style user records. If multiple records are returned the list of group names will be extracted from all of them. ::: :::Paragraph{indent="1"} The string "%u" will be replaced by the username. For example: ::: :::Paragraph{listStyleType="disc" indent="3"} "(&(memberUid=%u)(objectClass=posixGroup))" ::: ```bash ssl ``` :::Paragraph{indent="1"} (Optional) Select the required LDAP security type: ::: :::Paragraph{listStyleType="disc" indent="3"} none. Select this if your LDAP server does not support secure connections. ::: :::Paragraph{listStyleType="disc" indent="3"} starttls. Select this if your LDAP server supports STARTTLS secure connections. You must ensure that a matching CA certificate is present to use this option. ::: :::Paragraph{listStyleType="disc" indent="3"} ldaps. Select this if your LDAP server supports LDAPS secure connections. You must ensure that a matching CA certificate is present to use this option. ::: ```bash search-DN ``` :::Paragraph{indent="1"} Specify a DN to use when searching the directory for a user's bind DN. These are only used when the DN Method is Search. You can leave these blank if it is possible to perform the bind DN search using an anonymous bind. ::: ```bash search-password ``` :::Paragraph{indent="1"} Specify the password for the search-DN. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the** no ssc vtm-authenticator auth-name** command to delete an authenticator. ::: :::Paragraph{indent="1"} You cannot delete a vTM authenticator that is associated with an access profile. ::: ### Examples ```bash *** create an LDAP authenticator *** amnesiac (config) # ssc vtm-authenticator add ldap auth-name "LDAP Server 2" server 10.62.169.170 dn-method "construct" filter "sAMAccountName=%u" base-dn "OU=users, DC=tekton, DC=local" fallback-group admin port 389 timeout 30 group-attribute "memberOf" group-field "CN" bind-dn "%u@takton.local" group-filter "(&(memberUid=%u)(objectClass=posixGroup)) ssl starttls" +-----------------------------------------+ | Created | +-----------------------------------------+ | vTM Authenticator LDAP Server 2 created | +-----------------------------------------+ *** delete an authenticator *** amnesiac (config) # no ssc vtm-authenticator auth-name "LDAP Server 2" +-----------------------------------------+ | Deleted | +-----------------------------------------+ | vTM Authenticator LDAP Server 2 deleted | +-----------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-authenticator](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-authenticator add radius auth-name :::Paragraph{indent="1"} Adds a RADIUS-based vTM authenticator. ::: ### Syntax ```bash ssc vtm-authenticator add radius auth-name authenticator-name server server fallback-group fallback-group port port timeout timeout-period group-attribute group-attribute group-vendor group-vendor secret secret nas-identifier NAS-identifier nas-ip-address NAS-ip-address ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify a name for the RADIUS vTM authenticator. ::: ```bash server ``` :::Paragraph{indent="1"} Specify the IP address or hostname of the RADIUS server. ::: ```bash fallback-group ``` :::Paragraph{indent="1"} Specify a permission group. For example, "admin". If no group is found using the vendor and group identifiers, or the group found is not valid, the permission group specified here will be used. ::: ```bash port ``` :::Paragraph{indent="1"} Specify the port used to connect to the RADIUS server. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Specify the timeout period (in seconds) for a connection to the RADIUS server. ::: ```bash group-attribute ``` :::Paragraph{indent="1"} Specify the RADIUS identifier for the attribute that specifies an account's group. May be left blank if \ is specified. ::: ```bash group-vendor ``` :::Paragraph{indent="1"} Specify the RADIUS identifier for the vendor of the RADIUS attribute that specifies an account's group. Leave blank if using a standard attribute such as Filter-Id. ::: ```bash secret ``` :::Paragraph{indent="1"} Specify the secret key shared with the RADIUS server. ::: ```bash NAS-identifier ``` :::Paragraph{indent="1"} Specify a string identifying the Network Access Server (NAS) which is requesting authentication of the user. This value is sent to the RADIUS server. If left blank the address of the interface used to connect to the server will be used. ::: ```bash NAS-ip-address ``` :::Paragraph{indent="1"} Specify the identifying IP Address of the NAS which is requesting authentication of the user. This value is sent to the RADIUS server. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the** no ssc vtm-authenticator auth-name** command to delete an authenticator. ::: :::Paragraph{indent="1"} You cannot delete a vTM authenticator that is associated with an access profile. ::: ### Examples ```bash *** create a RADIUS authenticator *** amnesiac (config) # ssc vtm-authenticator add radius auth-name "RADIUS Server 2" server 10.62.167.193 fallback-group admin port 1812 timeout 30 group-attribute 1 group-vendor 1476 secret * nas-identifier "Internal RADIUS" nas-ip-address 127.0.0.1 +-------------------------------------------+ | Created | +-------------------------------------------+ | vTM Authenticator RADIUS Server 2 created | +-------------------------------------------+ *** delete an authenticator *** amnesiac (config) # no ssc vtm-authenticator auth-name "RADIUS Server 2" +-------------------------------------------+ | Deleted | +-------------------------------------------+ | vTM Authenticator RADIUS Server 2 deleted | +-------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-authenticator](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update radius auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-authenticator add tacacs\_plus auth-name :::Paragraph{indent="1"} Adds a TACACS+-based vTM authenticator. ::: ### Syntax ```bash ssc vtm-authenticator add tacacs-plus auth-name authenticator-name server server auth-type [pap | ascii] fallback-group fallback-group port port timeout timeout-period group-field group-field group-service group-service secret secret ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify a name for the TACACS+ vTM authenticator on the Services Director. ::: ```bash server ``` :::Paragraph{indent="1"} Specify the IP address or hostname of the TACACS+ server. ::: ```bash auth-type ``` :::Paragraph{indent="1"} Specify the TACACS+ authentication type, either PAP or ACSII. ::: ```bash fallback-group ``` :::Paragraph{indent="1"} Specify a permission group. If \ is not defined, or no group value is provided for the user by the TACACS+ server, the group specified here will be used. If this is not specified, users with no TACACS+ defined group will be denied access. ::: ```bash port ``` :::Paragraph{indent="1"} Specify the port used to connect to the TACACS+ server. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Specify the timeout period (in seconds) for a connection to the TACACS+ server. ::: ```bash group-field ``` :::Paragraph{indent="1"} Specify the TACACS+ "service" field that provides each user's group. ::: ```bash group-service ``` :::Paragraph{indent="1"} Specify the TACACS+ "service" that identifies a user's group field. ::: ```bash secret ``` :::Paragraph{indent="1"} Specify the secret key shared with the TACACS+ server. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the** no ssc vtm-authenticator auth-name** command to delete an authenticator. ::: :::Paragraph{indent="1"} You cannot delete a vTM authenticator that is associated with an access profile. ::: ### Examples ```bash *** create a TACACS+ authenticator *** amnesiac (config) # ssc vtm-authenticator add tacacs-plus auth-name "TACACS+ Server 2" server 10.62.167.198 auth-type pap fallback-group admin port 49 timeout 30 group-field permission-group group-service "Hoobland" secret "tacacs_plus_secret" +--------------------------------------------+ | Created | +--------------------------------------------+ | vTM Authenticator TACACS+ Server 2 created | +--------------------------------------------+ *** delete an authenticator *** amnesiac (config) # no ssc vtm-authenticator auth-name "TACACS+ Server 2" +--------------------------------------------+ | Deleted | +--------------------------------------------+ | vTM Authenticator TACACS+ Server 2 deleted | +--------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-authenticator](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update tacacs\_plus auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-authenticator list :::Paragraph{indent="1"} Lists all defined vTM authenticators. ::: ### Syntax ```bash ssc vtm-authenticator list ``` ### Examples ```bash amnesiac (config) # ssc vtm-authenticator list +----------------+-----------------------------------+ | Name | Unique ID | +----------------+-----------------------------------+ | LDAP Server | Authenticator-D83I-9095-TT8R-CUAT | | Secure LDAP | Authenticator-J82I-2237-GR9R-ADCB | | RADIUS Server | Authenticator-808G-LJWJ-MT3B-WMDZ | | TACACS+ Server | Authenticator-7F1D-A1K3-1PO4-VSEF | +----------------+-----------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-authenticator](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-admin-ca create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator add radius auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator add tacacs\_plus auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update ldap auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update radius auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator update tacacs\_plus auth-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-authenticator update ldap auth-name :::Paragraph{indent="1"} Updates an LDAP-based vTM authenticator. ::: ### Syntax ```bash ssc vtm-authenticator update ldap auth-name authenticator-name [server server | dn-method method | filter filter | base-dn base-DN | fallback-group fallback-group | port port | timeout timeout-period | group-attribute group-attribute | group-field group-field | bind-dn bind-DN | group-filter group-filter | ssl ssl | search-dn search-DN | search-password password] ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify the name of the LDAP vTM authenticator. ::: ```bash server ``` :::Paragraph{indent="1"} Specify the IP address or hostname of the LDAP server. ::: ```bash method ``` :::Paragraph{indent="1"} Specify how the bind DN for a user will be derived. Either: ::: :::Paragraph{listStyleType="disc" indent="3"} construct: the bind DN for a user can be constructed from a known string, (see \) or ::: :::Paragraph{listStyleType="disc" indent="3"} search: the bind DN for a user can be searched for in the directory. This is necessary if you have users under different directory paths. ::: ```bash filter ``` :::Paragraph{indent="1"} Specify a filter that uniquely identifies a user located under the Base DN. ::: :::Paragraph{indent="1"} The string "%u" will be substituted with the username. For example: ::: :::Paragraph{listStyleType="disc" indent="3"} Active Directory: "sAMAccountName=%u" ::: :::Paragraph{listStyleType="disc" indent="3"} Unix LDAP: "uid=%u" ::: ```bash base-DN ``` :::Paragraph{indent="1"} Specify the base DN (Distinguished Name) for directory searches. ::: ```bash fallback-group ``` :::Paragraph{indent="1"} Specify a permission group. For example, "admin". If \ is not defined, or is not set for the user, this permission group will be used. If not specified, users with no attribute matching group-attribute will be denied access. ::: ```bash port ``` :::Paragraph{indent="1"} Specify the port used to connect to the LDAP server. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Specify the timeout period (in seconds) for a connection to the LDAP server. ::: ```bash group-attribute ``` :::Paragraph{indent="1"} Specify the LDAP attribute that gives a user's group. For example: "memberOf". If multiple values are returned by the LDAP server, the first valid one will be used. ::: ```bash group-field ``` :::Paragraph{indent="1"} Specify the sub-field of the group-attribute that gives a user's group. For example: if \ is "memberOf" which delivers "CN=mygroup, OU=groups, OU=users, DC=mycompany, DC=local", set group-field to "CN". The first matching field will be used. ::: ```bash bind-DN ``` :::Paragraph{indent="1"} Specify a template to construct the bind DN from the username. This is only used when \ is "construct". The string "%u" is replaced by the username. For example: ::: :::Paragraph{listStyleType="disc" indent="3"} "%u\@mycompany.local" ::: :::Paragraph{listStyleType="disc" indent="3"} "cn=%u,dn=mycompany,dn=local" ::: ```bash group-filter ``` :::Paragraph{indent="1"} Specify an alternative group search filter. This is only used when the user record returned by the LDAP filter does not contain the required group information. ::: :::Paragraph{indent="1"} This will typically be required if you have Unix/POSIX-style user records. If multiple records are returned the list of group names will be extracted from all of them. ::: :::Paragraph{indent="1"} The string "%u" will be replaced by the username. For example: ::: :::Paragraph{listStyleType="disc" indent="3"} "(&(memberUid=%u)(objectClass=posixGroup))" ::: ```bash ssl ``` :::Paragraph{indent="1"} (Optional) Select the required LDAP security type: ::: :::Paragraph{listStyleType="disc" indent="3"} none. Select this if your LDAP server does not support secure connections. ::: :::Paragraph{listStyleType="disc" indent="3"} starttls. Select this if your LDAP server supports STARTTLS secure connections. You must ensure that a matching CA certificate is present to use this option. ::: :::Paragraph{listStyleType="disc" indent="3"} ldaps. Select this if your LDAP server supports LDAPS secure connections. You must ensure that a matching CA certificate is present to use this option. ::: ```bash search-DN ``` :::Paragraph{indent="1"} Specify a DN to use when searching the directory for a user's bind DN. These are only used when the DN Method is Search. You can leave these blank if it is possible to perform the bind DN search using an anonymous bind. ::: ```bash search-password ``` :::Paragraph{indent="1"} Specify the password for the search-DN. ::: ### Examples ```bash amnesiac (config) # ssc vtm-authenticator update ldap auth-name "LDAP Server" server 10.62.169.170 dn-method construct filter "sAMAccountName=%u" base-dn "OU=users, DC=tekton, DC=local" fallback-group admin port 389 timeout 20 group-attribute "memberOf" group-field "CN" bind-dn "%u@takton.local" group-filter "(&(memberUid=%u)(objectClass=posixGroup))" +------------------------------------------+ | Modified | +------------------------------------------+ | vTM Authenticator LDAP Server modified | +------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-authenticator](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-admin-ca create](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-authenticator update radius auth-name :::Paragraph{indent="1"} Updates a RADIUS-based vTM authenticator. ::: ### Syntax ```bash ssc vtm-authenticator create radius auth-name authenticator-name [server server | fallback-group fallback-group | port port | timeout timeout-period | group-attribute group-attribute | group-vendor group-vendor | secret secret | nas-identifier NAS-identifier | nas-ip-address NAS-ip-address] ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify the name of the RADIUS vTM authenticator. ::: ```bash server ``` :::Paragraph{indent="1"} Specify the IP address or hostname of the RADIUS server. ::: ```bash fallback-group ``` :::Paragraph{indent="1"} Specify a permission group. For example, "admin". If no group is found using the vendor and group identifiers, or the group found is not valid, the permission group specified here will be used. ::: ```bash port ``` :::Paragraph{indent="1"} Specify the port used to connect to the RADIUS server. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Specify the timeout period (in seconds) for a connection to the RADIUS server. ::: ```bash group-attribute ``` :::Paragraph{indent="1"} Specify the RADIUS identifier for the attribute that specifies an account's group. May be left blank if \ is specified. ::: ```bash group-vendor ``` :::Paragraph{indent="1"} Specify the RADIUS identifier for the vendor of the RADIUS attribute that specifies an account's group. Leave blank if using a standard attribute such as Filter-Id. ::: ```bash secret ``` :::Paragraph{indent="1"} Specify the secret key shared with the RADIUS server. ::: ```bash NAS-identifier ``` :::Paragraph{indent="1"} Specify a string identifying the Network Access Server (NAS) which is requesting authentication of the user. This value is sent to the RADIUS server. If left blank the address of the interface used to connect to the server will be used. ::: ```bash NAS-ip-address ``` :::Paragraph{indent="1"} Specify the identifying IP Address of the NAS which is requesting authentication of the user. This value is sent to the RADIUS server. ::: ### Examples ```bash amnesiac (config) # ssc vtm-authenticator update radius auth-name "RADIUS Server" server 10.62.167.193 fallback-group admin port 1812 timeout 30 group-attribute 1 group-vendor 1476 secret "radius_secret" nas-identifier "Internal RADIUS" nas-ip-address 127.0.0.1 +--------------------------------------------+ | Modified | +--------------------------------------------+ | vTM Authenticator RADIUS Server modified | +--------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-authenticator](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator add radius auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-authenticator update tacacs\_plus auth-name :::Paragraph{indent="1"} Updates a TACACS+-based vTM authenticator. ::: ### Syntax ```bash ssc vtm-authenticator update tacacs-plus auth-name authenticator-name [server server | auth-type [pap | ascii] | fallback-group fallback-group | port port | timeout timeout-period | group-field group-field | group-service group-service | secret secret] ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify the name of the TACACS+ vTM authenticator. ::: ```bash server ``` :::Paragraph{indent="1"} Specify the IP address or hostname of the TACACS+ server. ::: ```bash auth-type ``` :::Paragraph{indent="1"} Specify the TACACS+ authentication type, either PAP or ACSII. ::: ```bash fallback-group ``` :::Paragraph{indent="1"} Specify a permission group. If \ is not defined, or no group value is provided for the user by the TACACS+ server, the group specified here will be used. If this is not specified, users with no TACACS+ defined group will be denied access. ::: ```bash port ``` :::Paragraph{indent="1"} Specify the port used to connect to the TACACS+ server. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Specify the timeout period (in seconds) for a connection to the TACACS+ server. ::: ```bash group-field ``` :::Paragraph{indent="1"} Specify the TACACS+ "service" field that provides each user's group. ::: ```bash group-service ``` :::Paragraph{indent="1"} Specify the TACACS+ "service" that identifies a user's group field. ::: ```bash secret ``` :::Paragraph{indent="1"} Specify the secret key shared with the TACACS+ server. ::: ### Examples ```bash amnesiac (config) # ssc vtm-authenticator update tacacs-plus auth-name "TACACS+ Server" server 10.62.167.198 auth-type pap fallback-group admin port 49 timeout 30 group-field permission-group group-service "Hoobland" secret "tacacs_plus_secret" +---------------------------------------------+ | Modified | +---------------------------------------------+ | vTM Authenticator TACACS+ Server 2 modified | +---------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-authenticator](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-authenticator add tacacs\_plus auth-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-authenticator list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-permission-group create pg-name :::Paragraph{indent="1"} Creates a vTM permission group for user authentication. ::: ### Syntax ```bash ssc vtm-permission-group create pg-name pg-name [description description] [timeout timeout-period] ``` ### Parameters ```bash pg-name ``` :::Paragraph{indent="1"} Specify a name for the vTM permission group. ::: ```bash description ``` :::Paragraph{indent="1"} Optionally, specify a description of the permission group. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Optionally, specify a timeout period (in minutes). ::: :::Paragraph{indent="1"} If this is not specified, it defaults to 30. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command creates the group, but does not support the setting of permissions. To set access levels for activities, see [ssh server allowed-ciphers](docId:2xtd8nOKdlgsAEu6GI3W6). ::: :::Paragraph{indent="1"} Use the** no ssc vtm-permission-group pg-name** command to delete a permission group. ::: :::Paragraph{indent="1"} You cannot delete a permission group that is associated with an access profile. ::: ### Examples ```bash amnesiac (config) # ssc vtm-permission-group create pg-name Statistics description "RO subset of monitoring" timeout 30 +-------------------------------------+ | Created | +-------------------------------------+ | permission group Statistics created | +-------------------------------------+ *** delete the Statistics permission group *** amnesiac (config) # no ssc vtm-permission-group pg-name Statistics +-------------------------------------+ | Deleted | +-------------------------------------+ | permission group Statistics deleted | +-------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-permission-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-permission-group list](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-permission-group update pg-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-permission-group list :::Paragraph{indent="1"} Lists all defined vTM permission groups. ::: ### Syntax ```bash ssc vtm-permission-group list ``` ### Examples ```bash amnesiac (config) # ssc vtm-permission-group list +------------+--------------------------------------+ | Name | Unique ID | +------------+--------------------------------------+ | admin | admin | | Demo | Demo | | Statistics | Permission-Group-E5O9-N28C-13OC-AT0I | | Monitoring | Monitoring | | Guest | Guest | +------------+--------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-permission-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-permission-group create pg-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-permission-group update pg-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc vtm-permission-group update pg-name :::Paragraph{indent="1"} Updates a vTM permission group for user authentication. ::: ### Syntax ```bash ssc vtm-permission-group update permission-group-name pg-name [new-pg-name new-gp-name] [description description] [timeout timeout-period] [[remove] permission permission access access] ``` ### Parameters ```bash pg-name ``` :::Paragraph{indent="1"} Specify a name for the vTM permission group. ::: ```bash new-pg-name ``` :::Paragraph{indent="1"} Optionally, specify a new name for the permission group. ::: ```bash description ``` :::Paragraph{indent="1"} Optionally, specify a description of the permission group. ::: ```bash timeout-period ``` :::Paragraph{indent="1"} Optionally, specify a timeout period (in minutes). ::: :::Paragraph{indent="1"} If this is not specified, it defaults to 30. ::: ```bash remove ``` :::Paragraph{indent="1"} Include this to remove the specified** permission** instead of adding it. ::: ```bash permission ``` :::Paragraph{indent="1"} The permission for which the access is to be set. ::: ```bash access ``` :::Paragraph{indent="1"} The required access (none, ro, full) for the permission. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command includes support for setting access levels for specific activities. ::: :::Paragraph{indent="1"} There are four default permission groups (**admin**,** Demo**,** Monitoring** and** Guest**), and you can create additional permission groups, see [ssc vtm-permission-group list](docId:2xtd8nOKdlgsAEu6GI3W6). ::: :::Paragraph{indent="1"} Each permission supports the following access levels: none, ro (read-only), full. ::: :::Paragraph{indent="1"} Where a permission branch node is specified as the permission, all of its leaf nodes will share the specified access level. ::: :::Paragraph{indent="1"} Where all permissions require the same access level, the permission "all" can be used. The admin permission group has this setting by default. ::: ### Examples ```bash *** update the permission group *** amnesiac (config) # ssc vtm-permission-group update pg-name my_pg permission Pools access full +--------------------------------+ | Updated | +--------------------------------+ | permission group my_pg updated | +--------------------------------+ *** display changes *** amnesiac (config) # show ssc vtm-permission-group pg-name my_pg +--------------+---------------------------------------------------+--------+ | Parameter | Value | | +--------------+---------------------------------------------------+--------+ | Name | my_pg | | | Unique Name | Permission-Group-XIG4-FUQT-YAWN-H2JF | | | Description | | | | Timeout | 30 | | | Permissions: | ------------------------------------------------- | ------ | | | Permission String | Access | | | ------------------------------------------------- | ------ | | | Connections | full | | | Connections!Details | full | | | Draining | none | | | Log_Viewer | none | | | Log_Viewer!View | none | | | Map | none | | | Monitoring | none | | | Monitoring!Edit | none | | | Pools | full | | | Pools!Edit | full | | | Pools!Edit!Autoscaling | full | | | Pools!Edit!Bandwidth | full | | | Pools!Edit!Connection_Management | full | | | Pools!Edit!DNSAutoscaling | full | | | Pools!Edit!Kerberos_Protocol_Transition | full | | | Pools!Edit!Load_Balancing | full | | | Pools!Edit!Monitors | full | | | Pools!Edit!Persistence | full | | | Pools!Edit!SSL | full | | | Request_Logs | none | | | Statd | none | | | Web_Cache | none | | | Web_Cache!Clear | none | +--------------+---------------------------------------------------+--------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc vtm-permission-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc vtm-permission-group create pg-name](docId:2xtd8nOKdlgsAEu6GI3W6), [ssc vtm-permission-group list](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssh server allowed-ciphers :::Paragraph{indent="1"} Sets the list of allowed ciphers for ssh server. ::: ### Syntax ```bash [no] ssh server allowed-ciphers ciphers ``` ### Parameters ```bash ciphers ``` :::Paragraph{indent="1"} Specify cipher or comma separated list of ciphers, in quotation marks. Default ciphers configured are aes128-ctr, aes192-ctr, and aes256-ctr. ::: :::Paragraph{indent="1"} Supported ciphers are: ::: :::Paragraph{listStyleType="disc" indent="3"} aes128cbc ::: :::Paragraph{listStyleType="disc" indent="3"} 3descbc ::: :::Paragraph{listStyleType="disc" indent="3"} blowfishcbc ::: :::Paragraph{listStyleType="disc" indent="3"} cast128cbc ::: :::Paragraph{listStyleType="disc" indent="3"} arcfour ::: :::Paragraph{listStyleType="disc" indent="3"} aes192cbc ::: :::Paragraph{listStyleType="disc" indent="3"} aes256cbc ::: :::Paragraph{listStyleType="disc" indent="3"} aes128ctr ::: :::Paragraph{listStyleType="disc" indent="3"} aes192ctr ::: :::Paragraph{listStyleType="disc" indent="3"} aes256ctr ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option resets the SSH server allowed ciphers. ::: ### Examples ```bash amnesiac (config) # ssh server allowed-ciphers "aes128-ctr,aes192-ctr,aes256-ctr" ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssh server enable :::Paragraph{indent="1"} Enables SSH access to the system. ::: ### Syntax ```bash [no] ssh server enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables SSH access. ::: ### Examples ```bash amnesiac (config) # ssh server enable ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssh server listen enable :::Paragraph{indent="1"} Enables SSH interface restriction access to the system (that is, it enables access control and blocks requests on all the interfaces). ::: ### Syntax ```bash [no] ssh server listen enable ``` ### Usage Guidelines :::Paragraph{indent="1"} If the list of interfaces is empty, none of the interfaces respond to the queries. ::: :::Paragraph{indent="1"} The **no** command option disables SSH interface restrictions which causes SSH to accept connections from all interfaces. ::: :::Paragraph{indent="1"} SSH interface restrictions are not available through the Management Console. ::: ### Examples ```bash amnesiac (config) # ssh server listen enable ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssh server listen interface :::Paragraph{indent="1"} Adds one or more interfaces to the SSH server access restriction list (thus, it unblocks requests on the specified interface). ::: ### Syntax ```bash [no] ssh server listen interface interface ``` ### Parameters ```bash interface ``` :::Paragraph{indent="1"} Specify the interface: **primary**, **aux**, **inpath0\_0**, **inpath0\_1**, **rios\_lan0\_0**, **rios\_wan0\_0** ::: ### Usage Guidelines :::Paragraph{indent="1"} If the list of interfaces is empty, none of the interfaces respond to the queries. If the list of interfaces has at least one entry, then the server listens on that subset of interfaces. ::: ### Examples ```bash amnesiac (config) # ssh server listen interface primary ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssh server port :::Paragraph{indent="1"} Sets a port for SSH access. ::: ### Syntax ```bash [no] ssh server port port ``` ### Parameters ```bash port ``` :::Paragraph{indent="1"} Specify a port for SSH access. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option resets the SSH port to its default. ::: ### Examples ```bash amnesiac (config) # ssh server port 8080 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssh server v2-only enable :::Paragraph{indent="1"} Enables SSH server to accept only v2 connections, which are more secure. ::: ### Syntax ```bash [no] ssh server v2-only enable ``` ### Usage Guidelines :::Paragraph{indent="1"} This command restricts the server to accept only v2 protocol connections, which are more secure. ::: :::Paragraph{indent="1"} The **no** command option removes the restriction. ::: ### Examples ```bash amnesiac (config) # ssh server v2-only enable ``` ### Related Commands :::Paragraph{indent="1"} [show ssc server](docId\:Daj0PxouZD3s712K5TKUW) ::: ### tcpdump stop-trigger delay :::Paragraph{indent="1"} Configures the time to wait before stopping a TCP dump. ::: ### Syntax ```bash [no] tcpdump stop-trigger delay duration ``` ### Parameters ```bash duration ``` :::Paragraph{indent="1"} Specify the amount of time to wait before stopping all running TCP dumps when RiOS finds a match. The default delay is 30 seconds. ::: ### Usage Guidelines :::Paragraph{indent="1"} You might not want to stop your TCP dump immediately. By configuring a delay, the system has time to log more data without abruptly cutting off the dumps. The default delay is 30 seconds. ::: ### Examples ```bash amnesiac (config) # tcpdump stop-trigger delay 10 ``` ### Related Commands :::Paragraph{indent="1"} [tcpdump stop-trigger enable](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger regex](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger restart](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### tcpdump stop-trigger enable :::Paragraph{indent="1"} Enables the TCP dump to stop running, triggered by a match against a configured regular expression and the system log file. ::: ### Syntax ```bash [no] tcpdump stop-trigger enable ``` ### Usage Guidelines :::Paragraph{indent="1"} There is a limit to the amount of TCP dump data the system can collect. After a problem has occurred, the TCP dump buffer could have rotated, overwriting the information about the problem. This command enables a trigger that stops a continuous TCP dump after a specific log event occurs. This enables you to troubleshoot issues and isolate the TCP dump data specific to a problem. ::: :::Paragraph{indent="1"} The **no** version of the command disables the TCP dump stop-trigger process. ::: ### Examples ```bash amnesiac (config) # tcpdump stop-trigger regex ntp amnesiac (config) # tcpdump stop-trigger delay 20 amnesiac (config) # tcpdump stop-trigger enable ``` ### Related Commands :::Paragraph{indent="1"} [tcpdump stop-trigger delay](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger regex](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger restart](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### tcpdump stop-trigger regex :::Paragraph{indent="1"} Sets the regular expression that triggers the stopping of TCP dumps. ::: ### Syntax ```bash tcpdump stop-trigger regex regex ``` ### Parameters ```bash regex ``` :::Paragraph{indent="1"} Specify a PERL regular expression to match. RiOS compares the PERL regular expression against each entry made to the system logs. The system matches on a per-line basis. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **tcpdump stop-trigger regex** command to configure a regular expression that represents a condition that, when matched, stops all running TCP dumps. After this match is found, all TCP dump sessions are stopped after the delay configured by the** tcpdump stop-trigger delay** command. ::: ### Examples :::Paragraph{indent="1"} In the following example, RiOS searches for the pattern ntp in the system logs. The system waits 20 seconds after there is a match and then stops all TCP dumps that are still running. ::: ```bash amnesiac (config) # tcpdump stop-trigger regex ntp amnesiac (config) # tcpdump stop-trigger delay 20 amnesiac (config) # tcpdump stop-trigger enable ``` ### Related Commands :::Paragraph{indent="1"} [tcpdump stop-trigger delay](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger enable](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger restart](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### tcpdump stop-trigger restart :::Paragraph{indent="1"} Restarts the TCP dump stop-trigger process. ::: ### Syntax ```bash tcpdump stop-trigger restart ``` ### Usage Guidelines :::Paragraph{indent="1"} If you change the regular expression or delay, use the **tcpdump stop-trigger restart** command to restart the stop-trigger process. ::: ### Examples ```bash amnesiac (config) # tcpdump stop-trigger regex ntp amnesiac (config) # tcpdump stop-trigger delay 50 amnesiac (config) # tcpdump stop-trigger enable amnesiac (config) # tcpdump stop-trigger restart ``` ### Related Commands :::Paragraph{indent="1"} [tcpdump stop-trigger delay](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger enable](docId:2xtd8nOKdlgsAEu6GI3W6), [tcpdump stop-trigger regex](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### tcpdump-x all-interfaces :::Paragraph{indent="1"} Configures a list of all interfaces for a TCP dump capture. ::: ### Syntax ```bash [no] tcpdump-x all-interfaces [capture-name capture-name] continuous | | buffer-size size-in-KB | duration seconds [schedule-time HH:MM:SS [schedule-date YYYY/MM/DD]] | [rotate-count num-files] | [snaplength snaplength] | [sip src-addr] | [dip dst-addr] | [sport src-port] | [dport dst-port] | [dot1q {tagged | untagged | both}] | [ip6] | [custom custom-param] | [file-size megabytes] ``` ### Parameters ```bash capture-name capture-name ``` :::Paragraph{indent="1"} Specify a capture name to help you identify the TCP Dump. The default filename uses the following format: ::: ```bash __.cap ``` :::Paragraph{indent="1"} Where hostname is the hostname of the appliance, interface is the name of the interface selected for the trace (for example,** lan0\_0**,** wan0\_0**), and timestamp is in the YYYY-MM-DD-HH-MM-SS format. ::: :::hint{type="info"} The cap file extension is not included with the filename when it appears in the capture queue. ::: ```bash continuous ``` :::Paragraph{indent="1"} Start a continuous capture. ::: ```bash buffer-size size-in-KB ``` :::Paragraph{indent="1"} Specify the size in KB for all packets. ::: ```bash duration seconds ``` :::Paragraph{indent="1"} Specify the run time for the capture in seconds. The default is 30 seconds. ::: ```bash schedule-time HH:MM:SS ``` :::Paragraph{indent="1"} Specify a time to initiate the trace dump in the following format: HH\:MM\:SS. ::: ```bash schedule-date YYYY/MM/DD ``` :::Paragraph{indent="1"} Specify a date to initiate the trace dump in the following format: YYYY/MM/DD ::: ```bash rotate-count num-files ``` :::Paragraph{indent="1"} Specify the number of files to rotate. ::: ```bash snaplength snaplength ``` :::Paragraph{indent="1"} Specify the snap length value for the trace dump. The default value is 1518. Specify** 0** for a full packet capture (recommended for CIFS, MAPI, and SSL traces). ::: ```bash sip src-addr ``` :::Paragraph{indent="1"} Specify a comma-separated list of source IP addresses. The default setting is all IP addresses. ::: ```bash dip dst-addr ``` :::Paragraph{indent="1"} Specify a comma-separated list of destination IP addresses. The default setting is all IP addresses. ::: ```bash sport src-port ``` :::Paragraph{indent="1"} Specify a comma-separated list of source ports. The default setting is all ports. ::: ```bash dport dst-port ``` :::Paragraph{indent="1"} Specify a comma-separated list of destination ports. The default setting is all ports. ::: ```bash dot1q ``` :::Paragraph{indent="1"} Specify one of the following to filter dot1q packets: ::: :::Paragraph{listStyleType="disc" indent="3"} tagged: Capture only tagged traffic. ::: :::Paragraph{listStyleType="disc" indent="3"} untagged: Capture only untagged traffic. ::: :::Paragraph{listStyleType="disc" indent="3"} both: Capture all traffic. ::: :::hint{type="info"} Do not use the** sip**,** dip**,** sport**,** dport** and** custom** parameters together when using the** dot1q both** option. Use the** tcpdump** command instead to capture this information. ::: :::Paragraph{indent="1"} For detailed information about dot1q VLAN tunneling, see your networking equipment documentation. ::: ```bash ip6 ``` :::Paragraph{indent="1"} Specify IPv6 packets for packet capture. ::: ```bash custom custom-param ``` :::Paragraph{indent="1"} Specify custom parameters (flags) for packet capture. You need to enclose the customer parameter in quotes if it contains more than one word. ::: ```bash file-size megabytes ``` :::Paragraph{indent="1"} Specify the file size of the capture in megabytes. ::: ### Usage Guidelines :::Paragraph{indent="1"} You can capture and retrieve multiple TCP trace dumps. You can generate trace dumps from multiple interfaces at the same time and you can schedule a specific date and time to generate a trace dump. ::: ### Examples :::Paragraph{indent="1"} The following example starts a continuous capture for a file named tcpdumpexample with a duration of 120 seconds: ::: ```bash amnesiac (config) # tcpdump-x all-interfaces capture-name tcpdumpexample continuous duration 120 ``` :::Paragraph{indent="1"} The following example captures untagged traffic on destination port 7850 and ARP packets: ::: ```bash amnesiac (config) # tcpdump-x all-interfaces dot1q untagged dport 7850 custom "and arp" ``` :::Paragraph{indent="1"} The following example captures VLAN tagged traffic for host 10.11.0.6 and ARP packets: ::: ```bash amnesiac (config) # tcpdump-x all-interfaces dot1q tagged sip 10.11.0.6 custom "or arp" ``` :::Paragraph{indent="1"} The following example captures tagged ARP packets only: ::: ```bash amnesiac (config) # tcpdump-x all-interfaces dot1q tagged custom "and arp" ``` :::Paragraph{indent="1"} The following example captures untagged ARP packets only: ::: ```bash amnesiac (config) # tcpdump-x all-interfaces dot1q untagged custom "and arp" ``` ### Related Commands :::Paragraph{indent="1"} [show tcpdump-x](docId\:q-wP5fTzpWO2TO-RsyDPo), [tcpdump](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### tcpdump-x capture-name stop :::Paragraph{indent="1"} Stops the specified TCP dump capture. ::: ### Syntax ```bash [no] tcpdump-x capture-name capture-name stop ``` ### Parameters ```bash capture-name ``` :::Paragraph{indent="1"} Specify the capture name to stop. ::: ### Examples ```bash amnesiac (config) # tcpdump-x capture-name example stop ``` ### Related Commands :::Paragraph{indent="1"} [show tcpdump-x](docId\:q-wP5fTzpWO2TO-RsyDPo), [tcpdump](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### tcpdump-x interfaces :::Paragraph{indent="1"} Configures a comma-separated list of interfaces to capture in the background. ::: ### Syntax ```bash [no] tcpdump-x interfaces interface-name continuous | duration seconds [schedule-time HH:MM:SS [schedule-date YYYY/MM/DD]] | [rotate-count num-files] | [snaplength snaplength] | [sip src-addr] | [dip dst-addr] | [sport src-port] [dport dst-port] | [dot1q {tagged | untagged | both}] [ip6] | [custom custom-param] | [file-size megabytes] ``` ### Parameters ```bash interface-name ``` :::Paragraph{indent="1"} Specify a comma-separated list of interfaces: **primary**, **aux**, **lan0\_0**, **wan0\_0** ::: ```bash continuous ``` :::Paragraph{indent="1"} Start a continuous capture. ::: ```bash duration seconds ``` :::Paragraph{indent="1"} Specify the run time for the capture in seconds. ::: ```bash schedule-time HH:MM:SS ``` :::Paragraph{indent="1"} Specify a time to initiate the trace dump in the following format: HH\:MM\:SS ::: ```bash schedule-date YYYY/MM/DD ``` :::Paragraph{indent="1"} Specify a date to initiate the trace dump in the following format: YYYY/MM/DD ::: ```bash rotate-count num-files ``` :::Paragraph{indent="1"} Specify the number of files to rotate. ::: ```bash snaplength snaplength ``` :::Paragraph{indent="1"} Specify the snap length value for the trace dump. The default value is 1518. Specify **0** for a full packet capture (recommended for CIFS, MAPI, and SSL traces). ::: ```bash sip src-addr ``` :::Paragraph{indent="1"} Specify the source IP addresses. The default setting is all IP addresses. ::: ```bash dip dst-addr ``` :::Paragraph{indent="1"} Specify a comma-separated list of destination IP addresses. The default setting is all IP addresses. ::: ```bash sport src-port ``` :::Paragraph{indent="1"} Specify a comma-separated list of source ports. The default setting is all ports. ::: ```bash dport dst-port ``` :::Paragraph{indent="1"} Specify a comma-separated list of destination ports. The default setting is all ports. ::: ```bash dot1q ``` :::Paragraph{indent="1"} Specify one of the following to filter dot1q packets: ::: :::Paragraph{listStyleType="disc" indent="3"} tagged: Capture only tagged traffic. ::: :::Paragraph{listStyleType="disc" indent="3"} untagged: Capture only untagged traffic. ::: :::Paragraph{listStyleType="disc" indent="3"} both: Capture all traffic. ::: :::hint{type="info"} Do not use the **sip**, **dip**, **sport**, **dport** and **custom** parameters together when using the **dot1q both** option. Use the **tcpdump** command to capture this information. ::: :::Paragraph{indent="1"} For detailed information about dot1q VLAN tunneling, see your networking equipment documentation. ::: ```bash ip6 ``` :::Paragraph{indent="1"} Specify IPv6 packets for packet capture. ::: ```bash custom custom-param ``` :::Paragraph{indent="1"} Specify custom parameters (flags) for packet capture. ::: ```bash file-size megabytes ``` :::Paragraph{indent="1"} Specify the file size of the capture in megabytes. ::: ### Examples ```bash amnesiac (config) # tcpdump-x interfaces inpath0_0 continuous amnesiac (config) # tcpdump-x interfaces aux ip6 sip 2003::5 ``` ### Related Commands :::Paragraph{indent="1"} [show tcpdump-x](docId\:q-wP5fTzpWO2TO-RsyDPo), [tcpdump](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### telnet-server enable :::Paragraph{indent="1"} Enables you to access the CLI using telnet. This feature is disabled by default. ::: ### Syntax ```bash [no] telnet-server enable ``` ### Usage Guidelines :::Paragraph{indent="1"} You can use telnet to troubleshoot your system. It enables you to access the CLI from another system. ::: ### Examples ```bash amnesiac (config) # telnet-server enable ``` ### Related Commands :::Paragraph{indent="1"} [show telnet-server](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### username disable :::Paragraph{indent="1"} Disables the account so that no one can log in. ::: ### Syntax ```bash [no] username userid disable ``` ### Parameters ```bash userid ``` :::Paragraph{indent="1"} Specify the user login: **admin** or **monitor**. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option re-enables the specified user account. ::: ### Examples ```bash amnesiac (config) # username monitor disable ``` ### Related Commands :::Paragraph{indent="1"} [ssh client generate identity user](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### username nopassword :::Paragraph{indent="1"} Disables password protection for a user. ::: ### Syntax ```bash username userid nopassword ``` ### Parameters ```bash userid ``` :::Paragraph{indent="1"} Specify the user login: **admin** or **monitor**. ::: ### Examples ```bash amnesiac (config) # username monitor nopassword ``` ### Related Commands :::Paragraph{indent="1"} [ssh client generate identity user](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### username password :::Paragraph{indent="1"} Sets the password for the specified user. ::: ### Syntax ```bash username userid password cleartext [old-password cleartext] ``` ### Parameters ```bash userid ``` :::Paragraph{indent="1"} Specify the user login: **admin** or **monitor**. ::: ```bash password cleartext ``` :::Paragraph{indent="1"} Specify the new password. The password must be at least 6 characters. ::: ```bash old-password cleartext ``` :::Paragraph{indent="1"} Specify the old password. ::: ### Usage Guidelines :::Paragraph{indent="1"} The password is entered in cleartext format on the command line. ::: :::Paragraph{indent="1"} The **old-password** option allows you to check the minimum character difference between the old and new passwords under account control management. ::: ### Examples ```bash amnesiac (config) # username admin password xyzzzZ ``` ### Related Commands :::Paragraph{indent="1"} [ssh client generate identity user](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### username password 0 :::Paragraph{indent="1"} Sets the password for the specified user. ::: ### Syntax ```bash username userid password 0 cleartext-password ``` ### Parameters ```bash userid ``` :::Paragraph{indent="1"} Specify the user login: **admin** or **monitor**. ::: ```bash cleartext-password ``` :::Paragraph{indent="1"} Specify the password. The password must be at least 6 characters. ::: ### Usage Guidelines :::Paragraph{indent="1"} The password is entered in cleartext format on the command line. ::: ### Examples ```bash amnesiac (config) # username admin password 0 xyzzzZ ``` ### Related Commands :::Paragraph{indent="1"} [ssh client generate identity user](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### username password 7 :::Paragraph{indent="1"} Sets the password for the specified user using the encrypted format of the password. Use this command if it becomes necessary to restore your appliance configuration, including the password. ::: ### Syntax ```bash username userid password 7 encrypted-password ``` ### Parameters ```bash userid ``` :::Paragraph{indent="1"} Specify the user login: **admin** or **monitor**. ::: ```bash encrypted-password ``` :::Paragraph{indent="1"} Specify the encrypted password. The password must be at least 6 characters. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use this command to restore your password using an encrypted version of the password. You can display the encrypted version of the password using the **show running configuration** command. ::: :::Paragraph{indent="1"} For example, executing **username monitor password awesomepass** results in the following line being added to the running configuration file: ::: ```bash username monitor password 7 $1$f2Azp8N8$n0oy6Y1KhCfuMo93f24ku/ ``` :::Paragraph{indent="1"} If you need to restore your password in the future, you would paste: ::: ```bash username monitor password 7 $1$f2Azp8N8$n0oy6Y1KhCfuMo93f24ku/ ``` :::Paragraph{indent="1"} in the CLI, to restore your monitor password to **awesomepass**. ::: ### Examples ```bash amnesiac (config) # username admin password 7 $1$f2Azp8N8$n0oy6Y1KhCfuMo93f24ku/ ``` ### Related Commands :::Paragraph{indent="1"} [ssh client generate identity user](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### web auto-logout :::Paragraph{indent="1"} Sets the number of minutes before the Management Console automatically logs out the user. ::: ### Syntax ```bash [no] web auto-logout minutes ``` ### Parameters ```bash minutes ``` :::Paragraph{indent="1"} Specify the number of minutes before the system automatically logs out the user. The default value is 15 minutes. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the automatic log out feature. ::: ### Examples ```bash amnesiac (config) # web auto-logout 20 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web auto-refresh timeout :::Paragraph{indent="1"} Enables session timeouts on auto-refreshing report pages. ::: ### Syntax ```bash [no] web auto-refresh timeout ``` ### Usage Guidelines :::Paragraph{indent="1"} Disabling this feature keeps you logged in indefinitely on a report page that is auto-refreshing. This can be a security risk. ::: :::Paragraph{indent="1"} The **no** command option disables time-out. ::: ### Examples ```bash amnesiac (config) # web auto-refresh timeout ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web enable :::Paragraph{indent="1"} Enables the Management Console. ::: ### Syntax ```bash [no] web enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The Management Console is enabled by default. ::: :::Paragraph{indent="1"} The **no** command option disables the Management Console. ::: ### Examples ```bash amnesiac (config) # web enable ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web http enable :::Paragraph{indent="1"} Enables HTTP access to the Management Console. ::: ### Syntax ```bash [no] web http enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The Management Console is enabled by default. ::: :::Paragraph{indent="1"} The **no** command option disables the Management Console. ::: ### Examples ```bash amnesiac (config) # web http enable ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web http port :::Paragraph{indent="1"} Sets the Web port for HTTP access. ::: ### Syntax ```bash [no] web http port port ``` ### Parameters ```bash port ``` :::Paragraph{indent="1"} Specify the port number. The default value is 80. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option resets the Web port to the default value. ::: ### Examples ```bash amnesiac (config) # web http port 8080 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web httpd listen enable :::Paragraph{indent="1"} Restricts Web interface access to this system (that is, it enables access control and blocks requests on all the interfaces). ::: ### Syntax ```bash [no] web httpd listen enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables Web interface restrictions. ::: :::Paragraph{indent="1"} Web interface restrictions are not available through the Management Console. ::: ### Examples ```bash amnesiac (config) # web httpd listen enable ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web httpd listen interface :::Paragraph{indent="1"} Adds an interface to the Web server access restriction list. ::: ### Syntax ```bash [no] web httpd listen interface interface ``` ### Parameters ```bash interface ``` :::Paragraph{indent="1"} Specify the interface: **primary**, **aux**, **inpath0\_0**, **rios\_lan0\_0**, **rios\_wan0\_0** ::: ### Usage Guidelines :::Paragraph{indent="1"} If the list of interfaces is empty, none of the interfaces respond to the queries. If the list of interfaces has at least one entry, then the server listens on that subset of interfaces. ::: ### Examples ```bash amnesiac (config) # web httpd listen interface aux ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web httpd log-format :::Paragraph{indent="1"} Changes the Web server log format (Apache httpd LogFormat). ::: ### Syntax ```bash [no] web httpd log-format log-format-for-Apache-httpd ``` ### Parameters ```bash log-format-for-Apache-httpd ``` :::Paragraph{indent="1"} Specify the log format arguments for Apache LogFormat. For detailed information about the Apache LogFormat arguments, see http\://httpd.apache.org/docs. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables Web log-format. ::: ### Examples ```bash amnesiac (config) # web httpd log-format "%h %l %u %t \"%r\" %>s %b" ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web httpd server-header :::Paragraph{indent="1"} Changes the Apache Server header line. (Apache httpd LogFormat). ::: ### Syntax ```bash [no] web httpd server-header "Server:"-header-line ``` ### Parameters ```bash "Server:"-header-line ``` :::Paragraph{indent="1"} Specify the log format arguments for Apache LogFormat. For detailed information about the Apache Server header line, see http\://httpd.apache.org/docs. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables Web log-format. ::: ### Examples ```bash amnesiac (config) # web httpd server-header "Server:Example HTTPD Server" ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web httpd timeout :::Paragraph{indent="1"} Configures the Web server timeout period. ::: ### Syntax ```bash [no] web httpd timeout number-of-seconds ``` ### Parameters ```bash number-of-seconds ``` :::Paragraph{indent="1"} Specify the Web server timeout period in seconds. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables Web log-format. ::: ### Examples ```bash amnesiac (config) # web httpd log-format "%h %l %u %t \"%r\" %>s %b" ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web https enable :::Paragraph{indent="1"} Enables HTTPS access to the Web-based management console. ::: ### Syntax ```bash [no] web https enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables access to the Web-based management console. ::: ### Examples ```bash amnesiac (config) # web https enable ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web https port :::Paragraph{indent="1"} Sets the HTTPS secure Web port. ::: ### Syntax ```bash [no] web https port port ``` ### Parameters ```bash port ``` :::Paragraph{indent="1"} Specify the port number. The default value is **80**. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables support on a secure port. ::: ### Examples ```bash amnesiac (config) # web https port 8080 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web prefs log lines :::Paragraph{indent="1"} Sets the number of lines for the system log page. ::: ### Syntax ```bash [no] web prefs log lines number ``` ### Parameters ```bash number ``` :::Paragraph{indent="1"} Specify the number of lines per log page. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the number of log lines. ::: ### Examples ```bash amnesiac (config) # web prefs logs lines 10 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web proxy host :::Paragraph{indent="1"} Sets the HTTP, HTTPS, and FTP proxy. ::: ### Syntax ```bash [no] web proxy host ip-addr [port port] [user-cred username username password password [authtype authentication-type]] ``` ### Parameters ```bash ip-addr ``` :::Paragraph{indent="1"} Specify the IP address for the host. ::: ```bash port port ``` :::Paragraph{indent="1"} Specify the port for the host. ::: ```bash user-cred ``` :::Paragraph{indent="1"} Optionally, specify the user credentials for the autolicensing feature: ::: :::Paragraph{listStyleType="disc" indent="3"} username username: Specify the user name. ::: :::Paragraph{listStyleType="disc" indent="3"} password password: Specify the password, in cleartext format. ::: ```bash authtype authentication-type ``` :::Paragraph{indent="1"} Optionally, specify the authentication type: ::: :::Paragraph{listStyleType="disc" indent="3"} basic: Authenticates user credentials by requesting a valid user name and password. This is the default setting. ::: :::Paragraph{listStyleType="disc" indent="3"} digest: Provides the same functionality as basic authentication; however, digest authentication improves security because the system sends the user credentials across the network as a Message Digest 5 (MD5) hash. ::: :::Paragraph{listStyleType="disc" indent="3"} ntlm: Authenticates user credentials based on an authentication challenge and response. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use this command to enable the appliance to use a Web proxy to contact the Ivanti licensing portal and fetch licenses in a secure environment. You can optionally require user credentials to communicate with the Web proxy for use with the autolicensing feature. You can specify the method used to authenticate and negotiate these user credentials. ::: :::Paragraph{indent="1"} The **no** command option resets the Web proxy settings to the default behavior. Web proxy access is disabled by default. ::: :::Paragraph{indent="1"} RiOS supports the following proxies: Squid, Blue Coat Proxy SG, Microsoft WebSense, and McAfee Web Gateway. ::: ### Examples ```bash amnesiac (config) # web proxy host 10.1.2.1 port 1220 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web rest-server enable :::Paragraph{indent="1"} Enables the REST (REpresentational State Transfer) server. ::: ### Syntax ```bash [no] web rest-server enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command disables the REST server. ::: ### Examples ```bash amnesiac (config) # web rest-server enable ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web session renewal :::Paragraph{indent="1"} Sets the session renewal time. This is the time before the Web session time-out. If a Web request comes in, it automatically renews the session. ::: ### Syntax ```bash [no] web session renewal minutes ``` ### Parameters ```bash minutes ``` :::Paragraph{indent="1"} Specify the number of minutes. The default value is **10** minutes. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option resets the session renewal time to the default value. ::: ### Examples ```bash amnesiac (config) # web session renewal 5 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web session timeout :::Paragraph{indent="1"} Sets the session time-out value. This is the amount of time the cookie is active. ::: ### Syntax ```bash [no] web session timeout minutes ``` ### Parameters ```bash minutes ``` :::Paragraph{indent="1"} Specify the number of minutes. The default value is **60** minutes. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option resets the session time-out to the default value. ::: ### Examples ```bash amnesiac (config) # web session timeout 120 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web snmp-trap conf-mode enable :::Paragraph{indent="1"} Enables SNMP traps in Web configure mode. ::: ### Syntax ```bash [no] web snmp-trap conf-mode enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web snmp-trap conf-mode enable ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web soap-server enable :::Paragraph{indent="1"} Enables the Simple Object Access Protocol (SOAP) server. ::: ### Syntax ```bash [no] web soap-server enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web soap-server enable ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web soap-server port :::Paragraph{indent="1"} Enables the Simple Object Access Protocol (SOAP) server port. ::: ### Syntax ```bash [no] web soap-server port port ``` ### Parameters ```bash port ``` :::Paragraph{indent="1"} Specify the port. ::: ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web soap-server port 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show web](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl cert generate :::Paragraph{indent="1"} Generates a new SSL key and self-signed certificate. ::: ### Syntax ```bash web ssl cert generate | [key-size 512 | 1024 | 2048] | [country string] | [email email-address] | [locality string] | [org string] | [org-unit string] | [state string] | [valid-days integer] ``` ### Parameters ```bash key-size ``` :::Paragraph{indent="1"} Specify the key size. ::: ```bash country string ``` :::Paragraph{indent="1"} Specify the certificate two-letter country code. The country code can be any two-letter code, such as the ISO 3166 Country Codes, as long as the appropriate Certificate Authority can verify the code. ::: ```bash email email-address ``` :::Paragraph{indent="1"} Specify the email address of the contact person. ::: ```bash locality string ``` :::Paragraph{indent="1"} Specify the city. ::: ```bash org string ``` :::Paragraph{indent="1"} Specify the organization. ::: ```bash org-unit string ``` :::Paragraph{indent="1"} Specify the organization unit (for example, the company). ::: ```bash state string ``` :::Paragraph{indent="1"} Specify the state. You cannot use abbreviations. ::: ```bash valid-days integer ``` :::Paragraph{indent="1"} Specify how many days the certificate is valid. If you omit **valid-days**, the default is 2 years. ::: ### Examples ```bash amnesiac (config) # web ssl cert generate ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl cert generate-csr :::Paragraph{indent="1"} Generates a certificate signing request with current private key. ::: ### Syntax ```bash web ssl cert generate-csr [common-name name] [country string] [email email-address] [locality string] [org string] [org-unit string] [state string] ``` ### Parameters ```bash common-name name ``` :::Paragraph{indent="1"} Specify the common name of the certificate authority. ::: ```bash country string ``` :::Paragraph{indent="1"} Specify the certificate two-letter country code. The country code can be any two-letter code, such as the ISO 3166 Country Codes, as long as the appropriate Certificate Authority can verify the code. ::: ```bash email email-address ``` :::Paragraph{indent="1"} Specify the email address of the contact person. ::: ```bash locality string ``` :::Paragraph{indent="1"} Specify the city. ::: ```bash org string ``` :::Paragraph{indent="1"} Specify the organization. ::: ```bash org-unit string ``` :::Paragraph{indent="1"} Specify the organization unit (for example, the company). ::: ```bash state string ``` :::Paragraph{indent="1"} Specify the state. You cannot use abbreviations. ::: ```bash valid-days int ``` :::Paragraph{indent="1"} Specify how many days the certificate is valid. If you omit **valid-days**, the default is 2 years. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is available on the Interceptor appliance starting in version 4.0. ::: ### Examples ```bash amnesiac (config) # web ssl cert generate-csr ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl cert import-cert :::Paragraph{indent="1"} Imports a certificate, optionally with current private key, in PEM format, and optionally a password. ::: ### Syntax ```bash web ssl cert import-cert cert-data import-key key [password password] ``` ### Parameters ```bash import-cert cert-data ``` :::Paragraph{indent="1"} Specify the text of the certificate file in PEM format. ::: ```bash import-key key ``` :::Paragraph{indent="1"} Specify the text of the private key in PEM format. ::: ```bash password password ``` :::Paragraph{indent="1"} Optionally, specify a password. ::: ### Usage Guidelines :::Paragraph{indent="1"} If no key is specified the incoming certificate is matched with the existing private key, and accepted if the two match. A password is required if imported certificate data is encrypted. ::: ### Examples ```bash amnesiac (config) # web ssl cert import-cert import-key ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl cert import-cert-key :::Paragraph{indent="1"} Imports a certificate with current private key in PEM format. ::: ### Syntax ```bash web ssl cert import-cert-key cert-key-data [password password] ``` ### Parameters ```bash import-cert-key cert-key-data ``` :::Paragraph{indent="1"} Specify the text of the private key and certificate file in PEM format. ::: ```bash [password password] ``` :::Paragraph{indent="1"} Optionally, specify a password. ::: ### Examples ```bash amnesiac (config) # web ssl cert import-cert-key ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl protocol sslv2 :::Paragraph{indent="1"} Sets the SSL v2 protocols for Apache to use. ::: ### Syntax ```bash [no] web ssl protocol sslv2 ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web ssl protocol sslv2 ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl protocol sslv3 :::Paragraph{indent="1"} Sets the SSL v3 protocols for Apache to use. ::: ### Syntax ```bash [no] web ssl protocol sslv3 ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web ssl protocol sslv3 ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl protocol tlsv1 :::Paragraph{indent="1"} Sets the SSL v1 protocols for Apache to use. ::: ### Syntax ```bash [no] web ssl protocol tlsv1 ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web ssl protocol tlsv1 ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl protocol tlsv1.1 :::Paragraph{indent="1"} Sets the SSL v1.1 protocols for Apache to use. ::: ### Syntax ```bash [no] web ssl protocol tlsv1.1 ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web ssl protocol tlsv1.1 ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### web ssl protocol tlsv1.2 :::Paragraph{indent="1"} Sets the SSL v1.2 protocols for Apache to use. ::: ### Syntax ```bash [no] web ssl protocol tlsv1.2 ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables this setting. ::: ### Examples ```bash amnesiac (config) # web ssl protocol tlsv1.2 ``` ### Related Commands :::Paragraph{indent="1"} [show web ssl cert](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### write memory :::Paragraph{indent="1"} Saves the current configuration settings to memory. ::: ### Syntax ```bash write memory ``` ### Examples ```bash amnesiac (config) # write memory ``` ### Related Commands :::Paragraph{indent="1"} [show info](docId\:q-wP5fTzpWO2TO-RsyDPo) ::: ### write terminal :::Paragraph{indent="1"} Displays commands to recreate current running configuration. ::: ### Syntax ```bash write terminal ``` ### Examples ```bash amnesiac (config) # write terminal ``` ### Related Commands :::Paragraph{indent="1"} [show info](docId\:q-wP5fTzpWO2TO-RsyDPo) :::