Update Subclient Properties

Modify the subclient properties of a file server.

Path Parameters

• subclientId integer required

  Id of the subclient

application/json

Request Body

• subClientProperties object required

  Subclient properties

  fsSubClientProp object

  Subclient

  useGlobalFilters string

  Possible values: [ON, OFF, USE_CELL_LEVEL_POLICY]

  Disable/Enable global exceptions for subclient. Use cell level policy inherits the settings at commcell, company or client group leve

  backupSystemState boolean

  Flag to backup system state

  followMountPointsMode string

  Possible values: [FOLLOW_MOUNT_POINTS_ON, FOLLOW_MOUNT_POINTS_OFF]

  Indicates whether the data in the mount point is backed up.

  useLocalContent boolean

  Flag to override the plan content and use local content

  contentOperationType integer

  Default value: 1

  Operation Type 1 for Update

  content object[]

  Configure the contents, exclusions and exceptions. Here path , excludePath and includePath are mutually exclusive

  path string

  Backup content path

  excludePath string

  Exclude content from backup

  includePath string

  Add an exception to a path that should be protected

  commonProperties object

  impersonateUserCredentialinfo object

  Add credential info if required for user imperso

  credentialId integer

  Credential Id

  credentialName string

  Credentail Name

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  errorCode integer

  warningMessage string

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string"
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": ""
    }
  ]
}

POST /subclient/:subclientid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

subclientId — path required

Body

• Default
• Update subclient properties - add local content

---

{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "fsSubClientProp": {
      "useGlobalFilters": "ON",
      "backupSystemState": true,
      "followMountPointsMode": "FOLLOW_MOUNT_POINTS_ON"
    },
    "useLocalContent": true,
    "contentOperationType": 1,
    "content": [
      {
        "path": "string",
        "excludePath": "string",
        "includePath": "string"
      }
    ],
    "commonProperties": {
      "impersonateUserCredentialinfo": {
        "credentialId": 0,
        "credentialName": "string"
      }
    }
  }
}'