system.config

Available methods

Description

Provides methods to access and modify many aspects of configuration channels and server association. basically system.config name space

Namespace:

system.config

Method: addChannels

HTTP POST

Description:

Given a list of servers and configuration channels, this method appends the configuration channels to either the top or the bottom (whichever you specify) of a system’s subscribed configuration channels list. The ordering of the configuration channels provided in the add list is maintained while adding. If one of the configuration channels in the 'add' list has been previously subscribed by a server, the subscribed channel will be re-ranked to the appropriate place.

Parameters:

  • string sessionKey

  • int array sids - IDs of the systems to add the channels to.

  • string array configChannelLabels - 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

    • 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

HTTP POST

Description:

Create a new file (text or binary) or directory with the given path, or update an existing path on a server.

Parameters:

  • string sessionKey

  • int sid

  • string path - the configuration file/directory path

  • boolean isDir

    • True - if the path is a directory

    • False - if the path is a file

  • struct data

    • string "contents" - Contents of the file (text or base64 encoded if binary) ((only for non-directories)

    • boolean "contents_enc64" - Identifies base64 encoded content (default: disabled, only for non-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. (only for non-directories)

    • string "macro-end-delimiter" - Config file macro end delimiter. Use null or empty string to accept the default. (only for non-directories)

    • string "selinux_ctx" - SeLinux context (optional)

    • int "revision" - next revision number, auto increment for null

    • boolean "binary" - mark the binary content, if True, base64 encoded content is expected (only for non-directories)

  • boolean 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

      • symlink

    • string "path" - File Path

    • string "target_path" - Symbolic link Target File Path. Present for Symbolic links only.

    • string "channel" - Channel Name

    • string "contents" - File contents (base64 encoded according to the contents_enc64 attribute)

    • boolean "contents_enc64" - Identifies base64 encoded content

    • int "revision" - File Revision

    • dateTime.iso8601 "creation" - Creation Date

    • dateTime.iso8601 "modified" - Last Modified Date

    • string "owner" - File Owner. Present for files or directories only.

    • string "group" - File Group. Present for files or directories only.

    • int "permissions" - File Permissions (Deprecated). Present for files or directories only.

    • string "permissions_mode" - File Permissions. Present for files or directories only.

    • string "selinux_ctx" - SELinux Context (optional).

    • boolean "binary" - true/false , Present for files only.

    • string "sha256" - File’s sha256 signature. Present for files only.

    • string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.

    • string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.

Available since API version: 10.2

HTTP POST

Description:

Create a new symbolic link with the given path, or update an existing path.

Parameters:

  • string sessionKey

  • int sid

  • string path - the configuration file/directory path

  • struct data

    • string "target_path" - The target path for the symbolic link

    • string "selinux_ctx" - SELinux Security context (optional)

    • int "revision" - next revision number, auto increment for null

  • boolean 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

      • symlink

    • string "path" - File Path

    • string "target_path" - Symbolic link Target File Path. Present for Symbolic links only.

    • string "channel" - Channel Name

    • string "contents" - File contents (base64 encoded according to the contents_enc64 attribute)

    • boolean "contents_enc64" - Identifies base64 encoded content

    • int "revision" - File Revision

    • dateTime.iso8601 "creation" - Creation Date

    • dateTime.iso8601 "modified" - Last Modified Date

    • string "owner" - File Owner. Present for files or directories only.

    • string "group" - File Group. Present for files or directories only.

    • int "permissions" - File Permissions (Deprecated). Present for files or directories only.

    • string "permissions_mode" - File Permissions. Present for files or directories only.

    • string "selinux_ctx" - SELinux Context (optional).

    • boolean "binary" - true/false , Present for files only.

    • string "sha256" - File’s sha256 signature. Present for files only.

    • string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.

    • string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.

Available since API version: 10.2

Method: deleteFiles

HTTP POST

Description:

Removes file paths from a local or sandbox channel of a server.

Parameters:

  • string sessionKey

  • int sid

  • string array paths

  • 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

HTTP POST

Description:

Schedules a deploy action for all the configuration files on the given list of systems.

Parameters:

  • string sessionKey

  • int array sids - IDs 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

HTTP GET

Description:

List all global('Normal', 'State') configuration channels associated to a system in the order of their ranking.

Parameters:

  • string sessionKey

  • int sid

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

HTTP GET

Description:

Return the list of files in a given channel.

Parameters:

  • string sessionKey

  • int sid

  • 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

      • symlink

    • 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

HTTP GET

Description:

Given a list of paths and a server, returns details about the latest revisions of the paths.

Parameters:

  • string sessionKey

  • int sid

  • string array paths - paths to lookup on.

  • boolean 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

      • symlink

    • string "path" - File Path

    • string "target_path" - Symbolic link Target File Path. Present for Symbolic links only.

    • string "channel" - Channel Name

    • string "contents" - File contents (base64 encoded according to the contents_enc64 attribute)

    • boolean "contents_enc64" - Identifies base64 encoded content

    • int "revision" - File Revision

    • dateTime.iso8601 "creation" - Creation Date

    • dateTime.iso8601 "modified" - Last Modified Date

    • string "owner" - File Owner. Present for files or directories only.

    • string "group" - File Group. Present for files or directories only.

    • int "permissions" - File Permissions (Deprecated). Present for files or directories only.

    • string "permissions_mode" - File Permissions. Present for files or directories only.

    • string "selinux_ctx" - SELinux Context (optional).

    • boolean "binary" - true/false , Present for files only.

    • string "sha256" - File’s sha256 signature. Present for files only.

    • string "macro-start-delimiter" - Macro start delimiter for a config file. Present for text files only.

    • string "macro-end-delimiter" - Macro end delimiter for a config file. Present for text files only.

Available since API version: 10.2

Method: removeChannels

HTTP POST

Description:

Remove config channels from the given servers.

Parameters:

  • string sessionKey

  • int array sids - the IDs of the systems from which you would like to remove configuration channels..

  • string array configChannelLabels - List of configuration channel labels to remove.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: scheduleApplyConfigChannel

HTTP POST

Description:

Schedule highstate application for a given system.

Parameters:

  • string sessionKey

  • int array sids

  • dateTime.iso8601 earliestOccurrence

  • boolean test - Run states in test-only mode

Returns:

  • int actionId

Method: setChannels

HTTP POST

Description:

Replace the existing set of config channels on the given servers. Channels are ranked according to their order in the configChannelLabels array.

Parameters:

  • string sessionKey

  • int array sids - IDs of the systems to set the channels on.

  • string array configChannelLabels - List of configuration channel labels in the ranked order.

Returns:

  • int - 1 on success, exception thrown otherwise.