Start Backup operation

The Start Backup operation starts an unscheduled backup of all members of a dataset. A background job is spawned to back up the dataset.

The following table describes the elements for this request.

Adapter request elements for the Start Backup operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `start-backup`	Yes
`<arguments>`	Specifies a list of arguments required for the operation	Yes
`<targets>`	Contains the parent XML element for `<target>` element, which specifies dynamic targets	Conditional; required if the adapter configuration is empty in Grid Manager
`<target>`	Contains the child XML `<target>` element, which specifies the dynamic target Using dynamic targets, you can define connection information for a remote host in an adapter request. This capability enables you to configure an adapter in Grid Manager by specifying configuration information in an adapter request. This XML element can have `<host>`, `<user-name>`, `<password>`, `<protocol>`, and `<port>` as its child elements. Notes An adapter configuration specified using request-level dynamic targets takes precedence over Grid Manager level configuration information. If you specify a request-level dynamic target by using `<targets>`, the request ignores the `<targets>` element that is a child of `<arguments>`	Conditional; required if `<targets>` is present in the adapter request
`<host>`	Specifies the host name or IP address of the server on which NetApp DataFabric Manager is running	Conditional; required if `<targets>` is present in the adapter request
`<user-name>`	Specifies the user name required to log on to NetApp DataFabric Manager	Conditional; required if `<targets>` is present in the adapter request
`<password>`	Specifies the password that corresponds to the `<user-name>` The `<password>` element can contain an `<encryption-type>` attribute. The `encryption-type attribute` indicates whether the password specified is encrypted. Valid values for `encryption-type` attribute: Base64, Plain (default)	Conditional; required if `<targets>` is present in the adapter request
`<protocol>`	Specifies the communication protocol used by adapter Valid value: http (default), https	No
`<port>`	Specifies the port on which NetApp DataFabric Manager is enabled Default values: 8088 (http), 8488 (https)	No
`<target>`	Indicates the child XML element of the `<arguments>` element You can use this element to specify the connection information for a DFM server. For this, a comma-separated list of configuration names, which executes the request simultaneously on all DFM servers identified by the configuration names. Valid values: The values specified for `<target>` element must be the same as the values that have been specified for the `<name>` attribute of `<config>` element in the Grid Manager adapter configuration. You can provide "ALL" as the value. In this case, the request is executed on all the DFM servers defined in Grid Manager adapter configuration. You can specify multiple comma-separated names to allow for simultaneous execution of requests across multiple DFM servers. You can skip this element. In this case, the request is executed on the first defined Grid Manager adapter configuration. You can leave this element empty. In this case, the request is executed on the first defined Grid Manager adapter configuration. Note If you specify a request-level dynamic target using `<target>` element, the request ignores the element.	No
`<backup-description>`	Specifies the description for the backup, which is available in the spawned job You can specify any arbitrary string that is meaningful for you. The description cannot be more than 255 characters.	No
`<backup-destination>`	Specifies the destination of the backup This must be the name of one of the nodes in the data protection policy attached to the dataset. If you specify the name of the primary node, the management station takes only the local snapshot. If you do not specify it, the management station transfers the backup over intervening policy nodes until it reaches the specified destination node. If you do not provide the backup destination, the management station takes local snapshots on the primary node and takes backups on all the connections in the policy	No
`<dataset-name-or-id>`	Specifies the name or ID of the dataset to backup	Yes
`<retention-type>`	Specifies the retention type to which the backup version must be archived This input is required for the non-application datasets and for the application datasets with `is-application-responsible-for-primary-backup` element set to FALSE. If you specify this input, the request assigns the retention-type to the backups created by the spawned job. If you omit this input (and it is not required), the retention type of the primary backup gets assigned to the replicated backups. Valid values: hourly, daily, weekly, monthly, unlimited	Yes

A sample adapter request for this operation is given in the following figure.

Sample adapter request for Start Backup operation

<netapp-storage-request>
    <operation-name>start-backup</operation-name>
    <arguments>
      <targets>
        <target>
          <host>172.11.11.111</host>
          <user-name>username</user-name>
          <password encryption-type = "Base64">cGFzc3dvcmQ=</password>
          <protocol>http</protocol>
          <port>8088</port>
        </target>
      </targets>
      <target />
      <dataset-name-or-id>nas dataset</dataset-name-or-id>
      <retention-type>monthly</retention-type>
      <backup-description>test description</backup-description>
      <backup-destination>Primary data</backup-destination>
    </arguments>
  </netapp-storage-request>

A sample adapter response for this operation is given in the following figure.

Sample adapter response for Start Backup operation

<netapp-storage-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>server137</target>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <job-id>3988</job-id>
      </output>
    </response>
  </responses>
</netapp-storage-response>

Start Backup operation

Comments