--- title: Config-Mode Commands slug: ps/help/en_us/sd/25x/cli/H010-config-mode-commands docTags: createdAt: 2026-10-06T15:00:40.431Z --- ### ssc host host-name interface dhcp :::Paragraph{indent="1"} Configures host instance DHCP on the specified interface. ::: ### Syntax ```bash ssc host host host-name name interface interface-name dhcp | [dns-nameservers dns-name-servers] | [dns-search dns-suffixes] | [auto] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the host name. ::: ```bash interface interface-name ``` :::Paragraph{indent="1"} Specify the interface name ::: ```bash dhcp ``` :::Paragraph{indent="1"} Specify to enable DHCP on this interface. ::: ```bash dns-nameservers dns-name-servers ``` :::Paragraph{indent="1"} Optionally, specify the DNS name server. ::: ```bash dns-search dns-suffixes ``` :::Paragraph{indent="1"} Optionally, specify a comma separated list of searched domain suffixes. ::: ```bash auto ``` :::Paragraph{indent="1"} Optionally, specify this interface to automatically start up. ::: ### Examples ```bash amnesiac (config) # ssc host host host-name host1 interface lxcbr0 dhcp ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc host host-name interface ip :::Paragraph{indent="1"} Configures the static IP address for the specified interface. ::: ### Syntax ```bash ssc host host host-name name interface interface-name ip ip-addr netmask netmask | [gateway ip-addr] | [dns-nameservers dns-name-servers] | [dns-search dns-suffixes] | [auto] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the host. ::: ```bash interface interface-name ``` :::Paragraph{indent="1"} Specify the interface name ::: ```bash ip ip-addr ``` :::Paragraph{indent="1"} Specify the IP address on this interface. ::: ```bash netmask netmask-addr ``` :::Paragraph{indent="1"} Specify the netmask address. ::: ```bash gateway ip-addr ``` :::Paragraph{indent="1"} Specify the IP address for the gateway. ::: ```bash dns-nameservers dns-name-servers ``` :::Paragraph{indent="1"} Specify the DNS name server. ::: ```bash dns-search dns-suffixes ``` :::Paragraph{indent="1"} Optionally, specify a comma separated list of searched domain suffixes. ::: ```bash auto ``` :::Paragraph{indent="1"} Optionally, specify this interface to automatically start up. ::: ### Examples ```bash amnesiac (config) # ssc host host host-name host1 interface lxcbr0 ip 10.0.0.1 netmask 255.255.255.0 gateway 10.0.0.2 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc host host-name user :::Paragraph{indent="1"} Configures the log in username and password for the Services Director host. ::: ### Syntax ```bash ssc host host-name name user user password password ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the host name. ::: ```bash user ``` :::Paragraph{indent="1"} Specify the login username for the host. ::: ```bash password ``` :::Paragraph{indent="1"} Specify the login password for the host. ::: ### Examples ```bash amnesiac (config) # ssc host host-name host1 user admin password test123 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc host list :::Paragraph{indent="1"} Lists the Services Director hosts. ::: ### Syntax ```bash ssc host list ``` ### Examples ```bash amnesiac (config) # ssc host list +---------------+ | Host | +---------------+ | tmainline68-h | +---------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc host ssh-clear-key :::Paragraph{indent="1"} Clears known SSH host entries for a given host. ::: ### Syntax ```bash ssc host ssh-clear-key host-name name ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the host name. ::: ### Examples ```bash amnesiac (config) # ssc host ssh-clear-key host-name host1 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc host list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc host update host-name :::Paragraph{indent="1"} Updates values for a Services Director host. ::: ### Syntax ```bash ssc host update host-name host | [username user] | [status [Active | Inactive]] | [usage-info description] | [max-instances number] | [cpu-cores string] | [info description] ``` ### Parameters ```bash host ``` :::Paragraph{indent="1"} Specify the host name. ::: ```bash username user ``` :::Paragraph{indent="1"} Optionally, specify the user for SSH access; this user must be** root**. ::: ```bash status [Active | Inactive] ``` :::Paragraph{indent="1"} Specify the status: ::: ```bash Active ``` :::Paragraph{indent="1"} Activates a resource. ::: ```bash Inactive ``` :::Paragraph{indent="1"} 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 usage-info description ``` :::Paragraph{indent="1"} This property is not used. ::: ```bash max-instances number ``` :::Paragraph{indent="1"} The number of instances that you can create on this host. ::: ```bash cpu-cores string ``` :::Paragraph{indent="1"} This property is not used. ::: ```bash info description ``` :::Paragraph{indent="1"} Optionally, specify descriptive information about the new host. ::: ### Usage Guidelines :::Paragraph{indent="1"} Update a host resources to add or change common parameters. ::: ### Examples ```bash *** Parameter change *** amnesiac (config) # ssc host update host-name host1 status Inactive ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc host list](docId\:H010mqCIZJAevKMkPzNkS), [ssc host add host-name](docId\:LLjz7el7U_q1thWAbTl0A) ::: ### ssc host update template-name :::Paragraph{indent="1"} Updates a Services Director host based on the specified template. ::: ### Syntax ```bash ssc host update template-name name | [host-name name] | [username name] | [status [Active | Inactive] ] | [info description] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash host-name name ``` :::Paragraph{indent="1"} Specify the host name. ::: ```bash username name ``` :::Paragraph{indent="1"} Optionally, specify the user for SSH access; this user must be **root**. ::: ```bash status Active | Inactive ``` :::Paragraph{indent="1"} Specify the status: ::: ```bash Active ``` :::Paragraph{indent="1"} Activates a resource. ::: ```bash Inactive ``` :::Paragraph{indent="1"} 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 descriptive information about the new host. ::: ### Usage Guidelines :::Paragraph{indent="1"} Update an instance host 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 host update template-name hosttemp1 status Active ``` ### Related Commands :::Paragraph{indent="1"} [show ssc host host-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc import-cert :::Paragraph{indent="1"} Imports an SSL certificate. ::: ### Syntax ```bash ssc import-cert cert-data | [import-key key-data] | [password password] ``` ### Parameters ```bash cert-data ``` :::Paragraph{indent="1"} Specify the certificate data in PEM format. ::: ```bash import-key key-data ``` :::Paragraph{indent="1"} Specify the key data in PEM format. ::: ```bash password password ``` :::Paragraph{indent="1"} Specify the private key password. ::: ### Usage Guidelines :::Paragraph{indent="1"} You must import the SSL certificate and private key before you create instances. ::: ### Examples ```bash amnesiac (config) # ssc import-cert "cert-data" import-key "" ``` ### Related Commands :::Paragraph{indent="1"} [show ssc certificate](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc import-cert-key :::Paragraph{indent="1"} Imports an SSL certificate and private key. ::: ### Syntax ```bash ssc import-cert-key cert-data password password ``` ### Parameters ```bash cert-date ``` :::Paragraph{indent="1"} Specify the location of the SSL certificate and private key, for example, http, ftp, or scp URL (scp\://username\:password\@host/path/filename). ::: ```bash password password ``` :::Paragraph{indent="1"} Optionally, specify the private key password. ::: ### Usage Guidelines :::Paragraph{indent="1"} You must import the SSL certificate and private key before you create instances. ::: ### Examples ```bash amnesiac (config) # ssc import-cert-key scp://username:pwd@sfhost.example.com/ssc_archive/cert_key.pem Certificate and Private Key imported successfully ``` ### Related Commands :::Paragraph{indent="1"} [show ssc certificate](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc import-lic :::Paragraph{indent="1"} Imports the Services Director license. ::: ### Syntax ```bash ssc import-lic filename | file remote-file-path ``` ### Parameters ```bash filename ``` :::Paragraph{indent="1"} Specify the Services Director license filename. ::: ```bash file remote-file-path ``` :::Paragraph{indent="1"} Optionally, specify the remote location of the license, for example \ ::: ### Usage Guidelines :::Paragraph{indent="1"} You must import the Services Director license before you create instances. ::: ### Examples ```bash amnesiac (config) # ssc import-lic file scp://username:pwd@sfhost.example.com/ssc_archive/taranis-license License imported successfully ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc instance add instance-name :::Paragraph{indent="1"} Adds an externally-deployed vTM instance to the estate of the Services Director. ::: ### Syntax ```bash ssc instance add instance-name name bandwidth bandwidth owner instance-owner-name stm-fpname feature-pack-name mgmt-address host-or-ip-addr [config-options string] [admin-username username] [admin-password password] [rest-address uri-and-port] [snmp-address ip-address] [ui-address ip-addr] [access-profile access-profile] [analytics-profile analytics-profile] ``` ### Parameters ```bash instance-name name ``` :::Paragraph{indent="1"} The name of the externally-deployed Traffic Manager instance. ::: ```bash bandwidth bandwidth ``` :::Paragraph{indent="1"} The maximum allowed bandwidth for the Traffic Manager instance (in Mbps). ::: ```bash owner owner ``` :::Paragraph{indent="1"} Specify who owns the instance. ::: ```bash stm-fpname feature-pack-name ``` :::Paragraph{indent="1"} The name of the** feature\_pack** resource associated with the Traffic Manager instance. This represents the set of features that are available for the instance. ::: ```bash mgmt-address host-or-ip-addr ``` :::Paragraph{indent="1"} Specify the host name or IP address to reach the instance. ::: ```bash config-options string ``` :::Paragraph{indent="1"} A single configuration option is supported: ::: :::Paragraph{listStyleType="disc" indent="3"} snmp!community: The SNMP v2 community setting for this externally-deployed Traffic Manager instance. This must be set to the same value as the equivalent** snmp!community** property on the** instance** resource (default: "public"). ::: :::hint{type="info"} Unlike Services Director-deployed instances, externally-deployed instances do not restart when** config\_options** are changed. ::: ```bash admin-username name ``` :::Paragraph{indent="1"} The user name for the admin account for the externally-deployed instance. ::: ```bash admin-password password ``` :::Paragraph{indent="1"} The password for the admin account for the externally-deployed instance. ::: ```bash rest-address host-or-ip-addr ``` :::Paragraph{indent="1"} The address (host or IP address plus port number) of the Traffic Manager instance configuration REST API. If left blank, it defaults to :9070. The** rest-address** must match the instance host name. If you use a hostname instead of an IP address, you must use a fully qualified domain name. You can modify this property only for a externally-deployed Traffic Manager instance (or in a database-only request). ::: ```bash snmp-address host-or-ip-addr ``` :::Paragraph{indent="1"} The address (host or IP address plus port number) of the Traffic Manager instance SNMP responder. This setting enables you to set the SNMP address used for metering. If you use a hostname instead of an IP address, you must use a fully qualified domain name. You can modify this property only for a externally-deployed Traffic Manager instance (or in a database-only request). ::: ```bash ui-address host-or-ip-addr ``` :::Paragraph{indent="1"} The address (host or IP address plus port number) of the Traffic Manager instance Administration UI. If you do not enter a value, the UI address defaults to :9090. If you use a hostname instead of an IP address, you must use a fully qualified domain name. You can modify this property only for a externally-deployed Traffic Manager instance (or in a database-only request). ::: ```bash access-profile ``` :::Paragraph{indent="1"} The access profile identifies the authenticator and permission groups required for the user authentication on this Traffic Manager instance. ::: :::hint{type="info"} Access profile is a cluster-level configuration property, and is typically set for the vTM cluster (see [ssc cluster create cluster-name](docId\:LLjz7el7U_q1thWAbTl0A)). The current cluster-level setting is displayed in this dialogue. If you provide a new value for this property, the analytics profile will be applied to the Traffic Manager, and all other traffic manager instances in its cluster. ::: :::Paragraph{indent="1"} See also [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW). ::: ```bash analytics-profile ``` :::Paragraph{indent="1"} The analytics profile identifies the vTM analytics settings for this Traffic Manager instance. ::: :::hint{type="info"} Analytics profile is a cluster-level configuration property, and is typically set for the vTM cluster (see [ssc cluster create cluster-name](docId\:LLjz7el7U_q1thWAbTl0A)). If you provide a new value for this property, the analytics profile will be applied to the Traffic Manager, and all other traffic manager instances in its cluster. ::: ### Usage Guidelines :::Paragraph{indent="1"} Before you create a externally-deployed Traffic Manager instance, ensure that you have created a feature pack for the Traffic Manager. ::: :::Paragraph{indent="1"} You cannot create a externally-deployed Traffic Manager instance using containers. ::: :::Paragraph{indent="1"} Use the** no instance instance-name \** to delete an instance. ::: ### Examples ```bash amnesiac (config) # ssc instance add instance-name stm-i1 bandwidth 1200 owner janet stm-fpname default-fp mgmt-address test-demo ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance create instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance create instance-name :::Paragraph{indent="1"} Creates a vTM instance. ::: ### Syntax ```bash ssc instance create instance-name name license-name name bandwidth bandwidth cpu-usage cpu owner instance-owner-name stm-fpname feature-pack-name stm-version stm-version-name host-name host mgmt-address host-or-ip-addr [config-options string] [cluster-id name] [container-name name] [container-cfg config-data] [deploy none] [managed yes-or-none] [status [Active | Inactive]] ``` ### Parameters ```bash instance-name name ``` :::Paragraph{indent="1"} Specify a unique name for the Traffic Manager instance. ::: ```bash license-name name ``` :::Paragraph{indent="1"} The name of the** license** resource you want to use for this instance. When you modify this property, the Services Director updates the license on the Traffic Manager instance. ::: ```bash bandwidth bandwidth ``` :::Paragraph{indent="1"} Specify the bandwidth allowed for this instance (in Mbps). ::: ```bash cpu-usage cpu ``` :::Paragraph{indent="1"} A string that describes which CPUs are used for this Traffic Manager instance. If used, you must either: ::: :::Paragraph{listStyleType="disc" indent="3"} Specify a value in a form that is used by the taskset command. For example, "0,3,57". ::: :::Paragraph{listStyleType="disc" indent="3"} Set this property to an empty string. This indicates that the host is not limited in its use of CPU cores (unless it is deployed within an LXC container). This is the default setting for the property if you do not specify a string. ::: :::hint{type="info"} Any change to the** cpu\_usage** settings will cause a restart of the instance. ::: ```bash owner name ``` :::Paragraph{indent="1"} Specify a string that describes an owner of the instance. ::: ```bash stm-fpname feature-pack-name ``` :::Paragraph{indent="1"} Specify the Traffic Manager feature-pack name associated with the instance. ::: ```bash stm-version stm-version-name ``` :::Paragraph{indent="1"} The name of the Traffic Manager**version** resource for the instance. If you modify this property, the Services Director upgrades the Traffic Manager instance to the new version. You can change this property only if the instance** status** is Idle. ::: ```bash host-name host ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager instance host on which the instance is running. ::: ```bash mgmt-address host-or-ip-addr ``` :::Paragraph{indent="1"} Specify the host name or IP address to reach the instance. ::: ```bash config-options string ``` :::Paragraph{indent="1"} A string containing configuration options for optional features. If specified, this is a space-delimited combination of one or more the following: ::: :::Paragraph{listStyleType="disc" indent="3"} default: This option has no effect and is used to avoid an empty string. If this is option is used, no other options can be specified in the** config\_options**. ::: :::Paragraph{listStyleType="disc" indent="3"} admin\_ui=yes/no: Start or bypass the Administration UI for the Traffic Manager instance (default: yes). You must set this to yes if you use the** cluster\_id** property. ::: :::Paragraph{listStyleType="disc" indent="3"} maxfds=number: The maximum number of file descriptors (default: 4096). This setting must be consistent between all instances in a cluster. (See** Notes**, below). ::: :::Paragraph{listStyleType="disc" indent="3"} webcache!size=number: The size of RAM for the web cache (default: 0). This value can be specified in %, MB, GB by appending the corresponding unit symbol to the end of the value when not specifying a value in bytes. For example, 100%, 256MB, 1GB, and so on. This setting must be consistent between all instances in a cluster. (See** Notes**, below). ::: :::Paragraph{listStyleType="disc" indent="3"} java!enabled=yes/no: Start or bypass the Java server (default: no). This setting must be consistent between all instances in a cluster. (See** Notes**, below). ::: :::Paragraph{listStyleType="disc" indent="3"} statd!rsync\_enabled=yes/no: Synchronize historical activity data within a cluster. If this data is unwanted, disable this setting to save CPU and bandwidth (default: yes). This setting must be consistent between all instances in a cluster. (See** Notes**, below). ::: :::Paragraph{listStyleType="disc" indent="3"} snmp!community: The SNMP v2 community setting for this instance resource. For metering of externally-deployed instances, this must be set to the same value as the equivalent** snmp!community** property on the instance itself (default: "public"). ::: :::Paragraph{listStyleType="disc" indent="3"} num\_children=number: The number of child processes (default: 1). ::: :::Paragraph{listStyleType="disc" indent="3"} start\_flipper=yes/no: Start or bypass the flipper process (default: yes). You must set this to yes if you use the** cluster\_id** property. ::: :::Paragraph{listStyleType="disc" indent="3"} afm\_deciders=number: The number of application firewall decider processes. If 0 is specified, the application firewall is not installed (default: 0).** Note**: You cannot update this option after the instance has been deployed. ::: :::Paragraph{listStyleType="disc" indent="3"} flipper!frontend\_check\_addrs=host: Check instance front-end connectivity with a specific host. When the Services Director deploys an instance, it checks connectivity to the default gateway of the instance host by sending ICMP requests to it. If the default gateway is protected by a firewall or blocks ICMP requests, instance deployment can fail. To disable deployment connectivity checks, use** flipper!frontend\_check\_addrs=""**. This setting must be consistent between all instances in a cluster. (See** Notes**, below). ::: :::Paragraph{listStyleType="disc" indent="3"} flipper!monitor\_interval=number: The interval, in milliseconds, between flipper monitoring actions. (default: 500 ms). For higher density Traffic Manager instance deployments, use a larger value such as 2000ms. This setting must be consistent between all instances in a cluster. (See** Notes**, below). ::: :::hint{type="info"} Any change to the** config\_options** settings will cause a restart of the instance. ::: :::hint{type="info"} Some configuration options, if specified here, must be consistent between all Traffic Manager instances in a cluster: ::: :::Paragraph{listStyleType="disc" indent="3"} maxfds ::: :::Paragraph{listStyleType="disc" indent="3"} webcache!size ::: :::Paragraph{listStyleType="disc" indent="3"} java!enabled ::: :::Paragraph{listStyleType="disc" indent="3"} statd!rsync\_enabled ::: :::Paragraph{listStyleType="disc" indent="3"} flipper!monitor\_interval ::: :::Paragraph{listStyleType="disc" indent="3"} flipper!frontend\_check\_addrs ::: :::Paragraph{indent="1"} If you set or update the value in one** instance** resource, the Services Director replicates this update automatically to the other instance resources. The instance will restart whenever these are changed, but other instances in the cluster must be restarted manually. ::: :::hint{type="info"} Whenever the** config\_options** property is set, all currently modified options must be specified again in the REST call. Any options that are not specified will lose their current value and be reset to their default value. ::: ```bash cluster-id ID-or-name ``` :::Paragraph{indent="1"} Optionally, specify the name of a cluster resource to which the instance belongs. ::: :::Paragraph{indent="1"} If you do not specify a cluster name, a new cluster name is generated automatically and assigned to the instance. ::: ```bash container-name name ``` :::Paragraph{indent="1"} Specify the name of the LXC container in which the instance is running. If this is an empty string or** none**, the Traffic Manager is not run inside a container. ::: ```bash container-cfg config-data ``` :::Paragraph{indent="1"} Optionally, specify configuration data for the instance container. The string populates the container configuration file with the gateway IP, the management IP, the WAN IP, the LAN IP, the data plane gateway IP, and the flavor (also called size). ::: :::Paragraph{indent="1"} Use the following format: ::: ```bash "{'gateway': '10.5.27.1', 'mgmtip':'10.10.10.1/24', 'wanip':'10.10.10.2/24', 'lanip':'10.10.10.3/24', 'dataplanegw':'10.5.5.2', 'flavor':'small'}" ``` :::Paragraph{indent="1"} Possible flavor values are: small= 256, 1 CPU, medium= 512 2 CPU, or large= 1024 4 CPU. ::: ```bash deploy none ``` :::Paragraph{indent="1"} The default value is** true**. Specify** none** to apply changes to the database but not cause deployment changes. This setting supports testing and database reconciliation. No actions are carried out and no intermediate status is set. If a new instance resource is set to** none** then the status is set to** Idle** upon creation. ::: ```bash managed none ``` :::Paragraph{indent="1"} Specify** yes**. ::: ```bash active [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. ::: ### Usage Guidelines :::Paragraph{indent="1"} Before you create a Traffic Manager instance, make sure you have: ::: :::Paragraph{listStyleType="disc" indent="2"} Imported the SSL certificate and key, the Services Director license, the enterprise bandwidth license key, and the Traffic Manager FLA license. ::: :::Paragraph{listStyleType="disc" indent="2"} Created a resource entry for the Traffic Manager FLA license. ::: :::Paragraph{listStyleType="disc" indent="2"} Imported the Traffic Manager image and created a resource entry for it. ::: :::Paragraph{listStyleType="disc" indent="2"} Imported the host OVA and created the host resource. ::: :::Paragraph{listStyleType="disc" indent="2"} Created a feature pack for the Traffic Manager. ::: :::Paragraph{listStyleType="disc" indent="2"} Provisioned the host OVA. When you execute the** ssc host provision** command, it un-tars the OVA, repackages the SSH public key created above and it is provisioned on ESXi. After the host is created in ESXi, the public key is assigned to the user defined in the** ssc host provision** command. After this command is executed you can SSH to the host without a password. ::: :::Paragraph{indent="1"} You can create instances without using containers, but you must ensure a degree of network isolation. ::: :::Paragraph{indent="1"} Before you create a container using the CLI, make sure that you have a host entry that includes the IP address and host name for the container you are going to create and that you can ping it. ::: :::Paragraph{indent="1"} Use the** no instance instance-name \** to delete an instance. ::: ### Examples ```bash *** no container *** amnesiac (config) # ssc instance create instance-name stm-i1 license name fla-ssl-ssc bandwidth 1200 cpu-usage 0 owner tim stm-fpname default-fp stm-version stm97 host-name test-demo mgmt-address test-demo *** container *** amnesiac (config) # ssc instance create instance-name stm-cont-i2 license name fla-ssl-ssc bandwidth 1200 cpu-usage 0 owner tim stm-fpname default-fp stm-version stm97 host-name test-demo mgmt-address 10.l0.10.1 container-name stm-cont-i1 container-cfg "{'gateway': '10.5.27.1', 'mgmtip':'10.10.10.1/24', 'wanip':'10.10.10.2/24', 'lanip':'10.10.10.3/24', 'dataplanegw':'10.5.5.2', 'flavor':'small'}" ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance add instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance force-start instance-name :::Paragraph{indent="1"} Forces the status of the instance in the MySQL database to be Active. ::: ### Syntax ```bash ssc instance force-start instance-name instance ``` ### Parameters ```bash instance ``` :::Paragraph{indent="1"} The instance name. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is used where there is an inconsistency between the actual status of the instance and the status of the instance in the MySQL database. ::: ### Examples ```bash amnesiac (config) # ssc instance force-start instance-name DMaxhill-05 amnesiac (config) # ssc instance force-start instance-name Instance-345879389713 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance start instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance force-stop instance-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance force-stop instance-name :::Paragraph{indent="1"} Forces the status of the instance in the MySQL database to be Idle. ::: ### Syntax ```bash ssc instance force-stop instance-name instance ``` ### Parameters ```bash instance ``` :::Paragraph{indent="1"} The instance name. ::: ### Usage Guidelines :::Paragraph{indent="1"} This command is used where there is an inconsistency between the actual status of the instance and the status of the instance in the MySQL database. ::: ### Examples ```bash amnesiac (config) # ssc instance force-stop instance-name DMaxhill-05 amnesiac (config) # ssc instance force-stop instance-name Instance-345879389713 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance force-start instance-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance list :::Paragraph{indent="1"} Displays a list of names for vTM instances that are registered on the Services Director. ::: ### Syntax ```bash ssc instance list ``` ### Examples ```bash amnesiac (config) # ssc instance list +------------------------+ | Instance | +------------------------+ | Pendragon-00 | | Pendragon-01 | | DMaxhill-05 | | Instance-345879389713 | +------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc instance create instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance start instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance stop instance-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance start instance-name :::Paragraph{indent="1"} Starts a vTM instance. ::: ### Syntax ```bash ssc instance start instance-name instance ``` ### Parameters ```bash instance ``` :::Paragraph{indent="1"} The instance name. ::: ### Examples ```bash amnesiac (config) # ssc instance start instance-name DMaxhill-05 amnesiac (config) # ssc instance start instance-name Instance-345879389713 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance stop instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance stop instance-name :::Paragraph{indent="1"} Stops a vTM instance. ::: ### Syntax ```bash ssc instance stop instance-name instance ``` ### Parameters ```bash instance ``` :::Paragraph{indent="1"} The instance name. ::: ### Examples ```bash amnesiac (config) # ssc instance start instance-name DMaxhill-05 amnesiac (config) # ssc instance start instance-name Instance-345879389713 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance start instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance relicense instance-name :::Paragraph{indent="1"} Relicenses a vTM instance that uses Universal FLA licensing. The instance must have its rest\_enabled set to True . ::: ### Syntax ```bash ssc instance relicense instance-name instance ``` ### Parameters ```bash instance ``` :::Paragraph{indent="1"} The instance name. ::: ### Examples ```bash amnesiac (config) # ssc instance relicense instance-name DMaxhill-05 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance create instance-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance update instance-name :::Paragraph{indent="1"} Updates values in a vTM instance. ::: ### Syntax ```bash ssc instance update instance-name instance [new-inst-name instance] [license-name name] [bandwidth bandwidth] [cpu-usage cpu] [stm-fpname feature-pack-name] [stm-version stm-version-name] [config-options options] [container-cfg config-data] [managed yes-or-none] [deploy none] [admin-username username] [admin-password password] [rest-address uri-and-port] [snmp-address ip-address] [status [Active | Inactive]] [ui-address ip-addr] [access-profile access-profile] [analytics-profile analytics-profile] ``` ### Parameters ```bash instance ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager instance. ::: ```bash new-inst-name instance ``` :::Paragraph{indent="1"} Specify the new name for the instance. ::: ```bash license-name name ``` :::Paragraph{indent="1"} Specify name of the FLA license resource for the instance ::: ```bash bandwidth bandwidth ``` :::Paragraph{indent="1"} Specify the bandwidth allowed for this instance. ::: ```bash cpu-usage cpu ``` :::Paragraph{indent="1"} Specify a string that describes which CPUs that can be used for the instance. The format can be used by the **taskset** command and typically is a single CPU number, such as 0. This command might be unnecessary depending on the container configuration. ::: ```bash stm-fpname feature-pack-name ``` :::Paragraph{indent="1"} Specify the Traffic Manager feature-pack name associated with the instance. ::: ```bash stm-version stm-version-name ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager version-resource for the instance. This is the Traffic Manager version name that is assigned when you imported the Traffic Manager into the Services Director. ::: ```bash host-name host ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager instance host on which the instance is running. ::: ```bash mgmt-address host-or-ip-addr ``` :::Paragraph{indent="1"} Specify the host name or IP address to reach the instance. ::: ```bash config-options string ``` :::Paragraph{indent="1"} Specify a string that defines the values for the instance container. The string populates the container configuration file with the gateway IP, the management IP, the WAN IP, the LAN IP, the data plane gateway IP, and the flavor or size: small= 256, 1 CPU, medium= 512 2 CPU, or large= 1024 4 CPU. Use the following format: ::: ```bash "{'gateway': '10.5.27.1', 'mgmtip':'10.10.10.1/24', 'wanip':'10.10.10.2/24', 'lanip':'10.10.10.3/24', 'dataplanegw':'10.5.5.2', 'flavor':'small'}" container-cfg config-data ``` :::Paragraph{indent="1"} Optionally, specify configuration data for the instance container. ::: ```bash managed yes-or-none ``` :::Paragraph{indent="1"} Specify **yes** for Services Director-deployed instances or **none** for externally-deployed instances. ::: ```bash deploy none ``` :::Paragraph{indent="1"} The default value is **true**. Specify **none** to apply changes to the database but not cause deployment changes. This setting supports testing and database reconciliation. No actions are carried out and no intermediate status is set. If a new instance resource is set to **none** then the status is set to **Idle** upon creation. ::: ```bash admin-username username ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the user name of the Traffic Manager instance-administrator user. ::: ```bash admin-password password ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the password of the Traffic Manager instance-administrator user. ::: ```bash rest-address uri-and-port ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the IP address, including the port, for the instance REST API. ::: ```bash snmp-address ip-address ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the IP address, including the port, for the Traffic Manager instance SNMP server. ::: ```bash active [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 ui-address ip-addr ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the IP address, including the port, for the Traffic Manager instance Admin UI. ::: ```bash access-profile ``` :::Paragraph{indent="1"} The access profile identifies the authenticator and permission groups required for the user authentication on this Traffic Manager instance. ::: :::hint{type="info"} Access profile is a cluster-level configuration property, and is typically set for the vTM cluster (see [ssc cluster create cluster-name](docId\:LLjz7el7U_q1thWAbTl0A)). The current cluster-level setting is displayed in this dialogue. If you provide a new value for this property, the analytics profile will be applied to the Traffic Manager, and all other traffic manager instances in its cluster. ::: :::Paragraph{indent="1"} See also [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW). ::: ```bash analytics-profile ``` :::Paragraph{indent="1"} The analytics profile identifies the vTM analytics settings for this Traffic Manager instance. ::: :::hint{type="info"} Analytics profile is a cluster-level configuration property, and is typically set for the vTM cluster (see [ssc cluster create cluster-name](docId\:LLjz7el7U_q1thWAbTl0A)). If you provide a new value for this property, the analytics profile will be applied to the Traffic Manager, and all other traffic manager instances in its cluster. ::: ### Examples ```bash amnesiac (config) # ssc instance update instance-name inst1 admin-user root admin-password 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc instance update template-name :::Paragraph{indent="1"} Updates a vTM instance based on the specified template. ::: ### Syntax ```bash ssc instance update template-name name instance-name instance [new-inst-name instance] [license-name name] [bandwidth bandwidth] [cpu-usage cpu] [stm-fpname feature-pack-name] [stm-version stm-version-name] [config-options options] [container-cfg configdata] [managed yes-or-none] [deploy none] [admin-username username] [admin-password password] [rest-address uri-and-port] [snmp-address ip-address] [status [Active | Inactive]] [ui-address ip-addr] [access-profile access-profile] [analytics-profile analytics-profile] ``` ### Parameters ```bash template-name name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash instance-name instance ``` :::Paragraph{indent="1"} Specify the current instance name. ::: ```bash new-inst-name instance ``` :::Paragraph{indent="1"} Specify the new name for the instance. ::: ```bash license-name name ``` :::Paragraph{indent="1"} Specify name of the FLA license resource for the instance ::: ```bash bandwidth bandwidth ``` :::Paragraph{indent="1"} Specify the bandwidth allowed for this instance. ::: ```bash cpu-usage cpu ``` :::Paragraph{indent="1"} Specify a string that describes which CPUs that can be used for the instance. The format can be used by the **taskset** command and typically is a single CPU number, such as 0. This command might be unnecessary depending on the container configuration. ::: ```bash stm-fpname feature-pack-name ``` :::Paragraph{indent="1"} Specify the Traffic Manager feature-pack name associated with the instance. ::: ```bash stm-version stm-version-name ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager version-resource for the instance. This is the Traffic Manager version name that is assigned when you imported the Traffic Manager into the Services Director. ::: ```bash host-name host ``` :::Paragraph{indent="1"} Specify the name of the Traffic Manager instance host on which the instance is running. ::: ```bash mgmt-address host-or-ip-addr ``` :::Paragraph{indent="1"} Specify the host name or IP address to reach the instance. ::: ```bash config-options string ``` :::Paragraph{indent="1"} Specify a string that defines the values for the instance container. The string populates the container configuration file with the gateway IP, the management IP, the WAN IP, the LAN IP, the data plane gateway IP, and the flavor or size: small= 256, 1 CPU, medium= 512 2 CPU, or large= 1024 4 CPU. Use the following format: ::: ```bash "{'gateway': '10.5.27.1', 'mgmtip':'10.10.10.1/24', 'wanip':'10.10.10.2/24', 'lanip':'10.10.10.3/24', 'dataplanegw':'10.5.5.2', 'flavor':'small'}" container-cfg config-data ``` :::Paragraph{indent="1"} Optionally, specify configuration data for the instance container. ::: ```bash managed yes-or-none ``` :::Paragraph{indent="1"} Specify **yes** for Services Director-deployed instances or **none** for externally-deployed instances. ::: ```bash deploy none ``` :::Paragraph{indent="1"} The default value is **true**. Specify **none** to apply changes to the database but not cause deployment changes. This setting supports testing and database reconciliation. No actions are carried out and no intermediate status is set. If a new instance resource is set to **none** then the status is set to **Idle** upon creation. ::: ```bash admin-username username ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the user name of the Traffic Manager instance-administrator user. ::: ```bash admin-password password ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the password of the Traffic Manager instance-administrator user. ::: ```bash rest-address uri-and-port ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the IP address, including the port, for the instance REST API. ::: ```bash snmp-address ip-address ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the IP address, including the port, for the Traffic Manager instance SNMP server. ::: ```bash active [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 ui-address ip-addr ``` :::Paragraph{indent="1"} Specify only for externally-deployed instances. Specify the IP address, including the port, for the Traffic Manager instance Admin UI. ::: ```bash access-profile ``` :::Paragraph{indent="1"} The access profile identifies the authenticator and permission groups required for the user authentication on this Traffic Manager instance. ::: :::hint{type="info"} Access profile is a cluster-level configuration property, and is typically set for the vTM cluster (see [ssc cluster create cluster-name](docId\:LLjz7el7U_q1thWAbTl0A)). The current cluster-level setting is displayed in this dialogue. If you provide a new value for this property, the analytics profile will be applied to the Traffic Manager, and all other traffic manager instances in its cluster. ::: :::Paragraph{indent="1"} See also [ssc access-profile remove-perm-group](docId\:Daj0PxouZD3s712K5TKUW). ::: ```bash analytics-profile ``` :::Paragraph{indent="1"} The analytics profile identifies the vTM analytics settings for this Traffic Manager instance. ::: :::hint{type="info"} Analytics profile is a cluster-level configuration property, and is typically set for the vTM cluster (see [ssc cluster create cluster-name](docId\:LLjz7el7U_q1thWAbTl0A)). If you provide a new value for this property, the analytics profile will be applied to the Traffic Manager, and all other traffic manager instances in its cluster. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates a Traffic Manager instance 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 instance update template-name tempinst1 instance-name inst1 admin-user root admin-password 1234 ``` ### Related Commands :::Paragraph{indent="1"} [show ssc instance instance-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc kpti :::Paragraph{indent="1"} Changes the reboot setting for the Kernel Page-Table Isolation (KPTI) feature. ::: ### Syntax ```bash ssc kpti [ enable | disable ] ``` ### Examples ```bash *** check current state *** amnesiac (config) # show ssc kpti KPTI is currently enabled and will remain enabled after reboot. *** request a change of state *** amnesiac (config) # ssc kpti disable Disabled KPTI for next boot. Use "reload" to reboot. ``` ### Related Commands :::Paragraph{indent="1"} [show ssc kpti](docId\:Daj0PxouZD3s712K5TKUW), [reload](docId\:qW4d1Kj33nMlkR3yej8BD) ::: ### ssc license enterprise add-on :::Paragraph{indent="1"} Activates the enterprise add-on license. ::: ### Syntax ```bash [no] ssc license enterprise add-on add license-key ``` ### Parameters :::Paragraph{indent="1"} add license-key ::: :::Paragraph{indent="1"} Specify the add-on license key. ::: ### Usage Guidelines :::Paragraph{indent="1"} For detailed information about add-on licenses, see Services Director Advanced User Guide. Use the** no ssc license enterprise add-on \** command option to deactivate the enterprise add-on license. ::: ### Examples ```bash amnesiac (config) # ssc license enterprise add-on XXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc license enterprise add-on list :::Paragraph{indent="1"} Displays a list of add-on licenses installed. ::: ### Syntax ```bash ssc license enterprise add-on list license ``` ### Parameters ```bash license ``` :::Paragraph{indent="1"} (Optional) Specify an Enterprise add-on license. ::: ### Examples ```bash amnesiac (config) # ssc license enterprise add-on list +-----------------------------------------+ | Enterprise Add-On Licenses | +-----------------------------------------+ | 417928-23bbc2fb77767ac82db4df862658cabb | +-----------------------------------------+ amnesia (config) # show ssc license enterprise add-on 417928-23bbc2fb77767ac82db4df862658cabb +---------------------------+----------------------------------------------------- | Field | Value +---------------------------+----------------------------------------------------- | valid_until | 2016-10-07 | timestamp | 2016-09-27T21:37:13.1475037433 | controller_license | ERSSC381243-0000-42B9 | bandwidth | 5000.0 | serial | 417928 | license_key | LK1-ERSSCAPADD_FIPS:5:417928:20160924237433-0000-... | controller_license_serial | 381243 | valid_from | Perpetual | add_on_sku | ADD-FIPS | valid | True +---------------------------+----------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc license enterprise bandwidth activate :::Paragraph{indent="1"} Activates an enterprise bandwidth license. ::: ### Syntax ```bash ssc license enterprise bandwidth activate license-key ``` ### Parameters ```bash license-key ``` :::Paragraph{indent="1"} Specify the enterprise bandwidth license key. ::: ### Usage Guidelines :::Paragraph{indent="1"} You can have one or more bandwidth licenses depending on the needs of your enterprise. The bandwidth licenses are activated when you import the license key. ::: :::Paragraph{indent="1"} Use the** no ssc license enterprise bandwidth \** command to delete an enterprise bandwidth license. ::: ### Examples ```bash amnesiac (config) # ssc license enterprise bandwidth activate 116415-0e60bc0fe6b16d659b90d732 +---------------------------+----------------------------------------------------- | Field | Value +---------------------------+----------------------------------------------------- | status | Active | valid_until | 2016-10-07 | timestamp | 2016-09-27T21:37:13.1475037433 | controller_license | ERSSC381243-0000-42B9 | bandwidth | 5000.0 | valid_from | Perpetual | serial | 115415 | license_key | LK1-ERSSCTPSTM_B_400:5:116415:20160927T213713147... | controller_license_serial | 381243 | stm_sku | STM-400 | valid | True +---------------------------+----------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc license enterprise bandwidth add :::Paragraph{indent="1"} Adds an enterprise bandwidth license. ::: ### Syntax ```bash ssc license enterprise bandwidth add license-key ``` ### Parameters ```bash license-key ``` :::Paragraph{indent="1"} Specify the enterprise bandwidth license key. ::: ### Usage Guidelines :::Paragraph{indent="1"} You can have one or more bandwidth licenses depending on the needs of your enterprise. The bandwidth licenses are activated when you import the license key. ::: :::Paragraph{indent="1"} Use the** no ssc license enterprise bandwidth \** command to delete an enterprise bandwidth license. ::: ### Examples ```bash amnesiac (config) # ssc license enterprise bandwidth add LK1-ERSSCTPSTM_B_400:5:115415:20160927T27433-0000-43B9-5-5263-460B-1E66 +---------------------------+----------------------------------------------------- | Field | Value +---------------------------+----------------------------------------------------- | status | Active | valid_until | 2016-10-07 | timestamp | 2016-09-27T21:37:13.1475037433 | controller_license | ERSSC381243-0000-43B9 | bandwidth | 5000.0 | valid_from | Perpetual | serial | 115415 | license_key | LK1-ERSSCTPSTM_B_400:5:115415:20160927T2265764750... | controller_license_serial | 381243 | stm_sku | STM-400 | valid | True +---------------------------+----------------------------------------------------- ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc license enterprise bandwidth list :::Paragraph{indent="1"} Lists enterprise bandwidth license keys. ::: ### Syntax ```bash ssc license enterprise bandwidth list ``` ### Usage Guidelines :::Paragraph{indent="1"} You can have one or more bandwidth licenses depending on the needs of your enterprise. The bandwidth licenses are activated when you import the license key. ::: ### Examples ```bash amnesiac (config) # ssc license enterprise bandwidth list +-----------------------------------------+ | Enterprise Bandwidth Licenses | +-----------------------------------------+ | 342005-5e876d4bc34885e04f2c58867e21f1cf | +-----------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc license enterprise controller list :::Paragraph{indent="1"} Lists enterprise controller license keys. ::: ### Syntax ```bash ssc license enterprise controller list ``` ### Usage Guidelines :::Paragraph{indent="1"} Use **no license enterprise controller \** to delete an enterprise controller license. ::: ### Examples ```bash amnesiac (config) # ssc license enterprise controller list +--------------------------------+ | Enterprise Controller Licenses | +--------------------------------+ | ERSSC381244-0000-52A9 | +--------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [ssc instance list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc license enterprise resource-pack add :::Paragraph{indent="1"} Adds a resource pack license key. ::: ### Syntax ```bash ssc license enterprise resource-pack add license-key ``` ### Usage Guidelines :::Paragraph{indent="1"} Use **no license enterprise resource-pack \ **to delete an enterprise resource pack license. ::: ### Examples ```bash amnesiac (config) # ssc license enterprise resource-pack add LK1- BR_ADC_RES_EMBAS5I_S_01:5:261755:2017081341503363094-0000-4401-5-6DC1-34C2-7045 +---------------------------+------------------------------------------------------ | Field | Value +---------------------------+------------------------------------------------------ | valid_until | 2017-08-31 | timestamp | 2017-08-21T17:51:34.1503363094 | controller_license | | valid_from | Perpetual | license_key | LK1-BR_ADC_RES_EMBAS5I_S_01:5:261755:2017081341503... | serial | 261755 | controller_license_serial | | stm_sku | ENT-ENTM | resource_amount | 5 | valid | False +---------------------------+------------------------------------------------------ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [ssc license enterprise resource-pack list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc license enterprise resource-pack list :::Paragraph{indent="1"} Lists resource pack license keys. ::: ### Syntax ```bash ssc license enterprise resource-pack list ``` ### Usage Guidelines :::Paragraph{indent="1"} Use **no license enterprise resource-pack \ **to delete an enterprise resource pack license. ::: ### Examples ```bash *** list resource pack licenses *** amnesiac (config) # ssc license enterprise resource-pack list +---------------------------------------------------------------------------------+ | Enterprise Resource-Pack Licenses | +---------------------------------------------------------------------------------+ | LK1-BR_ADC_RES_EMBAS5I_S_01:5:261755:2017341363094-0000-4401-5-6DC1-34C2-7045 | +---------------------------------------------------------------------------------+ *** delete a resource pack license *** amnesiac (config) # no ssc license enterprise resource-pack LK1-BR_ADC_RES_EMBAS5I_S_01:5:261755:2017341363094-0000-4401-5-6DC1-34C2-7045 Successfully deleted resource-pack key (LK1-BR_ADC_RES_EMBAS5I_S_01:5:261755:2017341363094-0000-4401-5-6DC1-34C2-7045) ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW), [ssc license enterprise resource-pack add](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc license list :::Paragraph{indent="1"} Displays a list of FLA licenses that are present. Where no FLA license is present, this is indicated. ::: ### Syntax ```bash ssc license list ``` ### Examples ```bash amnesiac (config) # ssc license list +--------------+ | License | +--------------+ | universal_v4 | | legacy_9.3 | +--------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc license enterprise](docId\:Daj0PxouZD3s712K5TKUW) ::: ### ssc log metering clear :::Paragraph{indent="1"} Deletes backup Services Director metering logs. ::: ### Syntax ```bash ssc log metering clear ``` ### Examples ```bash amnesiac (config) # ssc log metering clear ``` ### Related Commands :::Paragraph{indent="1"} [ssc log metering phone-home enable](docId\:H010mqCIZJAevKMkPzNkS), [ssc log metering generate](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc log metering generate :::Paragraph{indent="1"} Extracts metering logs. ::: ### Syntax ```bash ssc log metering generate [backup [yes | no]] ``` ### Parameters ```bash backup yes/no ``` :::Paragraph{indent="1"} Optional. Specify to indicate whether previously-generated logs are to be included. New logs are always included. ::: ### Examples ```bash amnesiac (config) # ssc log metering generate backup no ``` :::Paragraph{indent="1"} In this example, the backup switch indicates that no previously-generated logs are required; only new log data (since the most recent log generation) is included. A maximum of ten metering logs can be generated by this process. ::: ### Related Commands :::Paragraph{indent="1"} [ssc log metering phone-home enable](docId\:H010mqCIZJAevKMkPzNkS), [ssc log metering clear](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc log metering phone-home enable :::Paragraph{indent="1"} Enables/disables the phone home service for Services Director metering logs. ::: ### Syntax ```bash [no] ssc log metering phone-home enable ``` ### Usage Guidelines :::Paragraph{indent="1"} The **no** command option disables the phone home feature. ::: ### Examples ```bash amnesiac (config) # ssc log metering phone-home enable ``` ### Related Commands :::Paragraph{indent="1"} [ssc log metering clear](docId\:H010mqCIZJAevKMkPzNkS), [ssc log metering generate](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc log-export create :::Paragraph{indent="1"} Creates a new log-export resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc log-export create tag value files file-list [history {None | All}] [appliance-only Boolean] ``` ### Parameters ```bash tag value ``` :::Paragraph{indent="1"} The customer-facing name for the log-export resource. If this is not set, the tag is set to the UUID value for the resource. ::: ```bash files file-list ``` :::Paragraph{indent="1"} A comma-separated list of log files. The files identified by this list will be sent by the vTM to its assigned collection endpoint. ::: :::Paragraph{indent="1"} You can include wildcards if required. You can also include the %ZEUSHOME% variable if required, which represents the Services Director's home directory. ::: :::Paragraph{indent="1"} For example: %ZEUSHOME%/zxtm/log/stingrayafm/log-master/\*,%ZEUSHOME%/zxtm/log/stingrayafm/log/\* ::: ```bash history ``` :::Paragraph{indent="1"} (Optional) Identifies how much historic activity should be exported for this log. Use one of the following settings: ::: :::Paragraph{listStyleType="disc" indent="3"} None. This indicates that only current activity logs will be exported. All historic activity logs will not be included. This is the default setting. ::: :::Paragraph{listStyleType="disc" indent="3"} All. This indicates that all current and historic activity logs will be exported. ::: ```bash appliance_only ``` :::Paragraph{indent="1"} (Optional) a Boolean setting that indicates log-export usage: ::: :::Paragraph{listStyleType="disc" indent="3"} true: the log-export is only supported on virtual appliance installations of the Virtual Traffic Manager, and not on software installations. ::: :::Paragraph{listStyleType="disc" indent="3"} false: the log-export is supported on all installations. This is the default setting. ::: ### Examples ```bash *** create a log-export resource *** amnesiac (config) # ssc log-export create tag "Request Logs" files "%ZEUSHOME%/zxtm/log/myvirtualserver.log" +----------------+-----------------------------------------+ | Field | Value | +----------------+-----------------------------------------+ | files | %ZEUSHOME%/zxtm/log/myvirtualserver.log | | tag | Request Logs | | appliance_only | False | | built_in | False | | log_export_id | Log-Export-1YRJ-LIPR-ZWY7-3J1Q | | history | none | +----------------+-----------------------------------------+ *** list all log-export resources to confirm the addition *** amnesiac (config) # ssc log-export list +--------------------------------+-----------------------------+ | ID | Tag | +--------------------------------+-----------------------------+ | Log-Export-1YRJ-LIPR-ZWY7-3J1Q | Request Logs | | Audit Log | Audit Log | | Application Firewall | Application Firewall | | Process Monitor | Process Monitor | | Admin Server Access | Admin Server Access | | System - syslog | System - syslog | | Event Log | Event Log | | Routing Software | Routing Software | | Data Plane Acceleration | Data Plane Acceleration | | System - authentication log | System - authentication log | +--------------------------------+-----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc log-export](docId\:Daj0PxouZD3s712K5TKUW), [ssc log-export delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export list](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc log-export delete :::Paragraph{indent="1"} Deletes a log-export resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc log-export delete id log-export-id ``` ### Parameters ```bash id log-export-id ``` :::Paragraph{indent="1"} The identifier for the log-export resource, either its** tag** or its UUID. ::: ### Usage Guidelines :::Paragraph{indent="1"} You can only delete a log-export resource that has an ID of the form Log-Export-xxxx-xxxx-xxxx-xxxx. This indicates that the log-export resource was created by a user. ::: :::Paragraph{indent="1"} You cannot delete a log-export resource that has an ID that uses English words, and which matches its tag. For example: Audit Logs. This indicates that the log-export resource was created automatically when the Services Director was installed. ::: ### Examples ```bash *** list all log-export resources *** amnesiac (config) # ssc log-export list +--------------------------------+-----------------------------+ | ID | Tag | +--------------------------------+-----------------------------+ | Log-Export-1YRJ-LIPR-ZWY7-3J1Q | Request Logs | | Audit Log | Audit Log | | Application Firewall | Application Firewall | | Process Monitor | Process Monitor | | Admin Server Access | Admin Server Access | | System - syslog | System - syslog | | Event Log | Event Log | | Routing Software | Routing Software | | Data Plane Acceleration | Data Plane Acceleration | | System - authentication log | System - authentication log | +--------------------------------+-----------------------------+ *** try to delete log-export resource that was provided with the product *** amnesiac (config) # ssc log-export delete id "Audit Log" +-------+------------------------------------------------------------------------- | Field | Value +-------+------------------------------------------------------------------------- | error | Access to resource is forbidden (Deleting a built-in log export entry... +-------+------------------------------------------------------------------------- *** delete a specific log-export resource *** amnesiac (config) # ssc log-export delete id "Request Logs" +--------------------------------------------------------+ | Deleted | +--------------------------------------------------------+ | Log Export type Log-Export-1YRJ-LIPR-ZWY7-3J1Q deleted | +--------------------------------------------------------+ *** list all log-export resources to confirm the deletion *** amnesiac (config) # ssc log-export list +--------------------------------+-----------------------------+ | ID | Tag | +--------------------------------+-----------------------------+ | Audit Log | Audit Log | | Application Firewall | Application Firewall | | Process Monitor | Process Monitor | | Admin Server Access | Admin Server Access | | System - syslog | System - syslog | | Event Log | Event Log | | Routing Software | Routing Software | | Data Plane Acceleration | Data Plane Acceleration | | System - authentication log | System - authentication log | +--------------------------------+-----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc log-export](docId\:Daj0PxouZD3s712K5TKUW), [ssc log-export create](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export list](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc log-export list :::Paragraph{indent="1"} Lists all log-export resources. These resources are used for vTM analytics. ::: ### Syntax ```bash ssc log-export list ``` ### Examples ```bash amnesiac (config) # ssc log-export list +--------------------------------+-----------------------------+ | ID | Tag | +--------------------------------+-----------------------------+ | Audit Log | Audit Log | | Application Firewall | Application Firewall | | Process Monitor | Process Monitor | | Admin Server Access | Admin Server Access | | System - syslog | System - syslog | | Event Log | Event Log | | Routing Software | Routing Software | | Data Plane Acceleration | Data Plane Acceleration | | System - authentication log | System - authentication log | +--------------------------------+-----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc log-export](docId\:Daj0PxouZD3s712K5TKUW), [ssc log-export create](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc log-export update :::Paragraph{indent="1"} Updates a log-export resource. This resource is used for vTM analytics. ::: ### Syntax ```bash ssc log-export update id log-export-id [tag value [files file-list] [history {None | All}] [appliance-only Boolean] ``` ### Parameters ```bash id log-export-id ``` :::Paragraph{indent="1"} The identifier for the log-export resource, either its** tag** or its UUID. ::: ```bash tag value ``` :::Paragraph{indent="1"} The customer-facing name for the log-export resource. If this is not set, the tag is set to the UUID value for the resource. ::: ```bash files files-list ``` :::Paragraph{indent="1"} A comma-separated list of log files. The files identified by this list will be sent by the vTM to its assigned collection endpoint. ::: :::Paragraph{indent="1"} You can include wildcards if required. You can also include the %ZEUSHOME% variable if required, which represents the Services Director's home directory. ::: :::Paragraph{indent="1"} For example: %ZEUSHOME%/zxtm/log/stingrayafm/log-master/\*,%ZEUSHOME%/zxtm/log/stingrayafm/log/\* ::: ```bash history ``` :::Paragraph{indent="1"} Identifies how much historic activity should be exported for this log. Use one of the following settings: ::: :::Paragraph{listStyleType="disc" indent="3"} None. This indicates that only current activity logs will be exported. All historic activity logs will not be included. This is the default setting. ::: :::Paragraph{listStyleType="disc" indent="3"} All. This indicates that all current and historic activity logs will be exported. ::: ```bash appliance_only ``` :::Paragraph{indent="1"} A Boolean setting that indicates log-export usage: ::: :::Paragraph{listStyleType="disc" indent="3"} true: the log-export is only supported on virtual appliance installations of the Virtual Traffic Manager, and not on software installations. ::: :::Paragraph{listStyleType="disc" indent="3"} false: the log-export is supported on all installations. This is the default setting. ::: ### Usage Guidelines :::Paragraph{indent="1"} You can only update a log-export resource that has an ID of the form Log-Export-xxxx-xxxx-xxxx-xxxx. This indicates that the log-export resource was created by a user. ::: :::Paragraph{indent="1"} You cannot update a log-export resource that has an ID that uses English words, and which matches its tag. For example: Audit Logs. This indicates that the log-export resource was created automatically when the Services Director was installed. ::: ### Examples ```bash *** list all log-export resources *** amnesiac (config) # ssc log-export list +--------------------------------+-----------------------------+ | ID | Tag | +--------------------------------+-----------------------------+ | Log-Export-1YRJ-LIPR-ZWY7-3J1Q | Request Logs | | Audit Log | Audit Log | | Application Firewall | Application Firewall | | Process Monitor | Process Monitor | | Admin Server Access | Admin Server Access | | System - syslog | System - syslog | | Event Log | Event Log | | Routing Software | Routing Software | | Data Plane Acceleration | Data Plane Acceleration | | System - authentication log | System - authentication log | +--------------------------------+-----------------------------+ *** display properties for a specific log-export resource *** amnesiac (config) # show ssc log-export id "Request Logs" +----------------+-----------------------------------------+ | Field | Value | +----------------+-----------------------------------------+ | files | %ZEUSHOME%/zxtm/log/myvirtualserver.log | | tag | Request Logs | | appliance_only | False | | built_in | False | | log_export_id | Log-Export-1YRJ-LIPR-ZWY7-3J1Q | | children | None | | history | none | +----------------+-----------------------------------------+ *** update the history property for this log-export resource *** amnesiac (config) # ssc log-export update id "Request Logs" history all +----------------+-----------------------------------------+ | Field | Value | +----------------+-----------------------------------------+ | files | %ZEUSHOME%/zxtm/log/myvirtualserver.log | | tag | Request Logs | | appliance_only | False | | built_in | False | | log_export_id | Log-Export-1YRJ-LIPR-ZWY7-3J1Q | | history | all | +----------------+-----------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc log-export](docId\:Daj0PxouZD3s712K5TKUW), [ssc log-export create](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc log-export list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc manager list :::Paragraph{indent="1"} Lists Services Director managers. ::: ### Syntax ```bash ssc manager list ``` ### Examples ```bash amnesiac (config) # ssc manager list +----------+ | Manager | +----------+ | amnesiac | +----------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc manager manager-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc manager update manager-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc manager update manager-name :::Paragraph{indent="1"} Updates Services Director manager settings. ::: ### Syntax ```bash ssc manager update manager-name name mgmt-mode [enabled | disabled] metering-mode [all | none] licensing-mode [enabled |disabled |enabled-with-alerts] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify a unique name for the manager. ::: ```bash mgmt-mode ``` :::Paragraph{indent="1"} Specify the management mode for the manager: enabled, disabled. ::: ```bash metering-mode ``` :::Paragraph{indent="1"} Specify the metering mode for the manager: all, none. ::: ```bash licensing-mode ``` :::Paragraph{indent="1"} Specify the licensing mode for the manager: enabled, disabled, enabled-with-alerts. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the **no ssc manager manager-name \** command to delete a manager that is flagged as failed. ::: :::Paragraph{indent="1"} Use the **no ssc manager manager-name \ force-delete** command to delete a manager that is not flagged as failed. ::: ### Examples ```bash amnesiac (config) # ssc manager update manager-name amnesiac mgmt-mode enabled metering-mode all licensing-mode enabled ``` ### Related Commands :::Paragraph{indent="1"} [show ssc manager manager-name](docId\:Daj0PxouZD3s712K5TKUW), [ssc manager list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc manager update template-name :::Paragraph{indent="1"} Updates the Services Director manager based on the specified template. ::: ### Syntax ```bash ssc manager update template-name name | [manager-name name mgmt-mode enabled | disabled] | [metering-mode all | none] | [licensing-mode enabled | disabled | enabledwithalerts] ``` ### Parameters ```bash name ``` :::Paragraph{indent="1"} Specify the template name. ::: ```bash manager-name name ``` :::Paragraph{indent="1"} Specify the manager name. ::: ```bash mgmt-mode ``` :::Paragraph{indent="1"} Specify the management mode for the manager: enabled, disabled. ::: ```bash metering-mode ``` :::Paragraph{indent="1"} Specify the metering mode for the manager: all, none. ::: ```bash licensing-mode ``` :::Paragraph{indent="1"} Specify the licensing mode for the manager: enabled, disabled, enabled-with-alerts. ::: ### Usage Guidelines :::Paragraph{indent="1"} Updates a manager 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 manager update template-name mantemp1 manager-name amnesiac mgmt-mode disabled ``` ### Related Commands :::Paragraph{indent="1"} [ssc manager update manager-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc template create template-name](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc metering warning list :::Paragraph{indent="1"} Displays a list of all Traffic Manager instances that have a metering warning raised against them. ::: ### Syntax ```bash ssc metering warning list ``` ### Usage Guidelines :::Paragraph{indent="1"} To display information for failed Traffic Manager instances, see [show ssc owner](docId\:Daj0PxouZD3s712K5TKUW). ::: ### Examples ```bash amnesiac (config) # ssc metering warning list +-----------+ | Instance | +-----------+ | cerise-02 | | sienna-01 | +-----------+ ``` ### 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 settings metering update](docId:2xtd8nOKdlgsAEu6GI3W6) ::: ### ssc owner create :::Paragraph{indent="1"} Creates an owner on the Services Director. This is used to indicate ownership of registered vTMs and vTM clusters, and is required during automated self-registration of vTMs. ::: ### Syntax ```bash ssc owner create [e-mail email-address] [secret password] [timezone timezone] [[tag name] ``` ### Parameters ```bash e-mail email-address ``` :::Paragraph{indent="1"} Optionally, specify a valid e-mail address that will be used to contact an administrator if required. ::: ```bash secret password ``` :::Paragraph{indent="1"} Optionally, specify a password for this owner. This is required for automatic self-registration. ::: ```bash timezone timezone ``` :::Paragraph{indent="1"} Optionally, specify a timezone for this owner. For example: "Europe/London", "America/Detroit", "GMT". ::: ```bash tag ``` :::Paragraph{indent="1"} Optionally, specify a unique name for this owner. ::: ### Usage Guidelines :::Paragraph{indent="1"} No parameters are mandatory. If none are provided, an owner is created with only the UUID set. ::: ### Examples ```bash *** list owners to confirm which are available *** amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-NS3F-FHQ4-RO11-5Y0A | JK | | Owner-JJM6-0UII-JUAH-R979 | JRRT | +---------------------------+------+ *** create new owner 'TK' *** amnesiac (config) # ssc owner create tag TK timezone Europe/London +---------------+---------------------------+ | Field | Value | +---------------+---------------------------+ | instances | [] | | tag | TK | | timezone | Europe/London | | email_address | | | secret | QUK5qKRPy2mt | | clusters | [] | | owner_id | Owner-58I2-2N4F-IXG0-8084 | +---------------+---------------------------+ *** list owners again *** amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-NS3F-FHQ4-RO11-5Y0A | JK | | Owner-58I2-2N4F-IXG0-8084 | TK | | Owner-JJM6-0UII-JUAH-R979 | JRRT | +---------------------------+------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc owner](docId\:Daj0PxouZD3s712K5TKUW), [ssc owner delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner list](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc owner delete :::Paragraph{indent="1"} Deletes an owner on the Services Director. ::: ### Syntax ```bash ssc owner delete owner-id owner ``` ### Parameters ```bash owner-id owner ``` :::Paragraph{indent="1"} Specify the owner you want to delete, using either its tag or UUID. ::: ### Examples ```bash *** list owners *** amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-NS3F-FHQ4-RO11-5Y0A | JK | | Owner-58I2-2N4F-IXG0-8084 | TK | | Owner-JJM6-0UII-JUAH-R979 | JRRT | +---------------------------+------+ *** delete owner *** amnesiac (config) # ssc owner delete owner-id JK +-----------------------------------------+ | Deleted | +-----------------------------------------+ | Owner Owner-NS3F-FHQ4-RO11-5Y0A deleted | +-----------------------------------------+ *** list owners to confirm deletion *** amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-58I2-2N4F-IXG0-8084 | TK | | Owner-JJM6-0UII-JUAH-R979 | JRRT | +---------------------------+------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc owner](docId\:Daj0PxouZD3s712K5TKUW), [ssc owner create](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner list](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc owner list :::Paragraph{indent="1"} Displays a list of all owners on the Services Director. ::: ### Syntax ```bash ssc owner list ``` ### Examples ```bash amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-NS3F-FHQ4-RO11-5Y0A | JK | | Owner-58I2-2N4F-IXG0-8084 | TK | | Owner-JJM6-0UII-JUAH-R979 | JRRT | +---------------------------+------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc owner](docId\:Daj0PxouZD3s712K5TKUW), [ssc owner create](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc owner update :::Paragraph{indent="1"} Updates an owner on the Services Director. ::: ### Syntax ```bash ssc owner update owner-id owner [e-mail email-address] [secret password] [timezone timezone] [[tag name] ``` ### Parameters ```bash owner-id owner ``` :::Paragraph{indent="1"} Identify the owner that you want to update, using either its tag or UUID. ::: ```bash e-mail email-address ``` :::Paragraph{indent="1"} Optionally, specify a valid e-mail address that will be used to contact an administrator if required. ::: ```bash secret password ``` :::Paragraph{indent="1"} Optionally, specify a password for this owner. This is required for automatic self-registration. ::: ```bash timezone ``` :::Paragraph{indent="1"} Optionally, specify a timezone for this owner. For example: "Europe/London", "America/Detroit", "GMT". ::: ```bash tag ``` :::Paragraph{indent="1"} Optionally, specify a unique name for this owner. ::: ### Examples ```bash *** list owners *** amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-NS3F-FHQ4-RO11-5Y0A | JK | | Owner-58I2-2N4F-IXG0-8084 | TK | | Owner-JJM6-0UII-JUAH-R979 | Demo | +---------------------------+------+ *** rename 'Demo' to 'JRRT' *** amnesiac (config) # ssc owner update owner-id Demo tag JRRT +---------------+-----------------------------------+ | Field | Value | +---------------+-----------------------------------+ | instances | [u'Instance-097D-W8HI-XR4K-GYUF'] | | tag | JRRT | | timezone | Europe/Lisbon | | email_address | | | secret | | | clusters | [u'Cluster-3FRI-XJST-S2UY-CCMD'] | | owner_id | Owner-JJM6-0UII-JUAH-R979 | +---------------+-----------------------------------+ *** list owners *** amnesiac (config) # ssc owner list +---------------------------+------+ | Owner ID | Tag | +---------------------------+------+ | Owner-HSC1-T4QV-BXPB-Z4CZ | HC | | Owner-NS3F-FHQ4-RO11-5Y0A | JK | | Owner-58I2-2N4F-IXG0-8084 | TK | | Owner-JJM6-0UII-JUAH-R979 | JRRT | +---------------------------+------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc owner](docId\:Daj0PxouZD3s712K5TKUW), [ssc owner create](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc owner list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc registration delete :::Paragraph{indent="1"} Deletes a specified self-registration request. ::: ### Syntax ```bash ssc registration delete registration-id ``` ### Parameters ```bash registration-id ``` :::Paragraph{indent="1"} Specify the ID for the self-registration request. ::: ### Examples ```bash amnesiac (config) # ssc registration delete registration-id Reg-NF8H-W5UT-ECL3-HFMH Successfully deleted registration Reg-NF8H-W5UT-ECL3-HFMH ``` ### Related Commands :::Paragraph{indent="1"} [show ssc registration](docId\:Daj0PxouZD3s712K5TKUW), [ssc registration list](docId\:H010mqCIZJAevKMkPzNkS), [ssc registration update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc registration list :::Paragraph{indent="1"} Lists all self-registration requests received by Services Director. This list includes all Approved, Pending, Declined and Blacklisted requests. ::: ### Syntax ```bash ssc registration list ``` ### Examples ```bash amnesiac (config) # ssc registration list +-------------------------+--------------------+-------------+ | ID | REST Address | Status | +-------------------------+--------------------+-------------+ | Reg-NF8H-W5UT-ECL3-HFMH | 10.62.169.167:9070 | Accepted | | Reg-RUE7-NV0B-TXE7-RQO6 | 10.62.169.168:9070 | Blacklisted | | Reg-1K8R-1C1Z-JM3S-W12R | 10.62.169.167:9070 | Pending | +-------------------------+--------------------+-------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc registration](docId\:Daj0PxouZD3s712K5TKUW), [ssc registration delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc registration update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc registration update :::Paragraph{indent="1"} Updates the state of a specified self-registration request. This is the standard method for approving a request. ::: ### Syntax ```bash ssc registration update registration-id registration-id state [ blacklist | pending | decline [ reason declined-reason ] | accept [ instance-name name owner owner feature-pack feature_pack bandwidth bandwidth [access_profile access_profile] [analytics_profile analytics_profile] ] ``` ### Parameters ```bash registration-id ``` :::Paragraph{indent="1"} Specify the ID for the self-registration request. ::: ```bash state ``` :::Paragraph{indent="1"} Specify a new state for the self-registration request. Supported transitions are: ::: :::Paragraph{listStyleType="disc" indent="3"} Pending --> Accepted ::: :::Paragraph{listStyleType="disc" indent="3"} Pending --> Declined ::: :::Paragraph{listStyleType="disc" indent="3"} Pending --> Blacklisted ::: :::Paragraph{listStyleType="disc" indent="3"} Declined --> Pending ::: :::Paragraph{listStyleType="disc" indent="3"} Blacklisted --> Pending ::: ```bash declined-reason ``` :::Paragraph{indent="1"} Optionally, specify a reason (as a string) for the transition from Pending to Declined. This is not used for any other state transition. ::: ```bash instance-name ``` :::Paragraph{indent="1"} The name for the instance. ::: ```bash owner ``` :::Paragraph{indent="1"} The owner of the instance. ::: ```bash feature_pack ``` :::Paragraph{indent="1"} The feature pack for the instance. ::: ```bash bandwidth ``` :::Paragraph{indent="1"} The bandwidth for the instance. ::: ```bash access_profile ``` :::Paragraph{indent="1"} (Optional) The access\_profile for the instance. ::: ```bash analytics_profile ``` :::Paragraph{indent="1"} (Optional) The analytics profile for the instance. ::: ### Usage Guidelines :::Paragraph{indent="1"} The following commands represent the four supported state transitions: ::: :::Paragraph{listStyleType="disc" indent="2"} Pending to Declined: ::: :::Paragraph{indent="2"} **ssc registration update registration-id \ state decline reason \** ::: :::Paragraph{listStyleType="disc" indent="2"} Pending to Blacklisted: ::: :::Paragraph{indent="2"} **ssc registration update registration-id \ state blacklist** ::: :::Paragraph{listStyleType="disc" indent="2"} Declined/Blacklisted back to Pending: ::: :::Paragraph{indent="2"} **ssc registration update registration-id \ state pending** ::: :::Paragraph{listStyleType="disc" indent="2"} Pending to Accepted: ::: :::Paragraph{indent="2"} **ssc registration update registration-id \ state accept instance-name \ owner \ feature-pack \ bandwidth \ access\_profile \ analytics\_profile \** ::: :::Paragraph{indent="1"} When the Pending to Accepted transition is performed, the authenticator and permission groups in the access profile are applied to the vTM. Existing authenticators and permission groups may be overwritten, but none will be deleted. All members of a cluster are affected. ::: ### Examples ```bash amnesiac (config) # ssc registration update registration-id Reg-RUE7-NV0B-TXE7-RQO6 state decline reason "Unexpected submission" +----------------------+--------------------------------------+ | Field | Value | +----------------------+--------------------------------------+ | snmp_address | 10.62.169.168:161 | | registration_message | Cerise-02 10.4 registration (Tekton) | | bandwidth | None | | owner | None | | email_address | admin@tekton.com | | instance_name | None | | uuid | 06711d65-b1c6-3301-96d6-005056a63342 | | hostname | 10.62.169.168 | | declined_reason | Unexpected submission | | instance_version | 10.4 | | status | Declined | | snmp_community | public | | admin_address | 10.62.169.168:9090 | | rest_address | 10.62.169.168:9070 | | feature_pack | None | | cluster_identifier | | | registration_time | 2016-03-07 16:44:24 | | instance_id | None | | management_ip | 10.62.169.168 | | pending_time | 2016-03-07 16:44:24 | | access_profile | None | | analytics_profile | None | +----------------------+--------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc registration](docId\:Daj0PxouZD3s712K5TKUW), [ssc registration delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc registration list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc reg-policy create :::Paragraph{indent="1"} Creates a registration policy on the Services Director. This is used during the automatic self-registration of externally-deployed vTMs and cloud-based vTMs. ::: ### Syntax ```bash ssc reg-policy create feature-pack feature-pack bandwidth bandwidth mgmt-ip-subnet subnet [tag name] [inst-version-low version] [inst-version-high version] [access-profile access-profile] [analytics-profile analytics-profile] ``` ### Parameters ```bash feature-pack ``` :::Paragraph{indent="1"} Specify the name of a feature pack. ::: :::Paragraph{indent="1"} This is the feature pack that will be assigned to a vTM that is successfully evaluated using this policy. ::: :::Paragraph{indent="1"} This is not an acceptance condition, but the evaluation of the** bandwidth** property refers to this property. ::: ```bash bandwidth ``` :::Paragraph{indent="1"} This is the required bandwidth (in Mbps) for a vTM that is evaluated using this policy. ::: :::Paragraph{indent="1"} If there is insufficient bandwidth in the specified Feature Pack for a vTM, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash mgmt-ip-subnet ``` :::Paragraph{indent="1"} Specify the IP address and netmask of a subnetwork in CIDR format. For example, 10.122.12.13/18. ::: :::Paragraph{indent="1"} This identifies the subnet to which a vTM must belong to be accepted by this policy. ::: :::Paragraph{indent="1"} If a vTM that is evaluated by this policy is from outside the specified subnetwork, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash tag ``` :::Paragraph{indent="1"} (Optional) A unique name for the self-registration policy. ::: ```bash inst-version-low ``` :::Paragraph{indent="1"} (Optional) The minimum version for the vTM software. This takes the form X.Y. Examples: 10.0, 10.3. ::: :::Paragraph{indent="1"} R1 releases are included automatically for any base version. For example, 10.0 includes 10.0r1. ::: :::Paragraph{indent="1"} If a vTM that is evaluated by this policy does not meet this condition, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash inst-version-high ``` :::Paragraph{indent="1"} (Optional) The maximum version for the vTM software. This takes the form X.Y. Examples: 10.4, 11.0. ::: :::Paragraph{indent="1"} R1 releases are included automatically for any base version. For example, 10.3 includes 10.3r1. ::: :::Paragraph{indent="1"} If a vTM that is evaluated by this policy does not meet this condition, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash access-profile ``` :::Paragraph{indent="1"} (Optional) The Access Profile for the policy. This profile identifies the authenticator and permission groups required for the user authentication on this vTM. ::: :::Paragraph{indent="1"} If selected, these will be applied to the vTM once it is accepted. All cluster members are affected by this change. ::: ```bash analytics-profile ``` :::Paragraph{indent="1"} (Optional) The Analytics Profile for the policy. This profile identifies the resources required for analytics on this vTM. ::: :::Paragraph{indent="1"} If selected, these will be applied to the vTM once it is accepted. All cluster members are affected by this change. ::: ### Examples ```bash *** list existing self-reg policies *** amnesiac (config) # ssc reg-policy list +----------------------------+----------------+ | Policy ID | Tag | +----------------------------+----------------+ | Policy-MHM8-AB62-SI2J-DNUX | jk-self-reg-01 | | Policy-8QU3-ZERY-8IW6-3W6J | self-reg-01 | +----------------------------+----------------+ *** create a new sel-reg policy 'jk-self-reg-02' *** amnesiac (config) # ssc reg-policy create feature-pack STM-400_full bandwidth 80 mgmt-ip-subnet 10.20.128.0/18 inst-version-low 10.2 tag jk-self-reg-02 +-----------------------------+----------------------------+ | Field | Value | +-----------------------------+----------------------------+ | instance_version_range_low | 10.2 | | bandwidth | 80 | | tag | jk-self-reg-02 | | management_ip_subnet | 10.20.128.0/18 | | feature_pack | STM-400_full | | access_profile | None | | analytics_profile | None | | instance_version_range_high | | | policy_id | Policy-I7A7-3DN2-6IEB-QF96 | +-----------------------------+----------------------------+ amnesiac (config) # ssc reg-policy list +----------------------------+----------------+ | Policy ID | Tag | +----------------------------+----------------+ | Policy-MHM8-AB62-SI2J-DNUX | jk-self-reg-01 | | Policy-I7A7-3DN2-6IEB-QF96 | jk-self-reg-02 | | Policy-8QU3-ZERY-8IW6-3W6J | self-reg-01 | +----------------------------+----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc reg-policy](docId\:Daj0PxouZD3s712K5TKUW), [ssc reg-policy delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy list](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc reg-policy delete :::Paragraph{indent="1"} Deletes a registration policy from the Services Director. ::: ### Syntax ```bash ssc reg-policy delete policy-id registration-policy ``` ### Parameters ```bash registration-policy ``` :::Paragraph{indent="1"} Specify the name of the registration policy that you want to delete. ::: ### Examples ```bash *** list self-reg policies *** amnesiac (config) # ssc reg-policy list +----------------------------+----------------+ | Policy ID | Tag | +----------------------------+----------------+ | Policy-MHM8-AB62-SI2J-DNUX | jk-self-reg-01 | | Policy-I7A7-3DN2-6IEB-QF96 | jk-self-reg-02 | | Policy-8QU3-ZERY-8IW6-3W6J | self-reg-01 | +----------------------------+----------------+ *** delete self-reg policy 'jk-self-reg-02' *** amnesiac (config) # ssc reg-policy delete policy-id jk-self-reg-02 +--------------------------------------------------------+ | Deleted | +--------------------------------------------------------+ | Registration policy Policy-I7A7-3DN2-6IEB-QF96 deleted | +--------------------------------------------------------+ *** list self-reg policies to confirm deletion *** amnesiac (config) # ssc reg-policy list +----------------------------+----------------+ | Policy ID | Tag | +----------------------------+----------------+ | Policy-MHM8-AB62-SI2J-DNUX | jk-self-reg-01 | | Policy-8QU3-ZERY-8IW6-3W6J | self-reg-01 | +----------------------------+----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc reg-policy](docId\:Daj0PxouZD3s712K5TKUW), [ssc reg-policy create](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy list](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc reg-policy list :::Paragraph{indent="1"} Displays a list of all a registration policies on the Services Director. ::: ### Syntax ```bash ssc reg-policy list ``` ### Examples ```bash amnesiac (config) # ssc reg-policy list +----------------------------+----------------+ | Policy ID | Tag | +----------------------------+----------------+ | Policy-MHM8-AB62-SI2J-DNUX | jk-self-reg-01 | | Policy-I7A7-3DN2-6IEB-QF96 | jk-self-reg-02 | | Policy-8QU3-ZERY-8IW6-3W6J | self-reg-01 | +----------------------------+----------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc reg-policy](docId\:Daj0PxouZD3s712K5TKUW), [ssc reg-policy create](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc reg-policy update :::Paragraph{indent="1"} Updates a registration policy on the Services Director. ::: ### Syntax ```bash ssc reg-policy update policy-id id [tag name] [feature-pack feature-pack] [bandwidth bandwidth] [mgmt-ip-subnet subnet] [inst-version-low version] [inst-version-high version] [access-profile access-profile] [analytics-profile analytics-profile] ``` ### Parameters ```bash policy-id id ``` :::Paragraph{indent="1"} Specify the name of the registration policy that you want to update. ::: ```bash tag ``` :::Paragraph{indent="1"} (Optional) A unique name for the self-registration policy. ::: ```bash feature-pack ``` :::Paragraph{indent="1"} (Optional) The name of a feature pack. ::: :::Paragraph{indent="1"} This is the feature pack that will be assigned to a vTM that is successfully evaluated using this policy. ::: :::Paragraph{indent="1"} This is not an acceptance condition, but the evaluation of the** bandwidth** property refers to this property. ::: ```bash bandwidth ``` :::Paragraph{indent="1"} (Optional) The required bandwidth (in Mbps) for a vTM that is evaluated using this policy. ::: :::Paragraph{indent="1"} If there is insufficient bandwidth in the specified Feature Pack for a vTM, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash mgmt-ip-subnet ``` :::Paragraph{indent="1"} (Optional) The IP address and netmask of a subnetwork in CIDR format. For example, 10.122.12.13/18. ::: :::Paragraph{indent="1"} This identifies the subnet to which a vTM must belong to be accepted by this policy. ::: :::Paragraph{indent="1"} If a vTM that is evaluated by this policy is from outside the specified subnetwork, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash inst-version-low ``` :::Paragraph{indent="1"} (Optional) The minimum version for the vTM software. This takes the form X.Y. Examples: 10.0, 10.3. ::: :::Paragraph{indent="1"} R1 releases are included automatically for any base version. For example, 10.0 includes 10.0r1. ::: :::Paragraph{indent="1"} If a vTM that is evaluated by this policy does not meet this condition, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash inst-version-high ``` :::Paragraph{indent="1"} (Optional) The maximum version for the vTM software. This takes the form X.Y. Examples: 10.4, 11.0. ::: :::Paragraph{indent="1"} R1 releases are included automatically for any base version. For example, 10.3 includes 10.3r1. ::: :::Paragraph{indent="1"} If a vTM that is evaluated by this policy does not meet this condition, the auto-acceptance of the vTM is rejected by the self-registration policy. ::: ```bash access-profile ``` :::Paragraph{indent="1"} (Optional) An access profile. This profile identifies the authenticator and permission groups required for the user authentication on this vTM. ::: :::Paragraph{indent="1"} If selected, these will be applied to the vTM once it is accepted. All cluster members are affected by this change. ::: ```bash analytics-profile ``` :::Paragraph{indent="1"} (Optional) An analytics profile. This profile identifies the resources required to implement analytics on this vTM. ::: :::Paragraph{indent="1"} If selected, these will be applied to the vTM once it is accepted. All cluster members are affected by this change. ::: ### Examples ```bash *** show details for a self-reg policy *** amnesiac (config) # show ssc reg-policy policy-id self-reg-01 +-----------------------------+----------------------------+ | Field | Value | +-----------------------------+----------------------------+ | instance_version_range_low | | | bandwidth | 100 | | tag | self-reg-01 | | management_ip_subnet | 10.62.128.0/18 | | feature_pack | STM-400_full | | access_profile | None | | analytics_profile | None | | instance_version_range_high | | | policy_id | Policy-8QU3-ZERY-8IW6-3W6J | +-----------------------------+----------------------------+ *** change bandwidth from 100 to 120 *** amnesiac (config) # ssc reg-policy update policy-id self-reg-01 bandwidth 120 +-----------------------------+----------------------------+ | Field | Value | +-----------------------------+----------------------------+ | instance_version_range_low | | | bandwidth | 120 | | tag | self-reg-01 | | management_ip_subnet | 10.62.128.0/18 | | feature_pack | STM-400_full | | access_profile | None | | analytics_profile | None | | instance_version_range_high | | | policy_id | Policy-8QU3-ZERY-8IW6-3W6J | +-----------------------------+----------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc reg-policy](docId\:Daj0PxouZD3s712K5TKUW), [ssc reg-policy create](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy delete](docId\:H010mqCIZJAevKMkPzNkS), [ssc reg-policy list](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-admin-ca create :::Paragraph{indent="1"} Creates a Services Director CA certificate that is for use with a secure LDAP server authenticator. ::: ### Syntax ```bash ssc sd-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 certificates *** amnesiac (config) # ssc sd-admin-ca list +------+------------------------------+ | Name | Unique ID | +------+------------------------------+ | CA-1 | Admin-CA-5XJ0-HP0Y-YQAX-69O2 | +------+------------------------------+ *** add a new certificate *** amnesiac (config) # ssc sd-admin-ca create admin-ca-name CA-2 certificate-authority "-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE----- >" +------------------------------------------+ | Created | +------------------------------------------+ | admin certificate authority CA-2 created | +------------------------------------------+ *** confirm creation *** amnesiac (config) # ssc sd-admin-ca list +------+------------------------------+ | Name | Unique ID | +------+------------------------------+ | CA-1 | Admin-CA-5XJ0-HP0Y-YQAX-69O2 | | CA-2 | Admin-CA-6J21-KKH3-VSAJ-3209 | +------+------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc sd-admin-ca list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca update](docId\:H010mqCIZJAevKMkPzNkS), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-admin-ca list :::Paragraph{indent="1"} Lists all Services Director CA certificates that are for use with a secure LDAP server authenticator. ::: ### Syntax ```bash ssc sd-admin-ca list ``` ### Examples ```bash amnesiac (config) # ssc sd-admin-ca list +------+------------------------------+ | Name | Unique ID | +------+------------------------------+ | CA-1 | Admin-CA-5XJ0-HP0Y-YQAX-69O2 | | CA-2 | Admin-CA-6J21-KKH3-VSAJ-3209 | +------+------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc sd-admin-ca create](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca update](docId\:H010mqCIZJAevKMkPzNkS), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-admin-ca update :::Paragraph{indent="1"} Updates a Services Director CA certificate that is for use with a secure LDAP server authenticator. ::: ### Syntax ```bash ssc sd-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 sd-admin-ca list +------+------------------------------+ | Name | Unique ID | +------+------------------------------+ | CA-1 | Admin-CA-5XJ0-HP0Y-YQAX-69O2 | | CA-2 | Admin-CA-6J21-KKH3-VSAJ-3209 | +------+------------------------------+ *** rename the CA-2 certificate *** amnesiac (config) # ssc sd-admin-ca update admin-ca-name CA-2 new-admin-ca-name LDP2 +------------------------------------------+ | Updated | +------------------------------------------+ | admin certificate authority CA-2 updated | +------------------------------------------+ *** confirm update *** amnesiac (config) # ssc sd-admin-ca list +------+------------------------------+ | Name | Unique ID | +------+------------------------------+ | CA-1 | Admin-CA-5XJ0-HP0Y-YQAX-69O2 | | LDP2 | Admin-CA-6J21-KKH3-VSAJ-3209 | +------+------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [ssc sd-admin-ca create](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca list](docId\:H010mqCIZJAevKMkPzNkS), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator add ldap auth-name :::Paragraph{indent="1"} Adds an LDAP-based Services Director authenticator. This can be either secure or non-secure. ::: ### Syntax ```bash ssc sd-authenticator add ldap auth-name authenticator-name auth-status [enabled | disabled] server 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 Services Director authenticator. ::: ```bash auth-status ``` :::Paragraph{indent="1"} Specify whether the authenticator is either enabled or disabled. ::: ```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. ::: ### Usage Guidelines :::Paragraph{indent="1"} Use the** no ssc sd-authenticator auth-name** command to delete an authenticator. ::: :::Paragraph{indent="1"} You cannot delete a Services Director authenticator that is associated with an access profile. ::: ### Examples ```bash *** create an LDAP Services Director authenticator *** amnesiac (config) # ssc sd-authenticator add ldap auth-name "LDAP Server" auth-status enabled 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 ssl starttls "(&(memberUid=%u)(objectClass=posixGroup))" +--------------------------------------+ | Created | +--------------------------------------+ | SD Authenticator LDAP Server created | +--------------------------------------+ *** delete an LDAP Services Director *** amnesiac (config) # no ssc sd-authenticator auth-name "LDAP Server" +-----------------------------------+ | Deleted | +-----------------------------------+ | Authenticator LDAP Server deleted | +-----------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-admin-ca create](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator add radius auth-name :::Paragraph{indent="1"} Adds a RADIUS-based Services Director authenticator. ::: ### Syntax ```bash ssc sd-authenticator add radius auth-name authenticator-name auth-status [enable | disable] 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 Services Director authenticator. ::: ```bash auth-status ``` :::Paragraph{indent="1"} Specify whether the authenticator is either enabled or disabled. ::: ```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 sd-authenticator auth-name** command to delete an authenticator. ::: :::Paragraph{indent="1"} You cannot delete a Services Director authenticator that is associated with an access profile. ::: ### Examples ```bash *** create a RADIUS authenticator *** amnesiac (config) # ssc sd-authenticator add radius auth-name "RADIUS Server" 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 | +-------------------------------------+ | Authenticator RADIUS Server created | +-------------------------------------+ *** delete an authenticator *** amnesiac (config) # no ssc sd-authenticator auth-name "RADIUS Server" +-------------------------------------+ | Deleted | +-------------------------------------+ | Authenticator RADIUS Server deleted | +-------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update radius auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator add tacacs\_plus auth-name :::Paragraph{indent="1"} Adds a TACACS+-based Services Director authenticator. ::: ### Syntax ```bash ssc sd-authenticator add tacacs-plus auth-name authenticator-name auth-status [enable | disable] 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+ Services Director authenticator. ::: ```bash auth-status ``` :::Paragraph{indent="1"} Specify whether the authenticator is either enabled or disabled. ::: ```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 sd-authenticator auth-name** command to delete an authenticator. ::: :::Paragraph{indent="1"} You cannot delete a Services Director authenticator that is associated with an access profile. ::: ### Examples ```bash *** create a TACACS+ authenticator *** amnesiac (config) # ssc sd-authenticator add tacacs-plus auth-name "TACACS+ Server" auth-status enabled 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 | +-----------------------------------------+ | SD Authenticator TACACS+ Server created | +-----------------------------------------+ *** delete an authenticator *** amnesiac (config) # no ssc sd-authenticator auth-name "TACACS+ Server" +-----------------------------------------+ | Deleted | +-----------------------------------------+ | SD Authenticator TACACS+ Server deleted | +-----------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator list :::Paragraph{indent="1"} Lists all defined Services Director authenticators. ::: ### Syntax ```bash ssc sd-authenticator list ``` ### Examples ```bash amnesiac (config) # ssc sd-authenticator list +----------------+-----------------------------------+ | Name | Unique ID | +----------------+-----------------------------------+ | LDAP Server | Authenticator-D83I-9095-TT8R-CUAT | | Secure LDAP | Authenticator-E723-MT4B-JJ3W-BARK | | RADIUS Server | Authenticator-808G-LJWJ-MT3B-WMDZ | | TACACS+ Server | Authenticator-7F1D-A1K3-1PO4-VSEF | +----------------+-----------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator add radius auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator add tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update radius auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator test auth-name :::Paragraph{indent="1"} Tests a Services Director authenticator using a remote user name and password. ::: :::hint{type="info"} For secure LDAP server, a matching CA certificate must be present on Services Director to enable the operation. ::: ### Syntax ```bash ssc sd-authenticator test auth-name authenticator-name username user-name password password ``` ### Parameters ```bash authenticator-name ``` :::Paragraph{indent="1"} Specify a name for the Services Director authenticator. ::: ```bash user-name ``` :::Paragraph{indent="1"} Specify the required user. ::: ```bash password ``` :::Paragraph{indent="1"} Specify the password for the required user. ::: ### Examples ```bash amnesiac (config) # ssc sd-authenticator test auth-name bbotservices username tacadmin password tacpassword +--------+---------+ | Result | Message | +--------+---------+ | True | | +--------+---------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator add radius auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator add tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update radius auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator update tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-admin-ca create](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator update ldap auth-name :::Paragraph{indent="1"} Updates an LDAP-based Services Director authenticator. ::: ### Syntax ```bash ssc sd-authenticator update ldap auth-name authenticator-name auth-status [enable | disable] [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 Services Director authenticator. ::: ```bash auth-status ``` :::Paragraph{indent="1"} Specify whether the authenticator is either enabled or disabled. ::: ```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 sd-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 | +---------------------------------------+ | SD Authenticator LDAP Server modified | +---------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add ldap auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS), [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-admin-ca create](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-admin-ca update](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator update radius auth-name :::Paragraph{indent="1"} Updates a RADIUS-based Services Director authenticator. ::: ### Syntax ```bash ssc sd-authenticator create radius auth-name authenticator-name auth-status [enable | disable] [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 Services Director authenticator. ::: ```bash auth-status ``` :::Paragraph{indent="1"} Specify whether the authenticator is either enabled or disabled. ::: ```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 sd-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 | +-----------------------------------------+ | SD Authenticator RADIUS Server modified | +-----------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add radius auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-authenticator update tacacs\_plus auth-name :::Paragraph{indent="1"} Updates a TACACS+-based Services Director authenticator. ::: ### Syntax ```bash ssc sd-authenticator update tacacs-plus auth-name authenticator-name auth-status [enable | disable] [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+ Services Director authenticator. ::: ```bash auth-status ``` :::Paragraph{indent="1"} Specify whether the authenticator is either enabled or disabled. ::: ```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 sd-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 | +------------------------------------------+ | SD Authenticator TACACS+ Server modified | +------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-admin-ca](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-authenticator add tacacs\_plus auth-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-authenticator test auth-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-permission-group create pg-name :::Paragraph{indent="1"} Creates a Services Director permission group for user authentication. ::: ### Syntax ```bash ssc sd-permission-group create pg-name pg-name [description description] ``` ### Parameters ```bash pg-name ``` :::Paragraph{indent="1"} Specify a name for the Services Director permission group. ::: ```bash description ``` :::Paragraph{indent="1"} Optionally, specify a description of the permission group. ::: ### Usage Guidelines :::Paragraph{indent="1"} Typically, there is a single Services Director permission group, with full access. The name of this permission group must match the group returned by the authenticator. ::: :::Paragraph{indent="1"} Use the** no ssc sd-permission-group pg-name** command to delete a permission group. ::: ### Examples ```bash amnesiac (config) # ssc sd-permission-group create pg-name admin2 description "administration group" +--------------------------------+ | Created | +--------------------------------+ | permission group admin created | +--------------------------------+ *** delete the admin permission group *** amnesiac (config) # no ssc sd-permission-group pg-name admin +--------------------------------+ | Deleted | +--------------------------------+ | permission group admin deleted | +--------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-permission-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-permission-group list](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-permission-group update pg-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-permission-group list :::Paragraph{indent="1"} Lists all defined Services Director permission groups. ::: ### Syntax ```bash ssc sd-permission-group list ``` ### Examples :::Paragraph{indent="1"} Typically, there is a single Services Director permission group, with full access. The name of this permission group matches the group returned by the authenticator. ::: ```bash amnesiac (config) # ssc sd-permission-group list +-------+--------------------------------------+ | Name | Unique ID | +-------+--------------------------------------+ | admin | Permission-Group-XG8K-FUYG-WKKV-9IKP | +-------+--------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-permission-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-permission-group create pg-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-permission-group update pg-name](docId\:H010mqCIZJAevKMkPzNkS) ::: ### ssc sd-permission-group update pg-name :::Paragraph{indent="1"} Updates a Services Director permission group. ::: ### Syntax ```bash ssc sd-permission-group update permission-group-name pg-name [new-pg-name new-pg-name] [description description] ``` ### Parameters ```bash permission-group-name pg-name ``` :::Paragraph{indent="1"} Specify a name for the Services Director permission group. ::: ```bash new-pg-name ``` :::Paragraph{indent="1"} Optionally, specify a new name for the Services Director permission group. ::: ```bash description ``` :::Paragraph{indent="1"} Optionally, specify a description of the permission group. ::: ### Usage Guidelines :::Paragraph{indent="1"} Typically, there is a single Services Director permission group, with full access. The name of this permission group matches the group returned by the authenticator. ::: :::Paragraph{indent="1"} Only the description and name can be changed. ::: ### Examples ```bash *** list the Services Director permission groups (there is only one) *** amnesiac (config) # ssc sd-permission-group list +-------+--------------------------------------+ | Name | Unique ID | +-------+--------------------------------------+ | admin | Permission-Group-IPI9-J91T-B5J7-D63F | +-------+--------------------------------------+ *** show details of the only permission group *** amnesiac (config) # show ssc sd-permission-group pg-name admin +---------------------+-----------------------------------------------------+ | Field | Value | +---------------------+-----------------------------------------------------+ | description | Single permission group for SD user authentication. | | permission_group_id | Permission-Group-IPI9-J91T-B5J7-D63F | | tag | admin | | children | None | +---------------------+-----------------------------------------------------+ *** update the permission group *** amnesiac (config) # ssc sd-permission-group update pg-name admin new-pg-name charcoal +--------------------------------+ | Updated | +--------------------------------+ | permission group admin updated | +--------------------------------+ *** display changes *** amnesiac (config) # show ssc sd-permission-group pg-name charcoal +---------------------+-----------------------------------------------------+ | Field | Value | +---------------------+-----------------------------------------------------+ | description | Single permission group for SD user authentication. | | permission_group_id | Permission-Group-IPI9-J91T-B5J7-D63F | | tag | charcoal | | children | None | +---------------------+-----------------------------------------------------+ ``` ### Related Commands :::Paragraph{indent="1"} [show ssc sd-permission-group](docId\:Daj0PxouZD3s712K5TKUW), [ssc sd-permission-group create pg-name](docId\:H010mqCIZJAevKMkPzNkS), [ssc sd-permission-group list](docId\:H010mqCIZJAevKMkPzNkS) :::