Get hypervisor filters
Select
Get hypervisor filters
Path Parameters
- hypervisorId string required
Query Parameters
- backupsetId string
if not specified the default backupset will be fetched
- 200
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
filters object[]
overwrite booleanDefault value:
false
True if content in vmgroup has to be overwritten, by default it will append the content
virtualMachines 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 stringruleGroups 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
diskFilters object[]
overwrite booleanDefault value:
false
True if content in vmgroup has to be overwritten, by default it will append the content
rules object[]
overwrite booleanDefault value:
false
True if disk filter in vmgroup has to be overwritten, by default it will append the content
filterType stringPossible values: [
NONE
,DISK_PATH
,DISK_PATTERN
,DISK_VIRTUAL_DEVICE_NODE
,DISK_DATASTORE
,DISK_LABEL
,DISK_TYPE
,DISK_ADDRESS
,CONTAINER_PATTERN
,DISK_TAG
]name stringThe string to be filtered
value stringThe value string to be filtered, in case of disk tag , value of tag to be filtered
condition RuleOperationTypePossible values: [
CONTAINS
,DOES_NOT_CONTAIN
,DOES_NOT_EQUAL
,ENDS_WITH
,EQUALS
,STARTS_WITH
]Operation type for VM rules/filters
vmName stringVM Name of the Virtual Machine whose disk has to be filtered . This is optional. if not given, all disks of name and type from all Vms added in content will be filtered
vmGuid stringVM Guid of the Virtual Machine whose disk has to be filtered . This is optional. if not given, all disks of name and type from all Vms added in content will be filtered
{
"filters": [
{
"overwrite": false,
"virtualMachines": [
{
"name": "string",
"GUID": "string",
"type": "NONE",
"guestCredentialAssocId": 0,
"guestCredentials": {
"userName": "string",
"password": "string"
},
"existingCredential": {
"credentialId": 0,
"credentialName": "string"
}
}
],
"ruleGroups": [
{
"matchRule": "ALL",
"rules": [
{
"name": "string",
"type": "NONE",
"value": "string",
"condition": "CONTAINS",
"GUID": "string",
"displayName": "string"
}
]
}
]
}
],
"diskFilters": [
{
"overwrite": false,
"rules": [
{
"overwrite": false,
"filterType": "NONE",
"name": "string",
"value": "string",
"condition": "CONTAINS",
"vmName": "string",
"vmGuid": "string"
}
]
}
]
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}