Infoblox::Grid::Discovery::SNMP3Credential - SNMPv3 credential.

NAME
DESCRIPTION
CONSTRUCTOR
SESSION METHODS
METHODS

authentication_password( )
authentication_protocol( )
comment( )
privacy_password( )
privacy_protocol( )
user( )

AUTHOR
COPYRIGHT

NAME

DESCRIPTION

The object provides information about SNMPv3 credential.

CONSTRUCTOR

 my $object = Infoblox::Grid::Discovery::SNMP3Credential->new(
    'authentication_password' => $string,                         # Required if authentication_protocol is MD5 or SHA
    'authentication_protocol' => 'MD5' | 'NONE' | 'SHA',          # Requred
    'comment'                 => $string,                         # Optional
    'privacy_password'        => $string,                         # Required if privacy_protocol is 'AES', 'DES' or '3DES'
    'privacy_protocol'        => 'AES' | 'DES' | '3DES' | 'NONE', # Required
    'user'                    => $string,                         # 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.

authentication_password( )

Use this method to set the authentication password if the authentication protocol is MD5 or SHA. This is a write-only attribute.

Parameter

The authentication 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->authentication_password('infoblox');

authentication_protocol( )

Use this method to set or retrieve the authentication protocol.

Parameter

Valid value is 'MD5', 'NONE' or 'SHA'.

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->authentication_protocol();
 # Modify attribute value
 $object->authentication_protocol('MD5');

comment( )

Use this method to set or retrieve the comment on SNMPv3 user.

Parameter

The 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('SNMPv3');

privacy_password( )

Use this method to set the privacy password if the privacy protocol is 'AES', 'DES' or '3DES'. This is a write-only attribute.

Parameter

The privacy 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->privacy_password('infoblox');

privacy_protocol( )

Use this method to set or retrieve the privacy protocol.

Parameter

Valid value is 'AES', 'DES', '3DES' or 'NONE'.

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->privacy_protocol();
 # Modify attribute value
 $object->privacy_protocol('3DES');

user( )

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

Parameter

Tthe SNMPv3 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/