Update Host Config Profile

Update Host Config Profile

Update the specified host config profile.

Request
URI
PUT
https://{api_host}/hybridity/api/ztp/v1/host-config-profiles/{hcp_id}
COPY
Path Parameters
string
hcp_id
Required

The ID of the Host Config Profile

Request Body

The request payload for Update host config profile API.

InlineZtpV1HostConfigProfilesHcp_idRequestBody of type(s) application/json
Required 
{
    "id": "string",
    "version": 0,
    "name": "hcp-1",
    "advanceSystemSettings": {
        "attributes": [
            {
                "key": "string",
                "value": "string"
            }
        ]
    },
    "biosSetting": {
        "attributes": [
            {
                "key": "string",
                "value": "string"
            }
        ]
    },
    "cpuPowerManagementSpec": [
        {
            "type": "string",
            "value": "string"
        }
    ],
    "firmwares": [
        {
            "name": "string",
            "softwareId": "string",
            "version": "string",
            "location": "string",
            "checksum": "string"
        }
    ],
    "pciDevices": [
        {
            "filters": [
                {
                    "numaId": 0,
                    "vendorId": "string",
                    "deviceIds": [
                        "string"
                    ],
                    "indices": [
                        0
                    ],
                    "alias": "string"
                }
            ],
            "actions": [
                {
                    "type": "string",
                    "maxVfs": 0,
                    "passthroughEnabled": false,
                    "deviceType": "string",
                    "attributes": [
                        {
                            "key": "string",
                            "value": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "pciGroups": [
        {
            "name": "string",
            "filters": [
                {
                    "isVf": false,
                    "deviceIds": [
                        "string"
                    ],
                    "vendorId": "string",
                    "sriovEnabled": false,
                    "numaId": 0,
                    "indices": [
                        0
                    ],
                    "alias": "string"
                }
            ]
        }
    ],
    "reservation": {
        "reservedCoresPerNumaNode": 0,
        "reservedMemoryPerNumaNode": 0,
        "minCoresForCPUReservationPerNumaNode": 0
    }
}
string As uuid As uuid
id
Optional

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

integer
version
Optional

The version of this host config profile entity. This field must be specified during host config profile Update.

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

Name of the host config profile. This field cannot be updated during host config profile Update.

object
advanceSystemSettings
Optional

advanceSystemSettings

object
biosSetting
Optional

biosSetting

array of object
cpuPowerManagementSpec
Optional

cpuPowerManagementSpec

array of object
firmwares
Optional

firmwares

array of object
pciDevices
Optional

pciDevices

array of object
pciGroups
Optional

pciGroups

object
reservation
Optional

reservation

Authentication
This operation uses the following authentication methods.
Responses
200

The specified host config profile has been updated successfully.

Returns InlineZtpV1HostConfigProfilesHcp_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 InlineZtpV1HostConfigProfilesHcp_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 InlineZtpV1HostConfigProfilesHcp_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 host config profile was not found.

Operation doesn't return any data structure

422

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

Returns InlineZtpV1HostConfigProfilesHcp_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 InlineZtpV1HostConfigProfilesHcp_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
Host Config Profile Operations
POST
Create Host Config Profiles
DELETE
Delete Host Config Profile
GET
Get Host Config Profile
GET
Get Host Config Profiles
GET
Get Host Profile Filters By Section
GET
Get Host Profile Template
PUT
Update Host Config Profile
PUT
Update Host Config Profiles