Skip to Content
Information

This site will undergo a brief period of maintenance on Friday, 18 December at 12:30 AM Central/12:00 PM IST. During a 30 minute window, site availability may be intermittent.

Remove Ethernet Adapter operation

The Remove Ethernet Adapter operation removes the specified Ethernet adapter from a virtual machine. If the <status> response element contains _success_, the <Task> response element contains the ID of the queued task, which you can use to obtain the task status.

Warning

Note

This operation must be performed only when the virtual machine is in the Powered Off state.

The following table describes the elements for this request.

Adapter request elements for the Remove Ethernet Adapter operation

Element

Definition

Required

<operation-type>

Defines the type of the operation: Configure_Vm

Yes

<operation-name>

Defines the name of the operation: Remove_Ethernet_Adapter

Yes

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Default format for HTTPS: https://<hostName>:<port>/sdk/vim

Default format for HTTP: http://<hostName>:<port>/sdk/vim

Warning

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

No

<transport>

Specifies the transport protocol for the message

If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration.

Valid values: https-rpc (default), http-rpc

Warning

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

.

No

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center

If no user name is specified, the request is executed with the user name that is specified in the configuration.

No

<password>

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

<parameters>

Contains the element required to execute the operation

Yes

<virtual-machine>

Contains the name of the virtual machine from which the ethernet adapter is to be removed

Yes

<device-change-list>

the set of Ethernet adapters being removed by the configuration operation
Value format:

<device-change-list>
   <device-change>
      <device>
        <ethernetadapter></ethernet-adapter>
      </device>
   </devicechange>
</device-change-list>

ethernet-adapter: the name of the ethernet adapter to be removed

Yes

The name of the ethernet adapter is mandatory.

The following code sample shows a sample adapter request for the Remove Ethernet Adapter operation.

Sample adapter request for the Remove Ethernet Adapter operation

<vmware-infrastructure-request>
    <operation-type>Configure_Vm</operation-type>
    <operation-name>Remove_Ethernet_Adapter</operation-name>
   <soap-url></soap-url>                    
   <transport></transport>
    <user-name></user-name>
    <password></password>
    <parameters>
        <virtual-machine>Linux16</virtual-machine>
            <spec>
                <device-change-list>
                    <device-change>
                        <device>
                            <ethernet-adapter>NetAdpt1</ethernet-adapter>
                        </device>
                    </device-change>
                </device-change-list>
            </spec>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Remove Ethernet Adapter operation.

Sample adapter response for the Remove Ethernet Adapter operation

<vmware-infrastructure-response>
    <metadata>
        <status>success</status>
    </metadata>
    <RemoveEthernetAdapterResponse>
        <Task>task-726</Task>
    </RemoveEthernetAdapterResponse>
</vmware-infrastructure-response>

The following table describes the response element.

Adapter response element for the Remove Ethernet Adapter operation

Element

Definition

<Task>

Specifies the task ID of the submitted task

Use the task ID to obtain the status of the specified task.

For information about using the task ID to check the task status, see Request and response for the Retrieve_Task_Status operation.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 21.3