ctm-describe-api ¶

Retrieves a list of all REST API methods and their documentation.

OPTIONAL PARAMETERS
    -l,--listonly            List the methods without documentation.

Examples

To print a full listing of all api commands with documentation

ctm-describe-api

To print only the names with the api commands sorted

ctm-describe-api -l

ctm-get-asset ¶

Prints the properties of an Asset

REQUIRED PARAMETERS
    -a,--asset               The ID or Name of an Asset.

Examples

ctm-get-asset -a "database001"

Associated API: get_asset

Gets an Asset.

Required Arguments:

asset - an Asset Name or ID.

Returns: An Asset Object.

ctm-get-license ¶

Prints the license information including expiration date

Examples

ctm-get-license

Associated API: get_license

Get the license details.

Only users with the role "System Administrator" can get the license details.

Required Arguments:

license - The text of a license key provided by Agility Connect.

Returns: The relevant properties of the current license.

ctm-get-project ¶

Gets a Project Definition.

REQUIRED PARAMETERS
    -p,--project             Value can be either a Project ID or Name.

Examples

ctm-get-project -p "ProjectName"

Associated API: get_project

Gets a Project object.

Required Arguments:

project - the id or name of a Project.

Returns: A Project Object.

ctm-get-settings ¶

Gets all the configuration settings from the database in json format

OPTIONAL PARAMETERS
    -m,--module              Filter to a specific module.

Examples

To get all config settings in text format

ctm-get-settings

To get all config settings in json format

ctm-get-settings -F "json"

To get the settings only for the messenger module

ctm-get-settings -m "Messenger"

To get a list of the module names available in the settings configurations

ctm-get-settings |grep -v "^ "|grep -v "^$"

Associated API: get_settings

Lists all the settings of modules.

Only users with the role "System Administrator" can get settings.

Optional Arguments:

module - name of the module. If omitted, all module settings are returned.

Returns: A Settings Object.

ctm-get-system-log ¶

Get the System Log.

OPTIONAL PARAMETERS
    -i,--object_id           An Object ID filter.
    -t,--object_type         The integer representation of an internal
                                  object type. Can be used with one of the
                                  following when log_type = Object: (User =
                                  1, Asset = 2, Task = 3, Schedule = 4, Tag
                                  = 7, Image = 8, MessageTemplate = 18,
                                  Parameter = 34, Credential = 35, Domain =
                                  36, CloudAccount = 40, Cloud = 41,
                                  CloudKeyPair = 45)
    -u,--user                A user name to filter result on.
    -l,--log_type            The type of log, either Object or Security
    -a,--action              The action that triggered a log entry. One
                                  of the following: (UserLogin, UserLogout,
                                  UserLoginAttempt, UserPasswordChange,
                                  UserSessionDrop, ObjectAdd, ObjectModify,
                                  ObjectDelete, bjectView, ObjectCopy,
                                  ConfigChange)
    -f,--filter              A filter whereby the results would contain
                                  this string
    --from                   A "from" date in the format of m/d/yyyy.
    --to                     A "to" date in the format of m/d/yyyy.
    -r,--records             Maximum number of records to return,
                                  default is 100.

Examples

To get the last 100 denied login attempts

ctm-get-system-log -l "Security" -a "UserLoginAttempt"

To get any log entries attributed to the administrator user between two dates

ctm-get-system-log -u "administrator" -l "Object" --from "1/6/2014" --to "1/7/2014"

To get the last 300 task modifications

ctm-get-system-log -t 3 -r 300

Associated API: get_system_log

Gets the system log. If all arguments are omitted, will return the most recent 100 entries.

Only users with the role "System Administrator" can get the system log.

Optional Arguments:

object_id - An object_id filter to limit the results.
object_type - An object_type filter to limit the results.
log_type - A log_type filter. ('Security' or 'Object')
action - An action filter.
filter - A filter to limit the results.
from - a date string to set as the "from" marker. (mm/dd/yyyy format)
to - a date string to set as the "to" marker. (mm/dd/yyyy format)
records - a maximum number of results to get.

Returns: A list of Log Entry Objects.

ctm-install-license ¶

Installs or updates the Agility Connect/Continuum license by importing a license file

REQUIRED PARAMETERS
    -i,--inputfile           Path to a license.dat file.

Examples

ctm-install-license -i "~/license.lic"

Associated API: install_license

Installs a license file.

Only users with the role "System Administrator" can install a license.

Required Arguments:

license - The text of a license key provided by Agility Connect.

Returns: Success or Error message.

ctm-list-commands ¶

Lists all installed ctm-* commands. Accepts no arguments.

ctm-list-projects ¶

Lists all Projects.

OPTIONAL PARAMETERS
    -f,--filter              A filter.
    -l,--limit               The maximum number of items to retrieve,
                                  or 0 for unlimited. (Default is
                                  unlimited.)

Examples

_List all Projects

ctm-list-projects

Associated API: list_projects

Lists all Projects.

Optional Arguments:

by_name - A regex expression to filter project results by name.
limit - Maximum number of items to return, or 0 for unlimited. (Default is unlimited.)

Returns: A list of Project Objects.

ctm-list-users ¶

Lists Users, Authentication type will be set to SSO if SSO is enabled in this instance

OPTIONAL PARAMETERS
    -f,--filter              A string to use to filter the resulting
                                  data. Any row of data that has one field
                                  contains the string will be returned.
    -l,--limit               The maximum number of items to retrieve,
                                  or 0 for unlimited. (Default is
                                  unlimited.)

Examples

List all users

ctm-list-users

List all users with Administrator role

ctm-list-users -f "Administrator"

Associated API: list_users

Lists all registered Users.

Only users with the role "System Administrator" can list all registered users. If the credentials used for this API call do not have the proper permission, the call will not succeed.

Optional Arguments:

filter - will filter a value match on: (Multiple filter arguments can be provided, delimited by spaces.)
- Full Name
- Login ID
- Role
- Email address
limit - Maximum number of items to return, or 0 for unlimited. (Default is unlimited.)

Returns: A list of User Objects.

ctm-reset-password ¶

Resets a User's login password.

OPTIONAL PARAMETERS
    -p,--password            The new password.
    -u,--user                The ID or Name of a User Account.
    -g,--generate            Generate a new, random password.

Examples

Reset a User's password to a random password which will be emailed to the user

ctm-reset-password -u "username1" bob -g

Reset a User's password to a specified password

ctm-reset-password -u "username1" -p "passw0rd"

Associated API: reset_password

Resets the password of the authenticated, or a specified User.

If a user is specified, and the authenticated user has the permission to reset other users' passwords, this will reset the password of the specified user to the provided value. Only users with the role "System Administrator" can change other users' passwords.

If no user is specified, the password of the authenticated user will be changed.

NOTE: to prevent accidental change of an Administrator's password, an extra trap is in place: the username (or id) MUST be provided, even if the authenticated user is the user being changed.

Required Arguments:

password - the new password -or-
generate - generate a random password.

Optional Arguments:

user - Either the User ID or Name.

Returns: Success message if successful, error messages on failure.

ctm-test-messagehub ¶

Sends a test alert message to the UI.

REQUIRED PARAMETERS
    -s,--server              URL of the Agile Connect/Continuum server.
                                  Use "wss" if server is running in SSL
                                  mode, otherwise use "ws".  Use the port as
                                  configured, or the default of 8083.

Examples

To send an email to an email address

ctm-test-messagehub -u ws://10.0.0.1:8083

ctm-update-user ¶

Updates a User account, Authentication type will be set to SSO if SSO is enabled in this instance

REQUIRED PARAMETERS
    -u,--user                The ID or Name of a User account.
OPTIONAL PARAMETERS
    -n,--name                The full name of the user.
    -r,--role                The users role.  (Valid values:
                                  Administrator, Developer, User)
                                  Valid Values: Administrator|Developer|User
    -t,--teams               A list of teams the user belongs to, along
                                  with a role for each team. Teams and roles
                                  are separated by a colon. Team/role pairs
                                  are separated by commas.
    --is-sys-admin           Whether the user should have system
                                  administrator privileges. (Valid values:
                                  True or False)
    --is-shared-asset-mgr    Whether the user should have shared asset
                                  manager privileges. (Valid values: True or
                                  False)
    -e,--email               Email address for the user.  Required if
                                  "password" is omitted.
    -a,--authtype            "local" or "ldap".  Default is "local" if
                                  omitted.
                                  Valid Values: local|ldap
    -f,--forcechange         Require user to change password. Default
                                  is "true" (1) if omitted. (Valid values: 0
                                  or 1).
                                  Valid Values: 0|1
    -s,--status              Status of the new account. Default is
                                  "enabled" if omitted. (Valid values:
                                  enabled, disabled, locked)
                                  Valid Values: enabled|disabled|locked
    -x,--expires             Expiration date for this account.  Must be
                                  in mm/dd/yyyy format.
    -g,--groups              A list of groups the user belongs to.
                                  Group names cannot contain spaces. Comma
                                  delimited list.
    -c,--contributors        Usernames in source control management
                                  systems related to an user. Comma
                                  delimited list.
    -p,--password            The new password.
    --generate               Generate a new, random password.

Examples

ctm-update-user -u "dave.thomas" -s "disabled"  --force

Associated API: update_user

Updates a user account.

Only users with the role "System Administrator" can update users. If the credentials used for this API call do not have the proper permission, the call will not succeed.

Properties will only be updated if the option is provided. Omitted properties will not be changed.

NOTE: the "username" of a user cannot be changed.

If a user has 'locked' their account by numerous failed login attempts, the flag is reset by setting any property. It's easiest to just set the status to 'enabled'.

Required Arguments:

user - ID or Name of the User to update.

Optional Arguments:

name - The full name of the user.
role - The user's role. (Valid values: Administrator, Developer, User)
teams - A list of teams the user belongs to, along with a role for each team. Teams and roles are separated by a a colon. Team/role pairs are separated by commas. Valid roles are: Team Administrator, Developer, User. Example: "Default:User,Team1:Team Administrator,Team2:Developer"
is_system_administrator - Whether the user should have system administrator privileges. (Valid values: 'true' or 'false') Default is false.
is_shared_asset_manager - Whether the user should have shared asset manager privileges. (Valid values: 'true' or 'false') Default is false.
email - Email address for the user. Can be cleared with "None".
authtype - 'local' or 'ldap'.
forcechange - Require user to change password on next login. (Valid values: 'true' or 'false')
status - Status of the account. (Valid values: enabled, disabled, locked)
expires - Expiration date for this account. Must be in mm/dd/yyyy format. Can be cleared with "None".
groups - Add to the list of assignment groups the user belongs to. Group names cannot contain spaces. Comma delimited list.
contributors - Contributors are usernames in source control management systems related to this User (Enter one or more comma-separated Contributor 'aliases').
password - The new password. If a password is set then the 'generate' option is ignored`.
- OR -
generate - Generate a random password. (This only works if no password is provided via the 'password' option.)

Returns: A User Object.

ctm-version ¶

Displays the Version by request from the API.

Examples

ctm-version

Associated API: version

Returns: The Agility Connect version.