Infoblox::IPAM::DiscoveryTask::VServer - VMWare discovery server object.

NAME
DESCRIPTION
CONSTRUCTOR
MODULE METHODS

Infoblox::IPAM::DiscoveryTask->vservers( )

METHODS

disable( )
encryption( )
fqdn_or_ip( )
password( )
port( )
username( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::IPAM::DiscoveryTask::VServer - VMWare discovery server object.

DESCRIPTION

This object contains information about the vSphere servers on which the VM discovery is performed.

CONSTRUCTOR

 my $vserver = Infoblox::IPAM::DiscoveryTask::VServer->new(
         fqdn_or_ip   => $string,           #Required.
         password     => $string,           #Required.
         username     => $string,           #Required.
         disable      => "true" | "false",  #Optional. Default is "false".
         encryption   => "true" | "false",  #Optional. Default is "true".
         port         => $num,              #Optional. Default is 443.
 );

MODULE METHODS

You can apply the following functions to a VMware vSphere server.

Infoblox::IPAM::DiscoveryTask->vservers( )

Use this function to specify the vSphere server on which the VM discovery is performed. See Infoblox::IPAM::DiscoveryTask->vservers( ) for parameters and returned values.

Example

 my $vserver1 = Infoblox::IPAM::DiscoveryTask::VServer->new(
        fqdn_or_ip => "vcenter.com",
        username => "test1",
        password => "test1",
    );
 my $vserver2 = Infoblox::IPAM::DiscoveryTask::VServer->new(
        fqdn_or_ip => "10.2.3.4",
        username => "test2",
        password => "test2",
    );
  #Modifying vserver
  $discovery_task->vservers([$vserver1, $vserver2]);

METHODS

This section describes all the methods that can be used to retrieve the attribute values of a vSphere server.

disable( )

Use this method to set or retrieve the disable flag of a vSphere server.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

Specify "true" to disable the vSphere server or "false" to enable the server. The default value is "false".

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get disable flag
 my $disable = $vserver->disable();
 #Modify disable
 $vserver->disable("true");

encryption( )

Use this method to set or retrieve the encryption flag of a vSphere server.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

Specify "true" to enable encryption or specify "false" to disable encryption on the vSphere server. The default value is "true".

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get encryption
 my $encryption = $vserver->encryption();
 #Modify encryption
 $vserver->encryption("false");

fqdn_or_ip( )

Use this method to retrieve the FQDN (Fully Qualified Domain Name) or IP address of the vShpere server.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The string that contains the FQDN or the IP address of the vSphere server.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get fqdn_or_ip
 my $fqdn_or_ip = $vserver->fqdn_or_ip();
 #Modify fqdn_or_ip
 $vserver->fqdn_or_ip("vdiscovery.example.com");

password( )

Use this method to set the user password on the vSphere server. This is a write-only attribute.

Parameter

String containing password.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

Example

 #Modify password
 $vserver->password("infobloxx");

port( )

Use this method to retrieve the connection port that the vSphere server uses.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

Valid values are between 1 and 65535. The default value is 443.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get port
 my $port = $vserver->port();
 #Modify port
 $vserver->port(444);

username( )

Use this method to set or retrieve the user name on the VSphere server.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The username in the string format.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example

 #Get username
 my $username = $vserver->username();
 #Modify username
 $vserver->username("someuser");

AUTHOR

Infoblox Inc. http://www.infoblox.com/