Global substitutions
Inside tasks and messages the following substitutions are available globally:
Note
The following global substitution names shouldn't be used for custom parameter names
| Substitution | Meaning |
|---|---|
| %(O_TASK_UTC_STARTTIME)s | The time stamp of when the task first started. This remains the same through out any one task. |
| %(O_LOG_LEVEL)s | The logging level: INFO or DEBUG. |
| %(O_LOG_PREFIX)s | The ID of the task running. This is also the ID number used in the name of the log file for this task. |
| %(O_VERSION_LABEL)s | The device version that was read by the version command at the start of the task. |
| %(logonname)s | The control account used to connect to the device to run the task. |
| %(logonpassword)s | The password of the account used to connect to the device to run the task on. |
| %(hostname)s | This is the hostname of the device, as defined in the connection critical parameters. |
| %(ip_address)s | This is the IP address of the device, as defined in the connection critical parameters. |
| %(ssh_port)s | This is the SSH port to connect to the device on, if defined in the connection critical parameters. |
| %(http_port)s | This is the HTTP port to connect to the device on, if defined in the connection critical parameters. |
| %(https_port)s | This is the HTTPS port to connect to the device on, if defined in the connection critical parameters. |
| %(rdp_port)s | This is the RDP port to connect to the device on, if defined in the connection critical parameters. |
| %(username)s | In a System Task this is the name of the account being actioned on, i.e. added, deleted, password changed etc. In a User Task The username of the user running the task. |
| %(userpassword)s | The current password for the account specified by %(username)s. |
| %(user.password.old)s | The previous password for the account specified by %(username)s. |
| %(accesstoken)s | The name of the access token (role) the user has been granted on the device. |
| %(local_backup_location)s | The file location that the Osirium PAM stores backup files. This defaults to: /data/osirium/filestore. |
| %(local_techout_location)s | The file location that the Osirium PAM stores techout files. This defaults to: '/data/osirium/filestore'. |
| %(osirium_address)s | This is the IP address of the primary interface of rhe Osirium PAM. |
| %(space)s | This sends an explicit whitespace character to a device in a task command. Can also be used as the last character in the command. |