Skip to main content

Get Policy Details​

Select

SaaS
Customer Managed

VM Life cycle management policy details

Path Parameters
  • policyId integer required

    Target ID

Responses

OK

Schema
  • entity object
  • id int32

    Recovery Target Id

  • name string

    Recovery Target name

  • policyType string

    Recovery target policy type name

  • applicationType string

    Possible values: [REPLICATION, REGULAR, AUTO_SCALE_MANAGEMENT]

    Recovery target application type

  • destinationHypervisor object
  • id int32
  • name string
  • accessNode object
  • id int32
  • name string
  • type string
  • vmDisplayName object

    Prefix or Suffix appended to create display name for destination instance

  • prefix string

    A prefix string that will be appended to the source VM to create a display name for each destination VM

  • suffix string

    A suffix string that will be appended to the source VM to create a display name for each destination VM

  • vmStoragePolicyName string

    Name of Storage policy linked with the vm

  • securityOptions object
  • users object[]

    Users that have access to the recovery target

  • id int32
  • name string
  • fullName string
  • userGroups object[]

    User groups that have access to the recovery target

  • id int32
  • name string
  • securityGroups object[]

    List of security groups that provide controlled access of the DR VM

  • id string

    Security group id

  • name string

    security group name

  • testSecurityGroups object[]

    List of security groups that provide controlled access of the VM in cloud for test failover

  • id string

    Security group id

  • name string

    security group name

  • destinationOptions object
  • destinationHost string

    Destination host for the VM to deploy

  • dataStore string

    Datastore for the destination VM to store the disks and its config files. In-case of Microsoft Hyper-V, datastore refers to the destination folder for restore when default folder is not set.

  • dataStoreClusterName string

    Datastore cluster for the destination VM to store disks and config files in the datastore associated with the datastore cluster.

  • resourcePoolPath string

    Resource pool for the destination VM

  • vmFolder string

    Folder path where the destination VM will be located

  • iamRole object
  • id int32
  • name string
  • networkOptions object
  • networkCard object
  • networkDisplayName string

    Selected network display name

  • network string

    Name of network switch

  • subnetId string

    Subnet id of the subnet

  • networkId string

    VPC id for the amazon network

  • destinationNetworks string[]

    Destination network name

  • networkNames string[]

    Name of network to which the nic is connected

  • cloudNetwork object
  • label string

    Cloud network label

  • networkName string

    Cloud network name

  • subnetNames object
  • name string
  • value string
  • provisioningOptions object
  • maximumCPUCores int32

    Maximum cores for the VM

  • numberOfVMs int32

    Number of VMs that each user can create using this recovery target

  • minimumMemory string

    Minimum memory size in GBs

  • maximumMemory string

    Maximum memory of the VM in GBs

  • minDiskSpace int32

    Minimum disk space in GBs

  • maxDiskSpace int32

    Maximum disk space in GBs

  • maxDisks int32

    Maximum number of disks

  • namingPattern string

    Specific naming pattern to follow

  • maxVMQuota int32

    Maximum number of virtual machines

  • createdVMCount int32

    Number of virtual machines created

  • maxMemoryQuotaGB int32

    Maximum memory allowed to use in GBs

  • usedMemoryInGB int32

    Memory used in GBs

  • maxCPUQuota int32

    Maximum number of cores allowed to use

  • usedCPUCores int32

    Number of CPU cores used

  • daysRetainUntil int32

    Expiration time in days

  • minNICs int32

    Minimum number of NICs

  • isoPaths string[]

    List of available ISO paths

  • maxNICs int32

    Maximum number of NICs

  • enableBackup boolean

    Enable backup functionality for virtual machine

  • allowPublicIP boolean

    Indicates whether public IP configuration is permitted for the instance

  • instanceDetails object
  • iopsLimit int32

    Maximum IOPS limit of storage device

  • vmSize object[]
  • id int32
  • name string
  • templates object[]
  • vmName string

    VM name of template

  • vmGUID string

    VM guid of template

  • operatingSystem string

    Possible values: [WINDOWS, UNIX]

    OS types

  • operatingSystemDisplayName string

    Operating System version

  • hardDisks object

    List of disks attached to template machine

  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • diskId string

    Disk unique identifier

  • networkInfo object[]

    List of networks and associated subnet

  • name string

    Name of network

  • subnet string[]

    List of subnets associated to network

  • cloudDestinationOptions object
  • region object
  • id string

    GUID of the destination region.

  • name string

    Region name of destination. In-case of VMWare, region name refers to the destination host cluster name.

  • keyPair string

    Name of the key pair that is used to login to the VM

  • restoreAsManagedVM boolean

    If true, restore creates the destination VM as a managed VM in Azure

  • machineType object
  • id int32
  • name string
  • soleTenancyNodes object[]
  • name string
  • value string
  • tags object[]
  • name string
  • value string
  • availabilityZone string

    Availability zone name for the destination instance

  • vmInstanceType string

    Instance type that provides the available cpu cores and memory to the machine

  • encryptionKey object
  • id int32
  • name string
  • volumeType string

    Volume type of destination VM

  • testDiskType string

    Disk / Volume type for test failover VM

  • instanceTypes string[]
  • publicIP boolean

    If true, public IP address are configured for destination VMs

  • isoInfo object[]

    Info for the Windows/Unix ISO files

  • isoPath string

    Path for the Windows/Unix ISO files

  • osType string

    Possible values: [UNIX, WINDOWS]

    OS Type name

  • zone object
  • primaryZoneName string

    Name of Primary Zone for the VM to deploy

  • secondaryZoneName string

    Name of Secondary Zone for the VM to deploy

  • associatedClientGroup object
  • id int32
  • name string
  • liveMountOptions object
  • mediaAgent object
  • id int32
  • name string
  • isLiveMountEnabled boolean

    Indiciates whether the Live mount is allowed from this recovery target

  • migrateVMs boolean

    Whether migrate VMs options is turned on for test failover

  • expirationTime object
  • minutesRetainUntil string

    Expiration Time if in minutes

  • daysRetainUntil string

    Expiration Time if in days

  • publicIP boolean

    Default value: false

    Indicates if public IP has to be created.

  • virtualLabOptions object

    Virtual lab options configured in the recovery target

  • externalNetwork string

    To use virtual lab VM to connect to the existing network

  • gatewayTemplate string

    Gateway template provision VMs to communicate to VMs outside the virtual lab

  • gatewayNetwork string

    Primary network associated on the Provisioning Gateway VM that has production network access

  • configureIsolatedNetwork boolean

    To use isolated network for the virtual lab VM

  • ipSettings object[]
  • networkName string
  • ipAddressRange string
  • subnetMask string
  • defaultGatewayIP string
GET /v4/vmprovisioning/policy/:policyid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
policyId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/VMProvisioning/Policy/:policyId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'