Red Hat Network API: systemgroup
- addOrRemoveAdmins
- addOrRemoveSystems
- create
- delete
- getDetails
- getDetails
- listActiveSystemsInGroup
- listAdministrators
- listAllGroups
- listAssociatedAdministrators
- listGroupsWithNoAssociatedAdmins
- listInactiveSystemsInGroup
- listInactiveSystemsInGroup
- listSystems
- update
Description
Provides methods to access and modify system groups.
Namespace:
systemgroup
Description:
Add or remove administrators to/from the given group.
Caller must be an organization administrator.
Parameters:
- string sessionKey
- string systemGroupName
- array loginNames - array of admin login names
- int add - 1 to add administrators, 0 to remove
Returns:
Description:
Add/remove the given servers to a system group.
Parameters:
- string sessionKey
- string systemGroupName
- array serverIds - array of server ID's to add or remove
- int add - 1 to add servers to the server group, 0 to remove
Returns:
Description:
Create a new system group.
Parameters:
- string sessionKey
- string name - Name for the new system group
- string description - Description for the new system group
Returns:
-
struct (server group details)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id"
Description:
Delete a system group.
Parameters:
- string sessionKey
- string systemGroupName
Returns:
Description:
Retrieve details of a ServerGroup based on its id
Parameters:
- string sessionKey
- int systemGroupId
Returns:
-
struct (server group details)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id"
Description:
Retrieve details of a ServerGroup based on its name
Parameters:
- string sessionKey
- string systemGroupName
Returns:
-
struct (server group details)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id"
Description:
Lists active systems within a server group
Parameters:
- string sessionKey
- string systemGroupName
Returns:
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"
- string "first_names"
- string "last_name"
- string "login" - user's login name
- string "login_uc" - uppercase version of login
- boolean "enabled"
Description:
Retrieve a list of system groups that are accessible by the logged
in user.
Parameters:
Returns:
-
array
- struct (server group details)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id"
Description:
Returns the list of administrators associated to this group.
Caller must be a system group admin or an organization administrator.
Parameters:
- string sessionKey
- string systemGroupName
Returns:
-
array
- struct (user)
- int "id"
- string "first_names"
- string "last_name"
- string "login" - user's login name
- string "login_uc" - uppercase version of login
- boolean "enabled"
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:
-
array
- struct (server group details)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id"
Description:
Lists inactive systems within a server group using a
specified inactivity time.
Parameters:
- string sessionKey
- string systemGroupName
- int daysInactive - Number of days a system must not check in
to be considered inactive.
Returns:
Description:
Lists inactive systems within a server group using the default
1 day threshold.
Parameters:
- string sessionKey
- string systemGroupName
Returns:
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 (system)
- int "id" - server id
- string "name" - server name
- string "last_checkin" - last time server successfully
checked in with Red Hat Network.
Description:
Update an existing system group.
Parameters:
- string sessionKey
- string systemGroupName
- string description - new description
Returns:
-
struct (server group details)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id"