Description

Namespace: system.config

Method: addChannels

Parameters:

• string sessionKey
• array:
  • int - IDs of the systems to add the channels to.
• array:
  • string - List of configuration channel labels in the ranked order.
• boolean addToTop
  • true - to prepend the given channels list to the top of the configuration channels list of a server
  to the system's local override configuration channel")
  • false - to append the given channels list to the bottom of the configuration channels list of a server

Returns:

• int - 1 on success, exception thrown otherwise.

Method: createOrUpdatePath

Parameters:

• string sessionKey
• int serverId
• string path - the configuration file/directory path
• boolean isDir
  • True - if the path is a directory
  • False - if the path is a file
• struct - path info
  • string "contents" - Contents of the file (text or base64 encoded if binary). (ignored for directories)
  • string "owner" - Owner of the file/directory.
  • string "group" - Group name of the file/directory.
  • string "permissions" - Octal file/directory permissions (eg: 644)
  • string "macro-start-delimiter" - Config file macro end delimiter. Use null or empty string to accept the default. (ignored if working with a directory)
  • string "macro-end-delimiter" - Config file macro end delimiter. Use null or empty string to accept the default. (ignored if working with a directory)
• int commitToLocal
  • 1 - to commit configuration files to the system's local override configuration channel
  • 0 - to commit configuration files to the system's sandbox configuration channel

Returns:

• struct - Configuration Revision information
  • string "type"
  • file
  • directory
  • string "path" - File Path
  • string "channel" - Channel Name
  • string "contents" - File contents for text files only.
  • int "revision" - File Revision
  • dateTime.iso8601 "creation" - Creation Date
  • dateTime.iso8601 "modified" - Last Modified Date
  • string "owner" - File Owner
  • string "group" - File Group
  • int "permissions" - File Permissions (Deprecated)
  • string "permissions_mode" - File Permissions
  • boolean "binary" - true/false , Present for files only.
  • string "md5" - File's md5 signature. Present for files only.
  • string "macro-start-delimiter" - Macro start delimiter for a config file. Present for files only.
  • string "macro-end-delimiter" - Macro end delimiter for a config file. Present for files only.

Available since: 10.2

Method: deleteFiles

Parameters:

• string sessionKey
• int serverId
• array:
  • string - paths to remove.
• boolean deleteFromLocal
  • True - to delete configuration file paths from the system's local override configuration channel
  • False - to delete configuration file paths from the system's sandbox configuration channel

Returns:

• int - 1 on success, exception thrown otherwise.

Method: deployAll

Parameters:

• string sessionKey
• array:
  • int - id of the systems to schedule configuration files deployment
• dateTime.iso8601 date - Earliest date for the deploy action.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: listChannels

Parameters:

• string sessionKey
• int serverId

Returns:

• array:
  • struct - Configuration Channel information
    • int "id"
    • int "orgId"
    • string "label"
    • string "name"
    • string "description"
    • struct "configChannelType"
    struct - Configuration Channel Type information
    • int "id"
    • string "label"
    • string "name"
    • int "priority"

Method: listFiles

Parameters:

• string sessionKey
• int serverId
• int listLocal
  • 1 - to return configuration files in the system's local override configuration channel
  • 0 - to return configuration files in the system's sandbox configuration channel

Returns:

• array:
  • struct - Configuration File information
    • string "type"
    • file
    • directory
    • string "path" - File Path
    • string "channel_label" - the label of the central configuration channel that has this file. Note this entry only shows up if the file has not been overridden by a central channel.
    • struct "channel_type"
    struct - Configuration Channel Type information
    • int "id"
    • string "label"
    • string "name"
    • int "priority"
    • dateTime.iso8601 "last_modified" - Last Modified Date

Method: lookupFileInfo

Parameters:

• string sessionKey
• int serverId
• array:
  • string - paths to lookup on.
• int searchLocal
  • 1 - to search configuration file paths in the system's local override configuration or systems subscribed central channels
  • 0 - to search configuration file paths in the system's sandbox configuration channel

Returns:

• array:
  • struct - Configuration Revision information
    • string "type"
    • file
    • directory
    • string "path" - File Path
    • string "channel" - Channel Name
    • string "contents" - File contents for text files only.
    • int "revision" - File Revision
    • dateTime.iso8601 "creation" - Creation Date
    • dateTime.iso8601 "modified" - Last Modified Date
    • string "owner" - File Owner
    • string "group" - File Group
    • int "permissions" - File Permissions (Deprecated)
    • string "permissions_mode" - File Permissions
    • boolean "binary" - true/false , Present for files only.
    • string "md5" - File's md5 signature. Present for files only.
    • string "macro-start-delimiter" - Macro start delimiter for a config file. Present for files only.
    • string "macro-end-delimiter" - Macro end delimiter for a config file. Present for files only.

Available since: 10.2

Method: removeChannels

Parameters:

• string sessionKey
• array:
  • int - the IDs of the systems from which you would like to remove configuration channels..
• array:
  • string - List of configuration channel labels to remove.

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setChannels

Parameters:

• string sessionKey
• array:
  • int - IDs of the systems to set the channels on.
• array:
  • string - List of configuration channel labels in the ranked order.

Returns:

• int - 1 on success, exception thrown otherwise.