Skip to main content

Server Group Preview​

Select

SaaS
Customer Managed

Get a preview of servers affected with create server group operation

Request Body
  • clientScope object
  • clientScopeType string

    Possible values: [COMMCELL, COMPANY, USER, USERGROUP]

  • entityInfo object
  • id int32
  • name string
  • serverGroupRule object
  • match string

    Possible values: [AND, OR, NOT]

  • ruleGroup object[]

    List of rule groups

  • match string

    Possible values: [AND, OR, NOT]

  • rules object[]

    List of rules

  • ruleName string

    Possible values: [APP_TYPE, CLIENT_GROUP, CLIENT_GROUPLIST, USES_LIBRARY, STORAGE_POLICY, STORAGE_POLICYLIST, BACKUP_ACTIVITY_ENABLED_FOR_CLIENT, CASE_MANAGER_CLIENTS, CLIENT_PROP, CLIENT_ACTS_AS_PROXY, CLIENT_ASSOCIATED_WITH_PLAN, CLIENT_BACKUP_ACTIVITY_ENABLED, CLIENT_BY_SCHEDULE_INTERVAL, CLIENT_CIDR_RANGE, CLIENTS_RELEASE16PLUS_SP_LEVEL_CONSTRAINT, CLIENT_DESCRIPTION, CLIENT_DISPLAY_NAME, CLIENT_EXCLUDED_FROM_SLA, CLIENTGROUP_NAME, CLIENT_CIDR_RANGE_IPV6, CLIENT_ISDELETEDVM, CLIENT_HAS_CONNECTIVITY_ISSUES, CLIENT_NAME, CLIENT_NEEDS_UPDATES, CLIENT_OFFLINE, CLIENT_ONLINE, CLIENT_ONLINE_IN_LAST_30_DAYS, CLIENT_ONLINE_IN_LAST_N_DAYS, CLIENT_USES_STORAGEPOLICY, CLIENT_VERSION, COMPARE_CLIENT_CS_VERSION, CLIENT_ASSOCIATED_ADUSERGROUP, IS_COMPANY_CLIENT, CLIENT_ASSOC_SCHDPOLICY, CLIENT_ASSOCIATED_TO_TOPOLOGY_WITH_REGION, VSA_BACKEDUP_CLIENT, CLIENT_INDEX_MAINFOLIST, CLIENT_OS_INFOLIST, CLIENT_BY_PERMISSION, CLIENT_BY_ROLE, VSA_DISCOVER_CLIENT, CLIENTGROUP_TAGLIST, CLIENT_MEETS_SLA, CLIENTS_OF_RESELLER, USERGROUPLIST, CLIENT_IDA_ASSOCIATED_ADUSERGROUP, CLIENT_WITH_ASSOCIATED_REGION, CLIENTS_WITH_ATTACHED_STORAGE, CLIENT_WITH_BACKUP_SCHEDULE, CLIENT_WITH_ENABLED_BACKUP_SCHEDULE, CLIENT_ENCRYPTION_STATE, CLIENT_FETSIZE_LE_10GB, CLIENT_IMPROPER_DECONF_SUBCLIENT, CLIENT_INDEXINGV1, CLIENT_INDEXINGV2, CLIENTINFRASTRUCTUREROLE_LIST, CLIENT_LICENSELIST, CLIENT_LONG_RUNNING_JOBS_N_DAYS, CLIENT_WITH_NO_ARCHIVE_DATA, CLIENTS_WITH_ONEPASS_ENABLED, CLIENT_WITH_ASSOCIATED_SP, CLIENT_WITH_SYNTHETICFULL_BACKUP, CLIENT_TAGLIST, IS_COMMCELL_CLIENT, COMPANY_CLIENT_ASSOCIATIONS, COMPANY_INSTALLED_CLIENT_ASSOCIATIONS, ANALYZER_SERVERS_CLIENT, DAYS_SINCE_CLIENT_CREATED, DAYS_SINCE_LAST_CLIENT_BKP, EXTERNAL_GROUP_CLIENT_OWNER, HAC_CLUSTER_CLIENT, HOST_NAME, MACLIENTS_WITH_STORAGEPOOLS, CLIENT_OWNER_INACTIVE_ADUSER, SOLR_SERVERS_CLIENT, LOCAL_GROUP_CLIENT_OWNER, MEDIAAGENT_HAS_LUCENE_INDEX_ROLELIST, MEDIAAGENT_HAS_LUCENE_INDEX_ROLES, MAS_FOR_CLIENTS_IN_GROUP, MAS_FOR_CLIENTS_IN_GROUPLIST, CLIENT_GATEWAY_FOR_INSTALLATION, OS_TYPE, OS_VERSION, PACKAGE_INSTALLED, PRODUCT_VERSION, PSEUDO_CLIENTS, RESTORE_ACTIVITY_ENABLED_FOR_CLIENT, SNAP_BACKUP_CLIENTS, CLIENT_CONSECUTIVE_BACKUP_FAILURES, SUBCLIENT_NAME, TIMEZONE, TIMEZONELIST, TIMEZONE_REGIONLIST, USER_CLIENT_OWNER, USER_CLIENT_ASSOCIATIONS, USER_DESCRIPTION_CONTAINS, USERGROUP_CLIENT_ASSOCIATIONS, USERGROUP_DESCRIPTION_CONTAINS, VM_NO_CONTENT, VMHYPER_IN_CLIENTGROUP]

  • ruleValue string

    Primary value for the rule

  • ruleSecValue string

    Secondary value used for BETWEEN and NOT_BETWEEN matchCondition. For ruleName which have enum values (like OS_TYPE), this is used to store displayName.

  • matchCondition string

    Possible values: [IS_TRUE, IS_FALSE, CONTAINS, DOES_NOT_CONTAIN, IS, IS_NOT, STARTS_WITH, ENDS_WITH, EQUAL_TO, NOT_EQUAL_TO, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO, BETWEEN, NOT_IN, ANY_IN_SELECTION, NOT_IN_SELECTION, IN, NOT_BETWEEN]

  • confirmRuleChange boolean

    Confirm that server group rule impacts server of a specific company smart client group only

  • serverGroupId int32

    Id of Smart Client Group

Responses

Success

Schema
  • servers object[]
  • id int32
  • name string
POST /v4/servergroup/preview

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "clientScope": {

    "clientScopeType": "COMMCELL",

    "entityInfo": {

      "id": 0,

      "name": "string"

    }

  },

  "serverGroupRule": {

    "match": "AND",

    "ruleGroup": [

      {

        "match": "AND",

        "rules": [

          {

            "ruleName": "APP_TYPE",

            "ruleValue": "string",

            "ruleSecValue": "string",

            "matchCondition": "IS_TRUE"

          }

        ]

      }

    ]

  },

  "confirmRuleChange": true,

  "serverGroupId": 0

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientScope": {
    "clientScopeType": "COMMCELL",
    "entityInfo": {
      "id": 0,
      "name": "string"
    }
  },
  "serverGroupRule": {
    "match": "AND",
    "ruleGroup": [
      {
        "match": "AND",
        "rules": [
          {
            "ruleName": "APP_TYPE",
            "ruleValue": "string",
            "ruleSecValue": "string",
            "matchCondition": "IS_TRUE"
          }
        ]
      }
    ]
  },
  "confirmRuleChange": true,
  "serverGroupId": 0
}'