Description

Namespace: org

Method: create

Parameters:

• string sessionKey
• string orgName - Organization name. Must meet same criteria as in the web UI.
• string adminLogin - New administrator login name.
• string adminPassword - New administrator password.
• string prefix - New administrator's prefix. Must match one of the values available in the web UI. (i.e. Dr., Mr., Mrs., Sr., etc.)
• string firstName - New administrator's first name.
• string lastName - New administrator's first name.
• string email - New administrator's e-mail.
• boolean usePamAuth - True if PAM authentication should be used for the new administrator account.

Returns:

• struct - organization info
  • int "id"
  • string "name"
  • int "active_users" - Number of active users in the organization.
  • int "systems" - Number of systems in the organization.
  • int "trusts" - Number of trusted organizations.
  • int "system_groups" - Number of system groups in the organization.
  • int "activation_keys" - Number of activation keys in the organization. (optional)
  • int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
  • int "configuration_channels" - Number of configuration channels in the organization. (optional)

Method: delete

Parameters:

• string sessionKey
• int orgId

Returns:

• int - 1 on success, exception thrown otherwise.

Method: getDetails

Parameters:

• string sessionKey
• int orgId

Returns:

• struct - organization info
  • int "id"
  • string "name"
  • int "active_users" - Number of active users in the organization.
  • int "systems" - Number of systems in the organization.
  • int "trusts" - Number of trusted organizations.
  • int "system_groups" - Number of system groups in the organization.
  • int "activation_keys" - Number of activation keys in the organization. (optional)
  • int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
  • int "configuration_channels" - Number of configuration channels in the organization. (optional)

Method: getDetails

Parameters:

• string sessionKey
• string name

Returns:

• struct - organization info
  • int "id"
  • string "name"
  • int "active_users" - Number of active users in the organization.
  • int "systems" - Number of systems in the organization.
  • int "trusts" - Number of trusted organizations.
  • int "system_groups" - Number of system groups in the organization.
  • int "activation_keys" - Number of activation keys in the organization. (optional)
  • int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
  • int "configuration_channels" - Number of configuration channels in the organization. (optional)

Method: listOrgs

Parameters:

• string sessionKey

Returns:

• struct - organization info
  • int "id"
  • string "name"
  • int "active_users" - Number of active users in the organization.
  • int "systems" - Number of systems in the organization.
  • int "trusts" - Number of trusted organizations.
  • int "system_groups" - Number of system groups in the organization.
  • int "activation_keys" - Number of activation keys in the organization. (optional)
  • int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
  • int "configuration_channels" - Number of configuration channels in the organization. (optional)

Method: listSoftwareEntitlements

Parameters:

• string sessionKey

Returns:

• array:
  • struct - entitlement usage
    • string "label"
    • string "name"
    • int "free"
    • int "used"
    • int "allocated"
    • int "unallocated"

Method: listSoftwareEntitlements

Deprecated as of version - being replaced by listSoftwareEntitlements(string sessionKey, string label, boolean includeUnentitled)

Parameters:

• string sessionKey
• string label - Software entitlement label.

Returns:

• array:
  • struct - entitlement usage
    • int "org_id"
    • string "org_name"
    • int "allocated"
    • int "unallocated"
    • int "used"
    • int "free"

Method: listSoftwareEntitlements

Parameters:

• string sessionKey
• string label - Software entitlement label.
• boolean includeUnentitled - If true, the result will include both organizations that have the entitlement as well as those that do not; otherwise, the result will only include organizations that have the entitlement.

Returns:

• array:
  • struct - entitlement usage
    • int "org_id"
    • string "org_name"
    • int "allocated"
    • int "unallocated"
    • int "used"
    • int "free"

Available since: 10.4

Method: listSoftwareEntitlementsForOrg

Parameters:

• string sessionKey
• int orgId

Returns:

• array:
  • struct - entitlement usage
    • string "label"
    • string "name"
    • int "allocated"
    • int "unallocated"
    • int "free"
    • int "used"

Method: listSystemEntitlements

Parameters:

• string sessionKey

Returns:

• array:
  • struct - entitlement usage
    • string "label"
    • string "name"
    • int "free"
    • int "used"
    • int "allocated"
    • int "unallocated"

Method: listSystemEntitlements

Deprecated as of version - being replaced by listSystemEntitlements(string sessionKey, string label, boolean includeUnentitled)

Parameters:

• string sessionKey
• string label

Returns:

• array:
  • struct - entitlement usage
    • int "org_id"
    • string "org_name"
    • int "allocated"
    • int "unallocated"
    • int "used"
    • int "free"

Method: listSystemEntitlements

Parameters:

• string sessionKey
• string label
• boolean includeUnentitled - If true, the result will include both organizations that have the entitlement as well as those that do not; otherwise, the result will only include organizations that have the entitlement.

Returns:

• array:
  • struct - entitlement usage
    • int "org_id"
    • string "org_name"
    • int "allocated"
    • int "unallocated"
    • int "used"
    • int "free"

Available since: 10.4

Method: listSystemEntitlementsForOrg

Parameters:

• string sessionKey
• int orgId

Returns:

• array:
  • struct - entitlement usage
    • string "label"
    • string "name"
    • int "free"
    • int "used"
    • int "allocated"
    • int "unallocated"

Method: listUsers

Parameters:

• string sessionKey
• int orgId

Returns:

• array:
  • struct - user
    • string "login"
    • string "login_uc"
    • string "name"
    • string "email"
    • boolean "is_org_admin"

Method: migrateSystems

Parameters:

• string sessionKey
• int toOrgId - ID of the organization where the system(s) will be migrated to.
• array:
  • int - systemId

Returns:

• array:
  • int - serverIdMigrated

Method: setSoftwareEntitlements

Parameters:

• string sessionKey
• int orgId
• string label - Software entitlement label.
• int allocation

Returns:

• int - 1 on success, exception thrown otherwise.

Method: setSystemEntitlements

Parameters:

• string sessionKey
• int orgId
• string label - System entitlement label. Valid values include:
  • enterprise_entitled
  • monitoring_entitled
  • provisioning_entitled
  • virtualization_host
  • virtualization_host_platform
• int allocation

Returns:

• int - 1 on success, exception thrown otherwise.

Method: updateName

Parameters:

• string sessionKey
• int orgId
• string name - Organization name. Must meet same criteria as in the web UI.

Returns:

• struct - organization info
  • int "id"
  • string "name"
  • int "active_users" - Number of active users in the organization.
  • int "systems" - Number of systems in the organization.
  • int "trusts" - Number of trusted organizations.
  • int "system_groups" - Number of system groups in the organization.
  • int "activation_keys" - Number of activation keys in the organization. (optional)
  • int "kickstart_profiles" - Number of kickstart profiles in the organization. (optional)
  • int "configuration_channels" - Number of configuration channels in the organization. (optional)