Infoblox::Grid::LOM::User - User information for the Lights Out Management functionality.

NAME
DESCRIPTION
CONSTRUCTOR
MODULE METHODS

Infoblox::Grid::Member->bgp_as( )

METHODS

disable( )
name( )
password( )
role( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::Grid::LOM::User - User information for the Lights Out Management functionality.

DESCRIPTION

An Infoblox::Grid::LOM::User object represents a user for the LOM functionality.

CONSTRUCTOR

 my $user   = Infoblox::Grid::LOM::User->new(
      name     => $string,             # Required
      password => $string,             # Required
      role     => "OPERATOR" | "USER", # Required
      disable  => "true" | "false",    # Required
 );

MODULE METHODS

The following functions can be applied to a LOM User object.

Infoblox::Grid::Member->bgp_as( )

Use this function to specify BGP Autonomous Systems for the grid member. See Infoblox::Grid::Member->bgp_as() for parameters and return values.

Example

 #Construct a LOM User
 my $lomuser = Infoblox::Grid::LOM::User->new(
      name     => 'username',
      password => 'password',
      role     => 'OPERATOR',
      disable  => 'false,
 );

 # Configure the LOM user on the grid object
 $grid->lom_users([$lomuser]);

METHODS

This section describes all the methods that can be used to configure and retrieve the attribute values of an Infoblox::Grid::LOM::User object.

disable( )

Use this method to set or retrieve the disable flag for the user.

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

Parameter

Specify "true" to set the disable flag or "false" to deactivate/unset it.

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 the disable
 my $disable = $lom_user->disable();
 #Modify the disable
 $lom_user->disable('false');

name( )

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

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

Parameter

The name of the user 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 the name
 my $name = $lom_user->name();
 #Modify the name
 $lom_user->name('username');

password( )

Use this method to set the password the user will use to authenticate. This is a write-only attribute.

Include the specified parameter to set the attribute value.

Parameter

The password for the user 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 the password
 $lom_user->password('password');

role( )

Use this method to set or retrieve the role of the user.

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

Parameter

Valid values are "OPERATOR" and "USER".

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 the role
 my $role = $lom_user->role();
 #Modify the role
 $lom_user->role('OPERATOR');

AUTHOR

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