Remove Port Group operation

The Remove Port Group operation updates the configuration of a host network to remove a port group.

Note

Before removing a port group, you must remove all virtual NICs associated with the port group.

The following table describes the elements for this request.

Adapter request elements for the Remove Port Group operation

Element

Definition

Required

<operation-type>

Defines the type of the operation: Host

Yes

<operation-name>

Defines the name of the operation: Remove_Port_Group

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

Note

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

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

Note

If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.

<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.

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

Contains the elements required to execute the operation

Yes

<host-system>

DNS name of the host on the network from which the virtual switch is to be deleted
Valid values: dns name

Yes

<portgroup-list>

Contains the list of port groups to be removed on the host

Values takes the form:

<portgroup-list>
   <portgroup>
      <spec>
         <name>
         </name>
      <spec>
   <portgroup>
<portgroup-list>

name: Name of the port group

Valid value: Any string

Yes

The following figure shows a sample adapter request for the Remove Port Group operation.

Sample adapter request for the Remove Port Group operation

<vmware-infrastructure-request>
    <operation-type>Host</operation-type>
   <operation-name>Remove_Port_Group</operation-name>
   <soap-url></soap-url>
   <transport></transport>
    <username></username>
    <password></password>
    <parameters>
       <host-system>xyz.bmc.com</host-system>
        <config>
            <portgroup-list>
                <portgroup>
                    <spec>
                        <name>VM Network 2</name>
                    </spec>
                </portgroup>
            </portgroup-list>
        </config>
   </parameters>
</vmware-infrastructure-request>

The following figure shows the response for the sample Remove Port Group operation.

Sample adapter response for the Remove Port Group operation

<vmware-infrastructure-response>
    <metadata>
        <status>success</status>
    </metadata>
    <RemovePortGroupResponse>
        <returnval/>
    </RemovePortGroupResponse>
<vmware-infrastructure-response>

Remove Port Group operation

TrueSight Orchestration Content 21.3

On this page