Change Security Groups

Change Security Groups

Change security groups for a vSphere machine network interfaces. Securing group that is part of the same deployment can be added or removed for a machine network interface.

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/machines/{id}/operations/change-security-groups
COPY
Path Parameters
string
id
Required

The id of the vSphere machine.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Request Body

Change security groups details

ChangeSecurityGroupSpecification of type(s) application/json
Required

Show optional properties

{
    "id": "9.0E49",
    "_links": {}
}
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "networkInterfaceSpecifications": [
        {
            "name": "string",
            "description": "string",
            "deviceIndex": 1,
            "networkId": "54097407-4532-460c-94a8-8f9e18f4c925",
            "fabricNetworkId": "54097407-4532-460c-94a8-8f9e18f4c925",
            "addresses": [
                "10.1.2.190"
            ],
            "macAddress": "[\"00:50:56:99:d8:34\"]",
            "securityGroupIds": [
                "string"
            ],
            "customProperties": {
                "awaitIp": "true"
            }
        }
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

array of object
networkInterfaceSpecifications
Optional

A set of network interface controller specifications for this machine. If not specified, then no reconfiguration will be performed.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns RequestTracker of type(s) application/json 
"RequestTracker Object"
integer As int32 As int32
progress
Required

Progress of the request as percentage.

string
message
Optional

Status message of the request.

string
status
Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,
array of string
resources
Optional

Collection of resources.

string
name
Optional

Name of the operation.

string
id
Required

ID of this request.

string
selfLink
Required

Self link of this request.

string
deploymentId
Optional

ID of the deployment, this request is connected to.


400

Invalid Request - bad data

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


404

Not found

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"_links:"object","id:"string"}' https://{api_host}/iaas/api/machines/{id}/operations/change-security-groups
On This Page
Security Group Operations
POST
Change Security Groups