Description

Namespace: systemgroup

Method: addOrRemoveAdmins

Parameters:

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

Returns:

• int - 1 on success, exception thrown otherwise.

Method: addOrRemoveSystems

Parameters:

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

Returns:

• int - 1 on success, exception thrown otherwise.

Method: create

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

Parameters:

• string sessionKey
• string systemGroupName

Returns:

• int - 1 on success, exception thrown otherwise.

Method: getDetails

Parameters:

• string sessionKey
• int systemGroupId

Returns:

• struct - Server Group
  • int "id"
  • string "name"
  • string "description"
  • int "org_id"
  • int "system_count"

Method: getDetails

Parameters:

• string sessionKey
• string systemGroupName

Returns:

• struct - Server Group
  • int "id"
  • string "name"
  • string "description"
  • int "org_id"
  • int "system_count"

Method: listActiveSystemsInGroup

Parameters:

• string sessionKey
• string systemGroupName

Returns:

• array:
  • int server_id

Method: listAdministrators

Parameters:

• string sessionKey
• string systemGroupName

Returns:

• array:
  • struct - user
    • int "id"
    • string "login"
    • string "login_uc" - upper case version of the login
    • boolean "enabled" - true if user is enabled, false if the user is disabled

Method: listAllGroups

Parameters:

• string sessionKey

Returns:

• array:
  • struct - Server Group
    • int "id"
    • string "name"
    • string "description"
    • int "org_id"
    • int "system_count"

Method: listGroupsWithNoAssociatedAdmins

Parameters:

• string sessionKey

Returns:

• array:
  • struct - Server Group
    • int "id"
    • string "name"
    • string "description"
    • int "org_id"
    • int "system_count"

Method: listInactiveSystemsInGroup

Parameters:

• string sessionKey
• string systemGroupName
• int daysInactive - Number of days a system must not check in to be considered inactive.

Returns:

• array:
  • int server_id

Method: listInactiveSystemsInGroup

Parameters:

• string sessionKey
• string systemGroupName

Returns:

• array:
  • int server_id

Method: listSystems

Parameters:

• string sessionKey
• string systemGroupName

Returns:

• array:
  • struct - server details
    • int "id" - System id
    • string "profile_name"
    • string "base_entitlement" - System's base entitlement label. (enterprise_entitled or sw_mgr_entitled)
    • array "string"
      • addon_entitlements System's addon entitlements labels, including monitoring_entitled, provisioning_entitled, virtualization_host, virtualization_host_platform
    • boolean "auto_update" - True if system has auto errata updates enabled.
    • string "release" - The Operating System release (i.e. 4AS, 5Server
    • string "address1"
    • string "address2"
    • string "city"
    • string "state"
    • string "country"
    • string "building"
    • string "room"
    • string "rack"
    • string "description"
    • string "hostname"
    • string "osa_status" - Either 'unknown', 'offline', or 'online'.
    • boolean "lock_status" - True indicates that the system is locked. False indicates that the system is unlocked.

Method: update

Parameters:

• string sessionKey
• string systemGroupName
• string description

Returns:

• struct - Server Group
  • int "id"
  • string "name"
  • string "description"
  • int "org_id"
  • int "system_count"