POST /cdpPolicies/{ID}/includes

In this article

    Adds a VM or a VM container to the CDP policy having the specified ID.

    Request

    To add a VM or VM container to the CDP policy, send the POST HTTP request to the URL of the /cdpPolicies/{ID}/includes resource.

    HTTP Request

    POST https://<Enterprise-Manager>:9398/api/cdpPolicies/{ID}/includes

    Request Headers

    The request contains the following headers:

    Header

    Required

    Description

    X-RestSvcSessionId

    True

    The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

    Content-Type

    True

    Identifies the format of the request body message. Possible values:

    • application/xml
    • application/json

    Accept

    False

    Identifies the format of the response. Possible values:

    • application/xml — the client can send this value in the header to accept response in the XML format.
    • application/json — the client must send this value in the header to accept the request in the JSON format.

    If the request does not contain the header, the server will return the response in the XML format.

    Request Body

    In the request body, the client must send parameters of the VM or VM container you want to add to the CDP policy. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager REST API.

    The request body must contain the following elements:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    HierarchyObjRef

    HierarchyObjRefType

    Reference to the VM or VM container. You can construct the reference manually or use the lookup service to retrieve the reference.

    Yes

    1/1

    HierarchyObjName

    String

    Name of the VM or VM container.

    No

    1/1

    Order

    Int64

    Order in which the VM or VM container should be processed by the CDP Policy. The processing sequence starts with 0.

    Yes

    0/1

    GuestProcessingOptions

    GuestProcessing OptionsType

    Options for application-aware image processing. For details, see  Guest Processing Options.

    Yes

    0/1

    Guest Processing Options

    You can define the following guest processing options for the CDP policy:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    VssSnapshotOptions

    VssSnapshotOptionsType

    Application-aware processing options. For details, see Application-Aware Processing Options.

    Yes

    0/1

    WindowsCredentialsId

    String

    Guest OS credentials for starting the indexing runtime process in Microsoft Windows OS.

    Yes

    0/1

    LinuxCredentialsId

    String

    Guest OS credentials for starting the indexing runtime process in Linux OS.

    Yes

    0/1

    For example:

    XML Representation

    <?xml version="1.0" encoding="utf-8"?>
    <CreateObjectInJobSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <HierarchyObjRef>urn:VMware:Vm:b4cd87e5-c608-4790-9178-076d16d4166b.vm-16</HierarchyObjRef>
     <HierarchyObjName>virt03-srv01</HierarchyObjName>
     <Order>2</Order>
     <GuestProcessingOptions>
       <VssSnapshotOptions>
         <VssSnapshotMode>RequireSuccess</VssSnapshotMode>
         <IsCopyOnly>false</IsCopyOnly>
       </VssSnapshotOptions>
     </GuestProcessingOptions>
     <WindowsCredentialsId>00000000-0000-0000-0000-000000000000</WindowsCredentialsId>
     <LinuxCredentialsId>00000000-0000-0000-0000-000000000000</LinuxCredentialsId>
    </CreateObjectInJobSpec>

    JSON Representation

    {

     "HierarchyObjRef": "urn:VMware:Vm:b4cd87e5-c608-4790-9178-076d16d4166b.vm-16",

     "HierarchyObjName": "virt03-srv01",

     "Order": 2,

     "GuestProcessingOptions": {

       "VssSnapshotOptions": {

         "VssSnapshotMode": "RequireSuccess",

         "IsCopyOnly": false

       },

       "WindowsCredentialsId": "00000000-0000-0000-0000-000000000000",

       "LinuxCredentialsId": "00000000-0000-0000-0000-000000000000",

     }

    }

    Application-Aware Processing Options

    You can define the following application-aware processing options for the CDP policy:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    VssSnapshotMode

    String

    Mode of application-aware image processing. Possible values:

    • RequireSuccess
    • IgnoreFailures
    • Disabled

    Yes

    IsCopyOnly

    Boolean

    Defines whether copy-only backups must be created or transaction logs for Microsoft Exchange, Microsoft SQL and Oracle VMs must be processed. Possible values:

    • True
    • False

    Yes

    0/1

    For example:

    XML Representation

    <VssSnapshotOptions>
     <VssSnapshotMode>RequireSuccess</VssSnapshotMode>
     <IsCopyOnly>false</IsCopyOnly>
    </VssSnapshotOptions>

    JSON Representation

    "VssSnapshotOptions": {

      "VssSnapshotMode": "RequireSuccess",

      "IsCopyOnly": false

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 202 Accepted.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message. Possible values:

    • application/xml
    • application/json

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns an ID of the task that has been created to perform the requested action, and the task state. You can check the operation results by sending the GET HTTP request to the URL of the task resource.

    Additionally, Veeam Backup Enterprise Manager returns a link to the task deletion operation. You can send the DELETE HTTP request to the URL in the link to stop the task execution.

    Example

    The example below adds a VM having MoID vm-10266 to the CDP policy having ID f365fbd8-fbd2-43ad-9f7a-c87cd390a0d9.

    Request:

    POST https://localhost:9398/api/cdpPolicies/f365fbd8-fbd2-43ad-9f7a-c87cd390a0d9/includes

     

    Request Headers:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
    Content-Type         application/xml

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <CreateObjectInJobSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <HierarchyObjRef>urn:VMware:VM:00000000-0000-0000-0000-000000000000.vm-10266</HierarchyObjRef>
     <HierarchyObjName>exch02</HierarchyObjName>
     <Order>0</Order>
     <GuestProcessingOptions>
       <VssSnapshotOptions>
         <VssSnapshotMode>RequireSuccess</VssSnapshotMode>
         <IsCopyOnly>false</IsCopyOnly>
       </VssSnapshotOptions>
     </GuestProcessingOptions>
    </CreateObjectInJobSpec>

     

    Response:

    202 Accepted

     

    Response Body:

    <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
     <Links>
       <Link Rel="Delete" Type="Task" Href="https://localhost:9398/api/tasks/task-1" />
     </Links>
     <TaskId>task-1</TaskId>
     <State>Running</State>
     <Operation>UpdateCdpPolicy</Operation>
    </Task>

    To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:

    Request:

    GET https://localhost:9398/api/tasks/task-1

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 OK

     

    Response Body:

    <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="https://localhost:9398/api/tasks/task-1">
     <Links>
       <Link Rel="Delete" Type="Task" Href="https://localhost:9398/api/tasks/task-1" />
     </Links>
     <TaskId>task-1</TaskId>
     <State>Finished</State>
     <Operation>UpdateCdpPolicy</Operation>
     <Result Success="true">
       <Message>Ok</Message>
     </Result>
    </Task>