Skip to main content

Create NAS Client​

You can back up and recover network-attached storage (NAS) file server data with Common Internet File System (CIFS) shares or Network File System (NFS) exports

Request Body
  • createPseudoClientRequest object required
  • entity object
  • clientName string

    Client Name

  • hostName string

    Hostname of the client

  • clientInfo object
  • clientType integer required

    Default value: 2

    Type is 2 for NAS

  • nasClientProperties object required
  • listenPort integer

    NAS Port

  • ndmpServerDetails object required
  • ndmpServerClientName string required
  • ndmpServerHostName string
  • ndmpCredentials object
  • userName string
  • password string

    Base64 encoded password

  • plan object

    Associate to plan

  • planId integer
  • planName string
  • backupConfigList object[]

    Backup Configuration

  • idaInfo object
  • idaEntity object
  • applicationId integer

    Default value: 13

    13 for type NDMP

  • subClient object
  • subClientEntity object
  • applicationId integer

    Default value: 13

    13 for NDMP

  • commonProperties object
  • numberOfBackupStreams integer

    Total number of backup streams

  • content object[]

    Backup Content paths

  • path string

    Individual Path to

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • errorCode integer
  • entity object
  • clientId integer
  • clientName string
  • _type_ integer
POST /client/nas

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "createPseudoClientRequest": {

    "entity": {

      "clientName": "string",

      "hostName": "string"

    },

    "clientInfo": {

      "clientType": 2,

      "nasClientProperties": {

        "listenPort": 0,

        "ndmpServerDetails": {

          "ndmpServerClientName": "string",

          "ndmpServerHostName": "string",

          "ndmpCredentials": {

            "userName": "string",

            "password": "string"

          }

        }

      },

      "plan": {

        "planId": 0,

        "planName": "string"

      }

    }

  },

  "backupConfigList": [

    {

      "idaInfo": {

        "idaEntity": {

          "applicationId": 13

        }

      },

      "subClient": {

        "subClientEntity": {

          "applicationId": 13

        },

        "commonProperties": {

          "numberOfBackupStreams": 0

        },

        "content": [

          {

            "path": "string"

          }

        ]

      }

    }

  ]

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/NAS' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "entity": {
      "clientName": "string",
      "hostName": "string"
    },
    "clientInfo": {
      "clientType": 2,
      "nasClientProperties": {
        "listenPort": 0,
        "ndmpServerDetails": {
          "ndmpServerClientName": "string",
          "ndmpServerHostName": "string",
          "ndmpCredentials": {
            "userName": "string",
            "password": "string"
          }
        }
      },
      "plan": {
        "planId": 0,
        "planName": "string"
      }
    }
  },
  "backupConfigList": [
    {
      "idaInfo": {
        "idaEntity": {
          "applicationId": 13
        }
      },
      "subClient": {
        "subClientEntity": {
          "applicationId": 13
        },
        "commonProperties": {
          "numberOfBackupStreams": 0
        },
        "content": [
          {
            "path": "string"
          }
        ]
      }
    }
  ]
}'