define | create security_token

Use the define | create security_token command to create a security token for deployment to ActiveSpaces requestor nodes.

When you enter the command, you are prompted to enter and verify a new token password for the security token. Enter and verify the password.

Syntax

define | create security_token domain_name <string>
policy_file <string> [create_identity [common_name <string>]
[encrypt <boolean>][validity_days <integer>]]token_file <string>

Parameters

The following table lists the parameters for this command with a description of each parameter.

define | create security_token Parameters
Parameter Description
domain_name Specifies the name of the domain for which the security token is to be created.
policy_file Specifies the name of the policy file that is to be used to create the token.
create_id Optional. Enter the create_id parameter if you want to create a private key to verify the identity of connecting nodes.
common_name Optional. If you enter the create_id parameter and you want to provide an X.509 common name to identify the private key, specify a common name. If you do not specify a common name, ActiveSpaces generates a common name that contains the domain name plus a random number; for example "/CN=AS-REQUESTOR-FEF3A467."

If there is no common name associated with the token, then node connections use a temporary name generated by ActiveSpaces. If you provide a common name for the token file, this name is always used.

encrypt Optional. If you enter the create_id parameter and you want to encrypt the private key, enter encrypt true (the default setting). If you do not want to encrypt the private key, enter encrypt false. Using encrypt false eliminates having to enter the password each time the node is started.
validity_days Optional. To specify the number of days that the private key is valid for, enter the number of days. The default setting is 365 days.
token_file Provide the name of the token file that is to be created.

Example

The following examples illustrate the syntax of the define | create security_token command: 

  • create security_token domain_name 'AS-DOMAIN' policy_file 'policy.txt' 
create_identity common_name 'MyRequestor-123' encrypt true validity_days 90 
token_file 'mytoken'
  • create security_token domain_name 'AS-DOMAIN' policy_file 'policy.txt' 
create_identity token_file 'newtoken'
  • create security_token domain_name 'AS-DOMAIN' policy_file 'policy.txt' 
create_identity common_name 'MyRequestor-123' encrypt true validity_days 100 
token_file 'mysecurity_token'
    Note: Parameter values must be enclosed in either single or double quotes.
Related concepts
Related tasks
Related reference