Jump to

• Request
• Response
• Examples

Update a Virtual NIC Set

put

/network/v1/vnicset/{name}

You can add or remove vNICs in a vNICset.

Required Role: To complete this task, you must have the Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

• application/oracle-compute-v3+json

Path Parameters

• name: string
  The three-part name (/Compute-identity_domain/user/object) of the virtual NIC set.

Header Parameters

• Cookie: string
  The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

Body ()

The request body contains details of the virtual NIC set that you want to update.

Root Schema : VirtualNicSet-put-request

Type: object

The request body contains details of the virtual NIC set that you want to update.

Show Source

• appliedAcls(optional): array appliedAcls
  List of ACLs applied to the VNICs in the set.
• description(optional): string
  Description of the object.
• name: string
  Name of the VNIC set.
• tags(optional): array tags
  Tags associated with the object.
• vnics(optional): array vnics
  List of VNICs associated with this VNIC set.

{
    "required":[
        "name"
    ],
    "description":"The request body contains details of the virtual NIC set that you want to update. ",
    "properties":{
        "appliedAcls":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of ACLs applied to the VNICs in the set."
        },
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "name":{
            "type":"string",
            "description":"Name of the VNIC set."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        },
        "vnics":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of VNICs associated with this VNIC set."
        }
    }
}

Nested Schema : appliedAcls

Type: array

List of ACLs applied to the VNICs in the set.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of ACLs applied to the VNICs in the set."
}

Nested Schema : tags

Type: array

Tags associated with the object.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Tags associated with the object."
}

Nested Schema : vnics

Type: array

List of VNICs associated with this VNIC set.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of VNICs associated with this VNIC set."
}

Back to Top

Response

Supported Media Types

• application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

• set-cookie: string
  The cookie value is returned if the session is extended

Body ()

Root Schema : VirtualNicSet-response

Type: object

Show Source

• appliedAcls(optional): array appliedAcls
  List of ACLs applied to the VNICs in the set.
• description(optional): string
  Description of the object.
• name(optional): string
  Name of the VNIC set.
• tags(optional): array tags
  Tags associated with the object.
• uri(optional): string
  Uniform Resource Identifier
• vnics(optional): array vnics
  List of VNICs associated with this VNIC set.

{
    "properties":{
        "appliedAcls":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of ACLs applied to the VNICs in the set."
        },
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "name":{
            "type":"string",
            "description":"Name of the VNIC set."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        },
        "vnics":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of VNICs associated with this VNIC set."
        }
    }
}

Nested Schema : appliedAcls

Type: array

List of ACLs applied to the VNICs in the set.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of ACLs applied to the VNICs in the set."
}

Nested Schema : tags

Type: array

Tags associated with the object.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Tags associated with the object."
}

Nested Schema : vnics

Type: array

List of VNICs associated with this VNIC set.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of VNICs associated with this VNIC set."
}

Back to Top

Examples

cURL Command

The following example shows how to update a virtual NIC, /Compute-acme/[e-mail]/vnicset1, by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -i -X PUT
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
     -d "@requestbody.json"
        https://api-z999.compute.us0.oraclecloud.com/network/v1/vnicset/Compute-acme/[e-mail]/vnicset1

• COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

• api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

• acme and [e-mail] are example values. Replace acme with the identity domain ID of your Compute Classic account, and [e-mail] with your user name.

Example of Request Body

The following shows an example of the request body content in the requestbody.json file to specify another virtual NIC in an existing virtual NIC set. In the following example, virtual NIC /Compute-acme/[e-mail]/inst3/a4138f96-31bc-4e28-8696-3eb0916f75f1/eth0 is added to the virtual NIC set /Compute-acme/[e-mail]/vnicset1.

{
  "name": "/Compute-acme/[e-mail]/vnicset1",
  "vnics": [
    "/Compute-acme/[e-mail]/inst2/4f0840bd-49dc-4d7f-bcc2-628c0cd5006b/eth1",
    "/Compute-acme/[e-mail]/inst1-vnic1-ipnet1",
    "/Compute-acme/[e-mail]/inst3/a4138f96-31bc-4e28-8696-3eb0916f75f1/eth0"
  ]
}

Example of Response Body

The following example shows the response body in JSON format when you update a virtual NIC.

{
  "name": "/Compute-acme/[e-mail]/vnicset1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/vnicset/Compute-acme/[e-mail]/vnicset1",
  "description": null,
  "tags": [],
  "vnics": [
    "/Compute-acme/[e-mail]/inst2/4f0840bd-49dc-4d7f-bcc2-628c0cd5006b/eth1",
    "/Compute-acme/[e-mail]/inst1-vnic1-ipnet1",
    "/Compute-acme/[e-mail]/inst3/a4138f96-31bc-4e28-8696-3eb0916f75f1/eth0"
  ],
  "appliedAcls": []
}

Back to Top