Loading...

REST API - POST Agent Properties

This operation updates the properties associated with an agent.

Request

Syntax

Send the request using either XML or JSON:

  • XML

    POST <webservice>/Agent HTTP/1.1
    Host: <host name>
    Accept: application/xml
    Authtoken: <authentication token>
    Content-type: application/xml

    <update_agent_template.xml>

  • JSON

    POST <webservice>/Agent HTTP/1.1
    Host: <host name>
    Accept: application/json
    Authtoken: <authentication token>
    Content-type: application/json

    <update_agent_template.json>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the XML or JSON file required for this request: update_agent_template.xml or update_agent_template.json. The following table displays the parameters for the request body.

Parameter

Description

Element

Parent Element

agentArchivePropertiesFlag

The option to enable archiving for the agent.

Valid values are True/False.

AgentProperties

agentProperties

agentVersion

 The Agent software version installed on the client computer or application server.

AgentProperties

agentProperties

appPriority

 

AgentProperties

agentProperties

appTypePathnameOrder

 

AgentProperties

agentProperties

appTypePathnameSeperator

This is the character that is used to specify the different directories in a path name. The default is a backslash (\).

AgentProperties

agentProperties

appTypepathnameCaseSensitive

Indicates if the path name is case sensitive.

Valid values are 0/1.

AgentProperties

agentProperties

archiveGroup

The name of the Archive Group.

AgentProperties

agentProperties

createIndexOnFail

The option to convert to a full backup on indexing failures.

Valid values are True/False.

AgentProperties

agentProperties

createIndexOnFull

The option to create an index on a full backup.

Valid values are True/False.

AgentProperties

agentProperties

enableOCSOnBackupAgent

The option to enable the Office Communications Server backup.

Valid values are True/False.

AgentProperties

agentProperties

storagePolicyName

The name of the storage policy.

indexStoragePolicy

AgentProperties

installDate

The installation date of the agent.

Valid values are UNIX-style timestamps (seconds since January 1, 1970).

AgentProperties

agentProperties

isArchiverDriverEnabled

The option to enable the recall driver.

Valid values are True/False.

AgentProperties

agentProperties

isExplorerBasedRecall

The option to enable Explorer-based recall.

Valid values are True/False.

AgentProperties

agentProperties

isMarkedDeleted

The option that marks the agent as deleted.

Valid values are True/False.

AgentProperties

agentProperties

isNDMPRestore

Valid values are True/False.

AgentProperties

agentProperties

isNeedMoreconfig

Valid values are True/False.

AgentProperties

agentProperties

maxSimultaneousStubRecoveries

The upper limit for the number of stubs to be recovered for this agent.

AgentProperties

agentProperties

objectServerInterval

An internal reference number.

Valid value is 5.

AgentProperties

agentProperties

patchStatus

 

AgentProperties

agentProperties

prepostUsername

The name of the user with permission to run the pre or post commands.

AgentProperties

agentProperties

qsnapMaxCacheSize

The maximum cache size for QSnap.

AgentProperties

agentProperties

qsnapMinCacheSize

The minimum cache for QSnap.

AgentProperties

agentProperties

timeBetweenRecalls

The time between recall jobs.

AgentProperties

agentProperties

timeToWaitAfterMax

The number of seconds that this agent must wait before additional stub recovery jobs can begin after the upper limit has been reached.

AgentProperties

agentProperties

useSnapShotWriter

Valid values are True/False.

AgentProperties

agentProperties

userDescription

A general description of the user.

AgentProperties

agentProperties

id1

 

billableDepartment

agentProperties

id2

 

billableDepartment

agentProperties

name

 

billableDepartment

agentProperties

activityType

The agent activities.

Valid values are:

  • 1, for backup
  • 2, for restore
  • 4, for auxiliary copy
  • 8, for disaster recovery backup
  • 16, archive pruning
  • 32, for media recycle
  • 64, for synthetic full
  • 28, all activity
  • 256, for schedule
  • 1024, for offline content indexing

activityControlOptions

idaActivityControl

TimeZoneName

The time zone to use when the Enable after a Delay option is used with an activity. Use this parameter when the enableAfterADelay parameter is set to "true."

Sample values:

  • (UTC) Coordinated Universal Time
  • (UTC-05:00) Eastern Time (US & Canada)

dateTime

activityControlOptions

timeValue

The date and time to use when the Enable after a Delay option is used with an activity. Use this parameter when the enableAfterADelay parameter is set to "true."

Sample values:

  • 2013-12-11 09:22:32
  • 2014-01-01 17:22:32

dateTime

activityControlOptions

enableActivityType

The option to enable or disable an activity for a client.

Valid values are True/False.

activityControlOptions

agentProperties

enableAfterADelay

The option to enable an activity for a client on a date and time defined in the Enable Backup dialog box.

Valid values are True/False.

activityControlOptions

agentProperties

appName

The name of the application.

Valid values are:

  • Active Directory
  • DB2
  • DB2 MultiNode
  • DB2 on UNIX
  • Documentum
  • Exchange Database
  • File System
  • Informix Database
  • MySQL
  • NAS
  • Notes Database
  • Oracle
  • Oracle RAC
  • PostgreSQL
  • SAP HANA
  • SAP for MAX DB
  • SAP for Oracle
  • Sharepoint Server
  • SQL Server
  • Sybase Database
  • Virtual Server

 

idaEntity

agentProperties

clientName

The name of the client.

idaEntity

agentProperties

userGroupName

The name of the user group associated with the agent.

associatedUserGroups

idaSecurity

associatedUserGroupsOperationType

The operation to perform on the user groups in the userGroupName parameter in the <associatedUserGroups> element. Valid values are:

  • ADD, to associate new user groups.
  • OVERWRITE, to overwrite the existing user groups with new user groups.
  • DELETE, to delete one or more user groups.

associatedUserGroups

idaSecurity

ownerCapabilities

The capabilities of the client computer owners associated with the agent.

associatedUserGroups

idaSecurity

turboNasProperties

 

agentProperties

App_SetAgentPropertiesRequest

appName

The name of the application.

Valid values are:

  • Active Directory
  • DB2
  • DB2 MultiNode
  • DB2 on UNIX
  • Documentum
  • Exchange Database
  • File System
  • Informix Database
  • MySQL
  • NAS
  • Notes Database
  • Oracle
  • Oracle RAC
  • PostgreSQL
  • SAP HANA
  • SAP for MAX DB
  • SAP for Oracle
  • Sharepoint Server
  • SQL Server
  • Sybase Database
  • Virtual Server

 

entity

association

clientName

The name of the client.

entity

association

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

  • 0, successful completion.
  • 2, a failure.
  • a specific error code.

response

Examples

Sample Request

POST <webservice>/Agent HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<App_SetAgentPropertiesRequest>
  <agentProperties>
    <idaActivityControl>
      <activityControlOptions>
        <activityType>BACKUP</activityType>
        <enableActivityType>false</enableActivityType>
        <enableAfterADelay>true</enableAfterADelay>
      </activityControlOptions>
    </idaActivityControl>
  </agentProperties>
  <association>
    <entity>
      <appName>File System</appName>
      <clientName>summer</clientName>
    </entity>
  </association>
</App_SetAgentPropertiesRequest>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_SetAgentPropertiesResponse>
  <response errorCode="0"/>
</App_SetAgentPropertiesResponse>

Last modified: 1/13/2020 8:46:23 PM