( Return to API Overview )

Available methods

Description

Provides methods to access and modify many aspects of configuration channels.

Namespace: configchannel

Method: channelExists

Description:
Check for the existence of the config channel provided.

Parameters:

string sessionKey
string channelLabel - Channel to check for.

Returns:

1 if exists, 0 otherwise.

Method: create

Description:
Create a new global config channel. Caller must be at least a config admin or an organization admin.

Parameters:

string sessionKey
string channelLabel
string channelName
string channelDescription

Returns:

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: createOrUpdatePath

Description:
Create a new file or directory with the given path, or update an existing path.

Parameters:

string sessionKey
string configChannelLabel
string path
boolean isDir - True if the path is a directory, False if it 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 start 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)

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: deleteChannels

Description:
Delete a list of global config channels. Caller must be a config admin.

Parameters:

string sessionKey
array:
- string - configuration channel labels to delete.

Returns:

int - 1 on success, exception thrown otherwise.

Method: deleteFiles

Description:
Remove file paths from a global channel.

Parameters:

string sessionKey
string channelLabel - Channel to remove the files from.
array:
- string - file paths to remove.

Returns:

int - 1 on success, exception thrown otherwise.

Method: getDetails

Description:
Lookup config channel details.

Parameters:

string sessionKey
string channelLabel

Returns:

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: getDetails

Description:
Lookup config channel details.

Parameters:

string sessionKey
int channelId

Returns:

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

Description:
Return a list of files in a channel.

Parameters:

string sessionKey
string channelLabel - label of config channel to list files on.

Returns:

array: struct - Configuration File information string "type" file directory string "path" - File Path dateTime.iso8601 "last_modified" - Last Modified Date

Method: listGlobals

Description:
List all the global config channels accessible to the logged-in user.

Parameters:

string sessionKey

Returns:

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

Method: lookupChannelInfo

Description:
Lists details on a list channels given their channel labels.

Parameters:

string sessionKey
array:
- string - configuration channel label

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: lookupFileInfo

Description:
Given a list of paths and a channel, returns details about the latest revisions of the paths.

Parameters:

string sessionKey
string channelLabel - label of config channel to lookup on
array:
- string - List of paths to examine.

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: scheduleFileComparisons

Description:
Schedule a comparison of the latest revision of a file against the version deployed on a list of systems.

Parameters:

string sessionKey
string channelLabel - Label of config channel
string path - File path
array:
- long - The list of server id that the comparison will be performed on

Returns:

int actionId - The action id of the scheduled action

Method: update

Description:
Update a global config channel. Caller must be at least a config admin or an organization admin, or have access to a system containing this config channel.

Parameters:

string sessionKey
string channelLabel
string channelName
string description

Returns:

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"

Generated on 7/31/2009