Update Port Group operation

The Update Port Group operation updates the configuration of a host network to update a port group.

The following table describes the elements for this request:

Adapter request elements for the Update Port Group operation

Element

Definition

Required

<operation-type>

Specifies the type of the operation: Host

No

<operation-name>

Specifies the name of the operation: Update_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.

No

<transport>

Specifies the transport protocol for the message

If the <transport> element is not specified, 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 VirtualCenter in the keystore of the peer on which the adapter is enabled.

No

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware VirtualCenter application

If you do not specify a user name, the request is executed with the user name that you specify in the adapter configuration.

No

<password>

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

<parameters>

Contains the elements required to execute the operation

Yes

<host-system>

Specifies the domain name server (DNS) name of the host on the network in which the virtual port group is to be updated

Valid value: Any valid DNS name

Yes

<pg-name>

Specifies the name of port group to be updated on the host

Yes

<portgrp>

Contains the specification for the configurable properties of a port group

For more information, see the child elements of the <portgrp> element.

Yes

The following code sample shows a sample adapter request for the Update Port Group operation:

Sample adapter request for the Update Port Group operation

<vmware-infrastructure-request>
<operation-type>Host</operation-type>
     <operation-name>Update_Port_Group</operation-name>
     <parameters>
           <host-system>localhost.bmc.com</host-system>
           <pg-name>VM Networks</pg-name>
           <portgrp>
           <name>VM Network</name>
           <policy>
                 <security>
                       <allow-promiscuous></allow-promiscuous>
                       <mac-changes></mac-changes>
                       <forged-transmits></forged-transmits>
                 </security>
                 <nic-teaming>
                       <policy></policy>
                       <reverse-policy></reverse-policy>
                       <notify-switches></notify-switches>
                       <rolling-order></rolling-order>
                       <failure-criteria>
                             <check-speed></check-speed>
                             <speed></speed>
                             <check-duplex></check-duplex>
                             <full-duplex></full-duplex>
                             <check-error-percent></check-error-percent>
                             <percentage></percentage>
                             <check-beacon></check-beacon>
                       </failure-criteria>
                       <nic-order>
                             <active-nic-list>
                                   <active-nic></active-nic>
                                   <active-nic></active-nic>
                             </active-nic-list>
                             <standby-nic-list>
                                   <standby-nic></standby-nic>
                                   <standby-nic></standby-nic>
                             </standby-nic-list>
                       </nic-order>
                 </nic-teaming>
                 <offload-policy>
                       <csum-offload></csum-offload>
                       <tcp-segmentation></tcp-segmentation>
                       <zero-copy-xmit></zero-copy-xmit>
                 </offload-policy>
                 <shaping-policy>
                       <enabled>false</enabled>
                       <average-bandwidth>100</average-bandwidth>
                       <peak-bandwidth>100</peak-bandwidth>
                       <burst-size>100</burst-size>
                 </shaping-policy>
           </policy>
           <vlan-id>1</vlan-id>
           <vswitch-name>vSwitch0</vswitch-name>
     </portgrp>
     </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Update Port Group operation:

Sample adapter response for the Update Port Group operation

<vmware-infrastructure-response>
     <metadata>
       <status>success</status>
     </metadata>
     <UpdatePortGroupResponse></ UpdatePortGroupResponse >
   </vmware-infrastructure-response>

Sample adapter request for the Update Port Group operation when you specify an invalid value for the <vswitch-name> element

<vmware-infrastructure-request>
   <operation-type>Host</operation-type>
   <operation-name>Update_Port_Group</operation-name>
   <parameters>
     <host-system>localhost.bmc.com</host-system>
     <pg-name>VM Network1</pg-name>
     <portgrp>
       <name>VM Network</name>
       <policy>
         <security>
           <allow-promiscuous>true</allow-promiscuous>
           <mac-changes>true</mac-changes>
           <forged-transmits>true</forged-transmits>
         </security>
         <nic-teaming>
           <policy>failover_explicit</policy>
           <reverse-policy>true</reverse-policy>
           <notify-switches>true</notify-switches>
           <rolling-order>true</rolling-order>
           <failure-criteria>
             <check-speed>exact</check-speed>
             <speed>32</speed>
             <check-duplex>true</check-duplex>
             <full-duplex>true</full-duplex>
             <check-error-percent>true</check-error-percent>
             <percentage>50</percentage>
             <check-beacon>false</check-beacon>
           </failure-criteria>
           <nic-order>
             <active-nic-list>
               <active-nic>vmnic0</active-nic>
             </active-nic-list>
             <standby-nic-list>
               <standby-nic />
             </standby-nic-list>
           </nic-order>
         </nic-teaming>
         <offload-policy>
           <csum-offload>false</csum-offload>
           <tcp-segmentation>false</tcp-segmentation>
           <zero-copy-xmit>false</zero-copy-xmit>
         </offload-policy>
         <shaping-policy>
           <average-bandwidth>100</average-bandwidth>
           <peak-bandwidth>100</peak-bandwidth>
           <burst-size>100</burst-size>
         </shaping-policy>
       </policy>
       <vlan-id>0</vlan-id>
       <vswitch-name>vSwitch00</vswitch-name>
     </portgrp>
   </parameters>

Sample adapter response for the Update Port Group operation when you specify an invalid value for the <vswitch-name> element

<vmware-infrastructure-response>
 <metadata>
   <status>error</status>
 </metadata>
 <Fault>
   <faultcode>ServerFaultCode</faultcode>
   <faultstring>A specified parameter was not correct.
Vim.Host.PortGroup::Specification::vswitchId</faultstring>
   <detail>
     <InvalidArgument>
       <invalidProperty>Vim.Host.PortGroup::Specification::vswitchId</invalidProperty>
     </InvalidArgument>
   </detail>
 </Fault>
</vmware-infrastructure-response>
 </vmware-infrastructure-request>

 

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