Create a Server Group
Select
Create Server group
- application/json
Request Body
- name string
- serverGroupType string
Possible values: [
MANUAL
,AUTOMATIC
,VIRTUAL_MACHINE
] - description string
automaticAssociation object
clientScope object
clientScopeType stringPossible values: [
COMMCELL
,COMPANY
,USER
,USERGROUP
]entityInfo object
id int32name stringserverGroupRule object
match stringPossible values: [
AND
,OR
,NOT
]ruleGroup object[]
List of rule groups
match stringPossible values: [
AND
,OR
,NOT
]rules object[]
List of rules
ruleName stringPossible 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 stringPrimary value for the rule
ruleSecValue stringSecondary value used for BETWEEN and NOT_BETWEEN matchCondition. For ruleName which have enum values (like OS_TYPE), this is used to store displayName.
matchCondition stringPossible 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 booleanConfirm that server group rule impacts server of a specific company smart client group only
virtualAssociation object
virtualInstance stringPossible values: [
NONE
,VMW
,MICROSOFT
,XEN_SERVER
,AMAZON
,AZURE
,REDHAT
,AZURE_V2
,SCVMM
,NUTANIX
,ORACLE_VM
,DOCKER
,OPENSTACK
,ORACLE_CLOUD
,FUSIONCOMPUTE
,VCLOUD
,GOOGLE_CLOUD
,AZURE_STACK
,ALIBABA_CLOUD
,ORACLE_CLOUD_INFRASTRUCTURE
,KUBERNETES
,REDHAT_OPENSHIFT
,MONGODB_ATLAS
,PROXMOX
,KUBERNETES_AKS
,AZURE_STACK_HCI
]virtualServers object[]
id int32name stringrules object
matchRule MatchRulePossible values: [
ALL
,ANY
]Enum which specifies the whether to match all rules or any of the rules
rules object[]
name stringname of the VM to be added as content
type stringPossible values: [
NONE
,SERVER
,RES_POOL
,VAPP
,DATACENTER
,FOLDER
,CLUSTER
,DATASTORE
,DATASTORE_CLUSTER
,VM
,VM_NAME
,VM_GUEST_OS
,VM_GUEST_HOST_NAME
,CLUSTER_SHARED_VOLUMES
,LOCAL_DISK
,CLUSTER_DISK
,UNPROTECTED_VMS
,ROOT
,FILE_SERVER
,SMB_SHARE
,TYPES_FOLDER
,VM_FOLDER
,SERVER_FOLDER
,TEMPLATE_FOLDER
,STORAGE_REPOSITORY_FOLDER
,VAPPFOLDER
,DATACENTER_FOLDER
,CLUSTER_FOLDER
,VM_POWER_STATE
,VM_NOTES
,VM_CUSTOM_ATTRIBUTE
,NETWORK
,USER
,VM_TEMPLATE
,TAG
,TAG_CATEGORY
,SUBCLIENT
,CLIENT_GROUP
,PROTECTION_DOMAIN
,CONSISTENCY_GROUP
,INSTANCE_SIZE
,ORGANIZATION
,IMAGES
,STORAGE_POLICY
,DATABASE
,TABLE
,PROJECT
,SELECTOR
,MANAGED_BY
,REPLICATION_MODE
,METADATATAG
,CATALOG
,VAPPTEMPLATE
,VOLUME
]value stringvalue for the few type of VM Content like powerstate
condition RuleOperationTypePossible values: [
CONTAINS
,DOES_NOT_CONTAIN
,DOES_NOT_EQUAL
,ENDS_WITH
,EQUALS
,STARTS_WITH
]Operation type for VM rules/filters
GUID stringGUID of the entity to be added as content
displayName stringThe display name of the entity to be added
clientAssociation object[]
associationRule object[]
name stringname of the VM to be added as content
GUID stringGUID of the VM to be added as content
type stringPossible values: [
NONE
,SERVER
,RES_POOL
,VAPP
,DATACENTER
,FOLDER
,CLUSTER
,DATASTORE
,DATASTORE_CLUSTER
,VM
,VM_NAME
,VM_GUEST_OS
,VM_GUEST_HOST_NAME
,CLUSTER_SHARED_VOLUMES
,LOCAL_DISK
,CLUSTER_DISK
,UNPROTECTED_VMS
,ROOT
,FILE_SERVER
,SMB_SHARE
,TYPES_FOLDER
,VM_FOLDER
,SERVER_FOLDER
,TEMPLATE_FOLDER
,STORAGE_REPOSITORY_FOLDER
,VAPPFOLDER
,DATACENTER_FOLDER
,CLUSTER_FOLDER
,VM_POWER_STATE
,VM_NOTES
,VM_CUSTOM_ATTRIBUTE
,NETWORK
,USER
,VM_TEMPLATE
,TAG
,TAG_CATEGORY
,SUBCLIENT
,CLIENT_GROUP
,PROTECTION_DOMAIN
,CONSISTENCY_GROUP
,INSTANCE_SIZE
,ORGANIZATION
,IMAGES
,STORAGE_POLICY
,DATABASE
,TABLE
,PROJECT
,SELECTOR
,MANAGED_BY
,REPLICATION_MODE
,METADATATAG
,CATALOG
,VAPPTEMPLATE
,VOLUME
]guestCredentialAssocId int32Credential association ID given to link entity with credential id.
guestCredentials object
userName stringpassword stringexistingCredential object
credentialId int32credentialName stringassociatedClient object
clientID int32manualAssociation object
associatedservers object[]
List of associated servers
id int32name stringglobalConfigInfo object
Only applicable to Global CommCells
name stringcommcells object[]
List of Service CommCells where the global configuration should be applied
id int32name stringguid stringscope stringThe entity level at which the config has to be applied.
scopeFilterQuery stringCommCellEntityCache filter query string using for filtering the scope
applyOnAllCommCells booleanDecides whether the global configuration should be applied to all the Service commcells, including the newly created ones
actionOnLocalEntity stringPossible values: [
CREATE_NEW
,TAKE_OVER
,FAIL_IF_EXIST
]Action that will be taken on the local entity that has the same name as the global entity that needs to be created
- 200
- 400
- 403
- 404
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
serverGroupInfo object
id int32GUID stringname string
{
"serverGroupInfo": {
"id": 0,
"GUID": "string",
"name": "string"
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Requested Details not found
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}