NAME

NAME
DESCRIPTION
CONSTRUCTOR
SESSION METHODS
METHODS

id( )
comment( )
password( )
type( )
user( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::Grid::Discovery::CLICredential

DESCRIPTION

The object provides information about CLI credentials.

CONSTRUCTOR

 my $object = Infoblox::Grid::Discovery::CLICredential->new(
    'user'     => $string,                                             # optional
    'password' => $string,                                             # optional
    'comment'  => $string,                                             # optional
    'type'     => 'ENABLE_SSH' | 'ENABLE_TELNET' | 'SSH' | 'TELNET',   # required
 );

SESSION METHODS

The object does not support any session methods.

METHODS

This section describes all the methods that you can use to set or retrieve the attribute values of the object.

id( )

Use this method to retrieve the credential ID. This attribute is read-only.

Parameter

None.

Returns

The method returns the attribute value.

Example

 # Get attribute value
 my $value = $object->id();

comment( )

Use this method to set or retrieve the descriptive comment.

Parameter

Desired comment in 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 attribute value
 my $value = $object->comment();
 # Modify attribute value
 $object->comment('CLI credentials');

password( )

Use this method to set the CLI user password. This attribute is write-only.

Parameter

The CLI password in string format.

Returns

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

Example

 # Modify attribute value
 $object->password('infoblox');

type( )

Use this method to set or retrieve the credential type.

Parameter

The valid value is 'ENABLE_SSH', 'ENABLE_TELNET', 'SSH' or 'TELNET'.

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 attribute value
 my $value = $object->typ();
 # Modify attribute value
 $object->type('ENABLE_SSH');

user( )

Use this method to set or retrieve the CLI user name.

Parameter

The CLI user name in 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 attribute value
 my $value = $object->user();
 # Modify attribute value
 $object->user('admin');

AUTHOR

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