Perform VMClient Onboard

Select

SaaS

Customer Managed

This operation onboards a virtual machine client based on the GUID of the client.

More Details

Path Parameters

• vmGuid string required

application/json

Request Body required

• CycleDay object[] required

  day int32 required

  time object[] required

  endTime string required

  startTime string required
• ForceReplace boolean required
• StoragePool string required
• role object required

  roleName string required
• serviceLevel string required
• user object required

  userName string required

Responses

• 200

---

OK

POST /vm/:vmguid/onboard    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

vmGuid — path required

Body required

• Default
• Example

---

{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Onboard' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Onboard' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Onboard' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Onboard' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Onboard' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Onboard' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Onboard' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "CycleDay": [
    {
      "day": 3,
      "time": [
        {
          "endTime": "12AM",
          "startTime": "12AM"
        }
      ]
    },
    {
      "day": 4,
      "time": [
        {
          "endTime": "3PM",
          "startTime": "8AM"
        },
        {
          "endTime": "9PM",
          "startTime": "6PM"
        }
      ]
    }
  ],
  "ForceReplace": true,
  "StoragePool": "SP_Admin",
  "role": {
    "roleName": "Client Admins"
  },
  "serviceLevel": "Economy",
  "user": {
    "userName": "tapicompany/tapicompany"
  }
}'