com.vmware.host

Class DVSCreate

java.lang.Object

com.vmware.connection.ConnectedVimServiceBase

com.vmware.host.DVSCreate

@Sample(name="dvs-create",
        description="This sample demonstrates how to create/update Distributed Virtual Switch")
public class DVSCreate
extends ConnectedVimServiceBase

 This sample demonstrates how to create/update Distributed Virtual Switch
 Parameters:
 url               [required]: url of the web service.
 username          [required]: username for the authentication
 Password          [required]: password for the authentication
 option            [required]:
                       "createdvs" for creating a new DVS
                       "addportgroup" for adding a port group to DVS
 dcname            : Datacenter name
 dvsname           [required]: Distributed Virtual Switch name
 dvsdesc           [optional]: Description string of the switch
 dvsversion        : Distributed Virtual Switch either 4.0, 4.1.0, 5.0.0 or 5.1.0
 numports          : Number of ports in the portgroup.
 portgroupname     : Name of the port group.

 Sample usage:
 Create DVS : run.bat com.vmware.host.DVSCreate --url [URLString] --username [User]
              --password [Password] --option createdvs --dcname [dcname]
              --dvsname [dvsname] --dvsversion [dvsversion]
 Add PortGroup : run.bat com.vmware.host.DVSCreate --url [URLString] --username [User]
                 --password [Password] --option addportgroup --dvsname [dvsname]
                 --numports [numports] --portgroupname [portgroupname]
 

Nested Class Summary

Nested classes/interfaces inherited from class com.vmware.connection.ConnectedVimServiceBase

ConnectedVimServiceBase.ConnectionException

Field Summary

Fields inherited from class com.vmware.connection.ConnectedVimServiceBase

PROP_ME_NAME, SVC_INST_NAME

Constructor Summary

Constructors

Constructor and Description
DVSCreate()

Method Summary

Methods

Modifier and Type	Method and Description
void	run()
void	setDcName(java.lang.String dcName)
void	setDvsDesc(java.lang.String dvsDesc)
void	setDvsName(java.lang.String dvsName)
void	setDvsVersion(java.lang.String dvsVersion)
void	setNoOfPorts(java.lang.String noOfPorts)
void	setOption(java.lang.String option)
void	setPortGroupName(java.lang.String portGroupName)

Methods inherited from class com.vmware.connection.ConnectedVimServiceBase

basicConnectionFromConnection, connect, disconnect, getServiceInstanceReference, setConnection, setHostConnection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DVSCreate

public DVSCreate()

Method Detail

setOption

@Option(name="option",
        description="\"createdvs\" for creating a new DVS | \"addportgroup\" for adding a port group to DVS")
public void setOption(java.lang.String option)

setDcName

@Option(name="dcname",
        required=false,
        description="datacenter name")
public void setDcName(java.lang.String dcName)

setDvsName

@Option(name="dvsname",
        required=true,
        description="Distributed Virtual Switch name")
public void setDvsName(java.lang.String dvsName)

setDvsDesc

@Option(name="dvsdesc",
        required=false,
        description="Description string of the switch")
public void setDvsDesc(java.lang.String dvsDesc)

setDvsVersion

@Option(name="dvsversion",
        required=false,
        description="Distributed Virtual Switch either 4.0, 4.1.0, 5.0.0 or 5.1.0")
public void setDvsVersion(java.lang.String dvsVersion)

setNoOfPorts

@Option(name="numports",
        required=false,
        description="Number of ports in the portgroup.")
public void setNoOfPorts(java.lang.String noOfPorts)

setPortGroupName

@Option(name="portgroupname",
        required=false,
        description="name of port group")
public void setPortGroupName(java.lang.String portGroupName)

run

@Action
public void run()
         throws com.vmware.vim25.DuplicateNameFaultMsg,
                com.vmware.vim25.RuntimeFaultFaultMsg,
                com.vmware.vim25.InvalidPropertyFaultMsg,
                com.vmware.vim25.DvsFaultFaultMsg,
                com.vmware.vim25.InvalidCollectorVersionFaultMsg,
                com.vmware.vim25.InvalidNameFaultMsg,
                java.rmi.RemoteException,
                com.vmware.vim25.NotFoundFaultMsg,
                com.vmware.vim25.DvsNotAuthorizedFaultMsg

Throws:

com.vmware.vim25.DuplicateNameFaultMsg

com.vmware.vim25.RuntimeFaultFaultMsg

com.vmware.vim25.InvalidPropertyFaultMsg

com.vmware.vim25.DvsFaultFaultMsg

com.vmware.vim25.InvalidCollectorVersionFaultMsg

com.vmware.vim25.InvalidNameFaultMsg

java.rmi.RemoteException

com.vmware.vim25.NotFoundFaultMsg

com.vmware.vim25.DvsNotAuthorizedFaultMsg