Update CSG

Update CSG

Update the specified CSG.

Request
URI
PUT
https://{api_host}/hybridity/api/ztp/v1/csgs/{csg_id}
COPY
Path Parameters
string
csg_id
Required

The ID of the CSG.

Request Body

The request payload for Update CSG API.

InlineZtpV1CsgsCsg_idRequestBody of type(s) application/json
Required 
{
    "id": "string",
    "version": 0,
    "name": "cdc1-csg1",
    "type": "string",
    "enabled": false,
    "preDeployed": {
        "preDeployed": false
    },
    "parentDomainId": "string",
    "switches": [
        {
            "name": "string",
            "uplinks": [
                {
                    "pnic": "string",
                    "name": "string"
                }
            ]
        }
    ],
    "networks": [
        {
            "type": "string",
            "name": "string",
            "switch": "string",
            "segmentType": "string",
            "vlan": 0,
            "mac_learning_enabled": false,
            "uplinkTeamingPolicy": {
                "uplinkPortOrder": {
                    "active": [
                        "string"
                    ],
                    "standby": [
                        "string"
                    ],
                    "unused": [
                        "string"
                    ]
                }
            }
        }
    ],
    "settings": {
        "dns": {
            "suffix": "string",
            "servers": [
                "string"
            ]
        },
        "ntp": {
            "servers": [
                "string"
            ]
        },
        "csiTagging": {
            "enableCsiZoning": false,
            "clusterCsiZoneTagNamingScheme": "string",
            "hostCsiZoneTagNamingScheme": "string"
        },
        "disableDatastoreCustomization": false
    },
    "csiTags": {
        "csiZoneTag": "string"
    },
    "csiCategories": {
        "useExisting": false,
        "zone": "string"
    },
    "hcpId": "string"
}
string As uuid As uuid
id
Optional

The unique ID of the CSG Domain. This is optional when creating CSG and required when updating CSG(s) in the absence of CSG Domain ID as API Path Param. This field is required and cannot be updated during CSG Update.

integer
version
Optional

The version of this CSG Domain entity. This field must be specified during CSG Update.

string As ^[^\s]+$
name
Required

The name of the CSG. This field cannot be updated during CSG Update.

string
type
Required

The type of the CSG domain. This field cannot be updated during CSG Update.

boolean
enabled
Optional

Flag indicating whether this domain is enabled or disabled.

object
preDeployed
Required

preDeployed

string As uuid As uuid
parentDomainId
Optional

The unique ID of the parent domain for this CSG domain. This field cannot be updated during Domain Update.

array of object
switches
Optional

The list of switches under this domain.

array of object
networks
Optional

The list of networks for the switches under this domain.

object
settings
Optional

settings

object
csiTags
Optional

csiTags

object
csiCategories
Optional

csiCategories

string As uuid As uuid
hcpId
Optional

The unique ID of the Host Config Profile to be applied to this domain. This is an optional field when creating domains. During Domain update, if the previous value is present and current update doesn't have this value, it will be treated as intent to remove currently applied Host Config Profile from this domain.

Authentication
This operation uses the following authentication methods.
Responses
200

The specified CSG has been updated successfully.

Returns InlineZtpV1CsgsCsg_id200Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


301

API endpoint has permanently moved.

Returns InlineZtpV1CsgsCsg_id301Response of type(s) application/json 
{
    "redirectURL": "string"
}
string
redirectURL
Optional

redirectURL

Response Headers

string
Location

URI where the client will find the new endpoint.


400

Response may include details of why the request is bad.

Returns InlineZtpV1CsgsCsg_id400Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

404

The specified CSG was not found.

Operation doesn't return any data structure

422

The request payload couldn't be processed by the server.

Returns InlineZtpV1CsgsCsg_id422Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


500

An internal server error has occurred.

Returns InlineZtpV1CsgsCsg_id500Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


On This Page
Cell Site Group Operations
POST
Create CS Gs
DELETE
Delete CSG
POST
Fetch CSG By Names
GET
Get CSG
GET
Get CS Gs
GET
Get Status For CSG
POST
Resync CS Gs
PUT
Update CSG
PUT
Update CS Gs