( Return to API Overview )

Description

Provides methods to access and modify many aspects of a system group within the Red Hat Network.

Namespace: systemgroup

Method: addOrRemoveAdmins

Description:
Add or remove administrators to/from the given group. Caller must be an organization administrator.

Parameters:

string sessionKey
string systemGroupName
array
- string loginName - User's login name.
int add - 1 to add administrators, 0 to remove.

Returns: int - 1 on success.

Method: addOrRemoveSystems

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

Parameters:

string sessionKey
string systemGroupName
array
- int serverId
boolean add - True to add to the group, False to remove.

Returns: int - 1 on success.

Method: create

Description:
Create a new system group.

Parameters:

string sessionKey
string name - Name of the system group.
string description - Description of the system group.

Returns: struct (server group)

 int "id"
 string "name"
 string "description"
 int "org_id"
 int "system_count"

Method: delete

Description:
Delete a system group.

Parameters:

string sessionKey
string systemGroupName

Returns: int - 1 on success.

Method: getDetails

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

Parameters:

string sessionKey
int systemGroupId

Returns: struct (system group)

 int "id"
 string "name"
 string "description"
 int "org_id"
 int "system_count"

Method: getDetails

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

Parameters:

string sessionKey
string systemGroupName

Returns: struct (system group)

 int "id"
 string "name"
 string "description"
 int "org_id"
 int "system_count"

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:

string sessionKey
string systemGroupName

Returns: array

 struct (user)
  int "id" - User ID.
 string "login" - User login.
 string "login_uc" - User login in uppercase.

Method: listAllGroups

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

Parameters:

string sessionKey

Returns: array

 struct (system group)
  int "id"
 string "name"
 string "description"
 int "org_id"
 int "system_count"

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:

string sessionKey

Returns: array

 struct (system group)
  int "id"
 string "name"
 string "description"
 int "org_id"
 int "system_count"

Method: listSystems

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

Parameters:

string sessionKey
string systemGroupName

Returns: array

 struct (server)
  string "profile_name" - System's profile name.
 string "base_entitlement" - System's base entitlement label. (enterprise_entitled or sw_mgr_entitled)
 array "addonEntitlements"  string addonEntitlement - One of:  monitoring_entitled
 provisioning_entitled
 virtualization_host
 virtualization_host_platform)
 
 
 
 
 boolean "auto_errata_update" - True if system has auto errata updates enabled.
 string "address1" - System's address line 1.
 string "address1" - System's address line 2.
 string "city" - System's city.
 string "state" - System's state.
 string "country" - System's country code.
 string "building" - System's building.
 string "room" - System's room.
 string "rack" - System's rack.

Method: update

Description:
Update an existing system group.

Parameters:

string sessionKey
string systemGroupName
string description

Returns: struct (system group)

 int "id"
 string "name"
 string "description"
 int "org_id"
 int "system_count"