Managing credentials definition from the Orchestration CLI

In this topic you can find the syntax to manage credentials definition.

You can define credentials for a task template definition.

For more information, see Using credentials on task definitions.

Each user definition has the following format and arguments:

Syntax

username[workstation#]username
description
secret “passwordˮ
end

Arguments

username

[folder/] [workstation#]username

[folder/]workstation: Using this command, you can define the workstation on which the user is authorized to run task templates. If any, you can also define the folder that contains the workstation. A number sign (#) must be placed between workstation and username. If not specified, the default value is blank and it returns all workstations.
username: Using this command, you can define the user name.; The name must start with a letter or a number, and can contain alphanumeric characters, dashes, and underscores.

Note:

User names are case sensitive on all supported operating systems. It is necessary for users to be authorized to log on to the workstation on which task templates run. For Windows users, the permission to Log on as batch is required.

description

Using this keyword, you can specify a description for the credentials.

secret

This command defines the user password. When saving a user definition, the password is hidden behind a sequence of ten asterisks (**********). Authorized users can change or delete other users, though password information is never shown. Running ocli model commands on a hidden password has no effect.

The secret keyword is mandatory.

Note: You can use any sequence of asterisks as a password, except for a sequence of ten of them.

Examples

In this section, you can find examples about credentials definitions.

The following example defines a user named USER1:
```
USERNAME USER1
  PASSWORD "password"
END
```
After saving the definition, you can see it displayed as follows:
```
$credentials

USERNAME USER1
  SECRET "**********"
END
```
The following example defines a user named USER1:
```
USERNAME USER1
  PASSWORD "password"
END
```
After saving the definition, you can see it displayed as follows:
```
$credentials

USERNAME USER1
  SECRET "**********"
END
```

The following example defines a user named USER2 and a description:

USERNAME USER2
  DESCRIPTION "new user definition"
  PASSWORD "password"
END

After saving the definition, you can see it displayed as follows:

$credentials

USERNAME USER2
  DESCRIPTION "new user definition"
  SECRET "**********"
END

The following example defines credentials with a special character in the password:
```
USERNAME 1USER
  PASSWORD "pass!w@ord"
END
```
After saving the definition, you can see it displayed as follows:
```
$credentials

USERNAME 1USER
  SECRET "**********"
END
```
The following example defines a user named USER1 on the WS_AGT_0 workstation:
```
USERNAME WS_AGT_0#USER1
  PASSWORD "password"
END
```
After saving the definition, you can see it displayed as follows:
```
$credentials

USERNAME /WS_AGT_0#USER1
  SECRET "**********"
END
```
The following example defines a user named USER2 on the WS_AGT_1 workstation, providing also a description:
```
USERNAME WS_AGT_1#USER2
  DESCRIPTION "new user definition"
  PASSWORD "password"
END
```
After saving the definition, you can see it displayed as follows:
```
$credentials

USERNAME /WS_AGT_1#USER2
  DESCRIPTION "new user definition"
  SECRET "**********"
ENDEND
```