Skip to main content

Update hypervisor filters​

Select

SaaS
Customer Managed

Update hypervisor filter details

Path Parameters
  • hypervisorId string required
Request Body
  • backupsetId int32

    if not specified the default backupset is modified

  • filters object
  • overwrite boolean

    Default value: true

    False if content in vmgroup has to be appended, by default it will overwrite the content

  • virtualMachines object[]
  • name string

    name of the VM to be added as content

  • GUID string

    GUID of the VM to be added as content

  • type string

    Possible 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, VM_BADGE]

  • guestCredentialAssocId int32

    Credential association ID given to link entity with credential id.

  • guestCredentials object
  • userName string
  • password string
  • existingCredential object
  • credentialId int32
  • credentialName string
  • ruleGroups object[]
  • matchRule MatchRule

    Possible values: [ALL, ANY]

    Enum which specifies the whether to match all rules or any of the rules

  • rules object[]
  • name string

    name of the VM to be added as content

  • type string

    Possible 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, VM_BADGE]

  • value string

    value for the few type of VM Content like powerstate

  • condition RuleOperationType

    Possible values: [CONTAINS, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, ENDS_WITH, EQUALS, STARTS_WITH]

    Operation type for VM rules/filters

  • GUID string

    GUID of the entity to be added as content

  • displayName string

    The display name of the entity to be added

  • diskFilters object
  • overwrite boolean

    Default value: false

    True if content in vmgroup has to be overwritten, by default it will append the content

  • rules object[]
  • overwrite boolean

    Default value: false

    True if disk filter in vmgroup has to be overwritten, by default it will append the content

  • filterType string

    Possible values: [NONE, DISK_PATH, DISK_PATTERN, DISK_VIRTUAL_DEVICE_NODE, DISK_DATASTORE, DISK_LABEL, DISK_TYPE, DISK_ADDRESS, CONTAINER_PATTERN, DISK_TAG]

  • name string

    The string to be filtered

  • value string

    The value string to be filtered, in case of disk tag , value of tag to be filtered

  • condition RuleOperationType

    Possible values: [CONTAINS, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, ENDS_WITH, EQUALS, STARTS_WITH]

    Operation type for VM rules/filters

  • vmName string

    VM 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 string

    VM 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

  • filterSubResource boolean

    Default value: false

    True if filter is to be applied on sub resource of the resource being filtered.

  • children object[]

    Nested disk filters

  • overwrite boolean

    Default value: false

    True if disk filter in vmgroup has to be overwritten, by default it will append the content

  • filterType string

    Possible values: [NONE, DISK_PATH, DISK_PATTERN, DISK_VIRTUAL_DEVICE_NODE, DISK_DATASTORE, DISK_LABEL, DISK_TYPE, DISK_ADDRESS, CONTAINER_PATTERN, DISK_TAG]

  • name string

    The string to be filtered

  • value string

    The value string to be filtered, in case of disk tag , value of tag to be filtered

  • condition RuleOperationType

    Possible values: [CONTAINS, DOES_NOT_CONTAIN, DOES_NOT_EQUAL, ENDS_WITH, EQUALS, STARTS_WITH]

    Operation type for VM rules/filters

  • vmName string

    VM 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 string

    VM 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

  • filterSubResource boolean

    Default value: false

    True if filter is to be applied on sub resource of the resource being filtered.

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/hypervisor/:hypervisorid/filter

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "backupsetId": 0,

  "filters": {

    "overwrite": true,

    "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",

        "filterSubResource": false,

        "children": [

          {

            "overwrite": false,

            "filterType": "NONE",

            "name": "string",

            "value": "string",

            "condition": "CONTAINS",

            "vmName": "string",

            "vmGuid": "string",

            "filterSubResource": false

          }

        ]

      }

    ]

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/v4/hypervisor/:hypervisorId/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "backupsetId": 0,
  "filters": {
    "overwrite": true,
    "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",
        "filterSubResource": false,
        "children": [
          {
            "overwrite": false,
            "filterType": "NONE",
            "name": "string",
            "value": "string",
            "condition": "CONTAINS",
            "vmName": "string",
            "vmGuid": "string",
            "filterSubResource": false
          }
        ]
      }
    ]
  }
}'