Availability

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Release 6.4.0-SNAPSHOT

Related information for 6.4.0-SNAPSHOT

Help Text

No Format
 

Usage:
  servicedesk (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat
  <outputFormat>] [--columns <columns>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>]
  [--host <host>] [--port <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--dbJar <dbJar>]
  [--afterSql <afterSql>] [--dbTable <dbTable>] [--dbTableKeys <dbTableKeys>] [--dbCreateTable] [--comment <comment>] [--replace]
  [--propertyFile <propertyFile>] [--common <common>] [--special <special>] [--dateFormat <dateFormat>] [--dateFormat2 <dateFormat2>]
  [--reference <reference>] [--findReplace <findReplace>] [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--list2 <list2>]
  [--options <options>] [--continue] [--simulate] [--append] [--clearFileBeforeAppend] (-s|--server) <server> (-u|--user) <user>
  (-p|--password) <password> [--api <api>] [--service <service>] [--cookies <cookies>] [--project <project>] [--name <name>]
  [--request <request>] [--type <type>] [--issueType <issueType>] [--helpText <helpText>] [--participants <participants>]
  [--organization <organization>] [--forUser <forUser>] [--regex <regex>] [--limit <limit>] [--summary <summary>] [--description
  <description>] [--components <components>] [--priority <priority>] [--fields <fields>] [--field1 <field1>] [--field2 <field2>]
  [--field3 <field3>] [--field4 <field4>] [--field5 <field5>] [--field6 <field6>] [--field7 <field7>] [--field8 <field8>] [--value1
  <value1>] [--value2 <value2>] [--value3 <value3>] [--value4 <value4>] [--value5 <value5>] [--value6 <value6>] [--value7 <value7>]
  [--value8 <value8>] [--help]


	Provides capability to make requests to a remote server.
	Required parameters: action, server, password.
	Optional parameters: user (likely required for your installation).
	Other required and optional parameters depending on action requested.


  (-a|--action) <action>
        Requested operation to perform. Valid actions are listed at the end.

  [(-f|--file) <file>]
        Path to file based content or result output. Use - for standard input.

  [--encoding <encoding>]
        Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

  [--debug]
        Requests detail debug output. Optional for all actions.

  [-v|--verbose]
        Requests verbose output to help with problem determination. Optional for all actions.

  [--quiet]
        Limit some output messages. Optional for all actions.

  [--outputFormat <outputFormat>]
        Specify output format for an action. (default: 1)

  [--columns <columns>]
        Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column
        names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns
        will be ignored.

  [--connectionTimeout <connectionTimeout>]
        Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

  [--sql <sql>]
        SQL select statement used to generate a run script.

  [--driver <driver>]
        JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

  [--url <url>]
        Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

  [--host <host>]
        Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.

  [--port <port>]
        Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

  [--database <database>]
        Database name is required for SQL actions.

  [--dbUser <dbUser>]
        Database user name. Defaults to user.

  [--dbPassword <dbPassword>]
        Database user password. Defaults to password.

  [--dbJar <dbJar>]
        By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url
        reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or
        https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar

  [--afterSql <afterSql>]
        SQL to run after a successful action. Limited to specific actions at this time.

  [--dbTable <dbTable>]
        Database table name when creating or updating a database from list output.

  [--dbTableKeys <dbTableKeys>]
        Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for
        the table.

  [--dbCreateTable]
        Database table needs to be created before adding rows.

  [--comment <comment>]
        Comment text.

  [--replace]
        Replace existing entity on add, create, or similar actions.

  [--propertyFile <propertyFile>]
        Property file with database parameters, field mappings, or client specific information.

  [--common <common>]
        Common parameter string added to all run actions.

  [--special <special>]
        Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters
        used for specialized processing of some specific parameters.

  [--dateFormat <dateFormat>]
        Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is
        lenient starting with client date format and then some other standard formats based on JSON date format.

  [--dateFormat2 <dateFormat2>]
        Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only
        fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.

  [--reference <reference>]
        Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be
        referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement
        key.

  [--findReplace <findReplace>]
        Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded
        quotes must be escaped.

  [--findReplaceRegex <findReplaceRegex>]
        Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values
        containing a delimiter. Embedded quotes must be doubled.

  [--list <list>]
        Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a
        delimiter. Embedded quotes must be doubled.

  [--list2 <list2>]
        Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a
        delimiter. Embedded quotes must be doubled.

  [--options <options>]
        Comma separated list of support, experimental, or other client or action specific options.

  [--continue]
        Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors
        like not found errors on remove actions.

  [--simulate]
        Simulate running actions. Log the action that would be taken.

  [--append]
        Append values to existing values for version fields, components field, and custom fields supporting multiple values. For
        some actions using the file parameter, append will append output to the existing file.

  [--clearFileBeforeAppend]
        For run actions, this option will automatically clear an existing file on the first append requested.

  (-s|--server) <server>
        Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.

  (-u|--user) <user>
        User name for remote access. (default: automation)

  (-p|--password) <password>
        User password for remote access.

  [--api <api>]
        API version. Some requests produce different results based on the api version used. (default: latest)

  [--service <service>]
        Service address extension. (default: /rest/servicedeskapi)

  [--cookies <cookies>]
        Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session
        affinity for actions using REST APIs.

  [--project <project>]
        Service desk project name, key, or id. Also known as a service desk.

  [--name <name>]
        Name.

  [--request <request>]
        Request key or id.

  [--type <type>]
        Request type name or id.

  [--issueType <issueType>]
        JIRA issue type id.

  [--helpText <helpText>]
        Help text.

  [--participants <participants>]
        A comma separated list of user ids for request participation or as organization members.

  [--organization <organization>]
        Organization name or id representing a grouping of users primarily for access permissions.

  [--forUser <forUser>]
        Request is made on behalf of another user.

  [--regex <regex>]
        Regular expression for including matching content. For example, used to subset a request list.

  [--limit <limit>]
        Maximum number of entries to return. (default: 2147483647)

  [--summary <summary>]
        Summary of a request.

  [--description <description>]
        Description of a request.

  [--components <components>]
        Comma separated list of component names or ids.

  [--priority <priority>]
        Request priority - name or id.

  [--fields <fields>]
        Use to specify request fields. A comma separated list of key:value pairs. Single quote the key:value pair if it contains a
        comma (,) or line breaks. An alternative is to use a JSON formatted string to represent the list of key:value pairs.

  [--field1 <field1>]
        Field name. Value is specified by the value1 parameter.

  [--field2 <field2>]
        Field name. Value is specified by the value2 parameter.

  [--field3 <field3>]
        Field name. Value is specified by the value3 parameter.

  [--field4 <field4>]
        Field name. Value is specified by the value4 parameter.

  [--field5 <field5>]
        Field name. Value is specified by the value5 parameter.

  [--field6 <field6>]
        Field name. Value is specified by the value6 parameter.

  [--field7 <field7>]
        Field name. Value is specified by the value7 parameter.

  [--field8 <field8>]
        Field name. Value is specified by the value8 parameter.

  [--value1 <value1>]
        Value corresponding to the field1 parameter name.

  [--value2 <value2>]
        Value corresponding to the field2 parameter name.

  [--value3 <value3>]
        Value corresponding to the field3 parameter name.

  [--value4 <value4>]
        Value corresponding to the field4 parameter name.

  [--value5 <value5>]
        Value corresponding to the field5 parameter name.

  [--value6 <value6>]
        Value corresponding to the field6 parameter name.

  [--value7 <value7>]
        Value corresponding to the field7 parameter name.

  [--value8 <value8>]
        Value corresponding to the field8 parameter name.

  [--help]
        Prints this help message.


Valid actions (case insensitive):

getClientInfo - Get information about the this client tool.
	 Optional parameters: outputFormat, file, append, encoding
	 Output formats: 1 - basic, 2 - JVM, 11 - action list, 12 - parameter list
getServerInfo - Get information about the JIRA and Service Desk server.
	 Optional parameters: outputFormat, dateFormat, file, append, encoding
	 Output formats: 1 - basic, 2 - detail
validateLicense - Validates the CLI Connector is enabled and licensed on the server.
run - Run actions from a file or standard input.
	 Required parameters: file or standard input
	 Optional parameters: common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input
	 Required parameters: sql or file or standard input
	 Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword,
	 propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file.
	 Required parameters: file
	 Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromList - Run actions for each entry in a list.
	 When file is provided, each action in the file augmented by the common parameter will be run for each entry.
	 Otherwise, just the action specified by the common parameter will be run.
	 Available replacement variables are entry, entry2.
	 Required parameters: list
	 Optional parameters: list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromOrganizationList - Run actions for each organization from a list based on selection criteria similar to getOrganizationList. Available replacement variables are organization, organizationId.
	 Optional parameters: project, common, continue, simulate, limit, regex, clearFileBeforeAppend, file, encoding
runFromProjectList - Run actions for each project from a list based on selection criteria similar to getProjectList. Available replacement variables are serviceDesk, serviceDeskId, projectKey, projectId.
	 Optional parameters: common, continue, simulate, limit, regex, clearFileBeforeAppend, file, encoding
runFromMyRequestList - Run actions for each request from a list based on selection criteria similar to getMyRequestList. Available replacement variables are request and requestId.
	 Optional parameters: project, type, common, continue, simulate, limit, regex, clearFileBeforeAppend, file, encoding
getProjectList - List service desk projects with optional filtering by regex on project key.
	 Optional parameters: regex, file, columns, encoding
addRequestType - Add request type. The JIRA issue type id must be valid for the project.
	 Required parameters: project, name, issueType
	 Optional parameters: description, helpText
getRequestType - Get request type.
	 Required parameters: project, type
getRequestTypeList - List project's request types with optional filtering by regex on name.
	 Required parameters: project
	 Optional parameters: regex, file, columns, encoding
getFieldList - List fields with optional filtering by regex on field name. Specify specific project and/or type to filter selections, otherwise they default to @all.
	 Optional parameters: project, type, regex, file, columns, encoding
getRequest - Get a request by key or id.
	 Required parameters: request
	 Optional parameters: file, encoding
createRequest - Create a request for a service desk project.
	 Required parameters: project, type
	 Optional parameters: summary, description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
getMyRequestList - List requests the user is the reporter or a participatant with optional regex filtering on summary. You can also filter by service desk project and request type.
	 Optional parameters: project, type, regex, limit, outputFormat, file, columns, encoding
	 Output formats: 2 - fields
addParticipants - Add one or more participants to a request.
	 Required parameters: request, participants
removeParticipants - Remove one or more participants from a request.
	 Required parameters: request, participants
getParticipantList - List a request's participants with optional filtering by regex on name.
	 Required parameters: request
	 Optional parameters: regex, limit, file, columns, encoding
addOrganization - Cloud only. Experimental. Add a new organization to the site or add an existing organization to a project.
	 Required parameters: organization
	 Optional parameters: project, continue
removeOrganization - Cloud only. Experimental. Remove an organization from the site or from a project.
	 Required parameters: organization
	 Optional parameters: project, continue
addOrganizationUsers - Cloud only. Experimental. Add uses to an organization.
	 Required parameters: organization, participants
removeOrganizationUsers - Cloud only. Experimental. Remove users from an organization.
	 Required parameters: organization, participants
getOrganizationList - Cloud only. Experimental. List site organizations or project specific organizations with optional filtering by regex on name.
	 Optional parameters: project, regex, limit, file, columns, encoding
getOrganizationUserList - Cloud only. Experimental. List site organizations or project specific organizations with optional filtering by regex on user id.
	 Required parameters: organization
	 Optional parameters: regex, limit, file, columns, encoding