( Return to API Overview )

Available methods

Description

Provides methods to access and modify system groups.

Namespace: systemgroup


Method: addOrRemoveAdmins

Description:
Add or remove administrators to/from the given group. Satellite and Organization administrators are granted access to groups within their organization by default; therefore, users with those roles should not be included in the array provided. Caller must be an organization administrator.

Parameters:

Returns:


Method: addOrRemoveSystems

Description:
Add/remove the given servers to a system group.

Parameters:

Returns:


Method: create

Description:
Create a new system group.

Parameters:

Returns:


Method: delete

Description:
Delete a system group.

Parameters:

Returns:


Method: getDetails

Description:
Retrieve details of a ServerGroup based on it's id

Parameters:

Returns:


Method: getDetails

Description:
Retrieve details of a ServerGroup based on it's name

Parameters:

Returns:


Method: listActiveSystemsInGroup

Description:
Lists active systems within a server group

Parameters:

Returns:


Method: listAdministrators

Description:
Returns the list of users who can administer the given group. Caller must be a system group admin or an organization administrator.

Parameters:

Returns:


Method: listAllGroups

Description:
Retrieve a list of system groups that are accessible by the logged in user.

Parameters:

Returns:


Method: listGroupsWithNoAssociatedAdmins

Description:
Returns a list of system groups that do not have an administrator. (who is not an organization administrator, as they have implicit access to system groups) Caller must be an organization administrator.

Parameters:

Returns:


Method: listInactiveSystemsInGroup

Description:
Lists inactive systems within a server group using a specified inactivity time.

Parameters:

Returns:


Method: listInactiveSystemsInGroup

Description:
Lists inactive systems within a server group using the default 1 day threshold.

Parameters:

Returns:


Method: listSystems

Description:
Return a list of systems associated with this system group. User must have access to this system group.

Parameters:

Returns:


Method: listSystemsMinimal

Description:
Return a list of systems associated with this system group. User must have access to this system group.

Parameters:

Returns:


Method: scheduleApplyErrataToActive

Description:
Schedules an action to apply errata updates to active systems from a group.

Parameters:

Returns:

Available since: 13.0


Method: scheduleApplyErrataToActive

Description:
Schedules an action to apply errata updates to active systems from a group at a given date/time.

Parameters:

Returns:

Available since: 13.0


Method: update

Description:
Update an existing system group.

Parameters:

Returns:


Generated on 8/30/2017