Infoblox::Grid::InformationalBannerSetting - The informational banner setting.

NAME
DESCRIPTION
CONSTRUCTOR
MODULE METHODS

Infoblox::Grid->informational_banner_setting( )

METHODS

enable( )
color( )
message( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::Grid::InformationalBannerSetting - The informational banner setting.

DESCRIPTION

The informational banner setting object that controls the banner displayed on the login page of Grid Manager.

CONSTRUCTOR

 my $color = "BLACK" | "BLUE" | "BROWN" | "CYAN" | "GREEN" | "MAGENTA" | "ORANGE" | "PURPLE" | "RED" | "YELLOW";

 my $informational = Infoblox::Grid::InformationalBannerSetting->new(
     enable    => "true" | "false", #Mandatory
     color     => $color,           #Mandatory
     message   => $string,          #Optional / Default is empty
 );

MODULE METHODS

The following functions are available to apply to an informational banner setting object.

Infoblox::Grid->informational_banner_setting( )

Use this function to specify the informational banner settings for the Grid. See Infoblox::Grid->informational_banner_setting() for parameters and return values.

Example

 my $grid = $session->get(object => 'Infoblox::Grid');

 my $banner = Infoblox::Grid::InformationalBannerSetting->new(enable => 'true', color => 'BLUE', message => 'Informational message');
 $grid->informational_banner_setting($banner);
 my $response = $session->modify($grid);
 unless($response) {
      die("Modify grid failed: ",
            session->status_code() . ":" . session->status_detail());
 }
 print "Grid banner setting modified successfully\n";

METHODS

This section describes all the methods that you can use to set and retrieve the attribute values of an informational banner setting object.

enable( )

Use this method to set the enable flag.

Parameter

Specify "true" to enable the banner or "false" to disable 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 enable
 my $enable = $banner->enable();
 #Modify enable
 $banner->enable("true");

color( )

Use this method to set the color of the message that will be displayed on the login page of Grid Manager.

Parameter

A string containing the color. Banner colors can be one of the following: 'BLACK', 'BLUE', 'BROWN', 'CYAN', 'GREEN', 'MAGENTA', 'ORANGE', 'PURPLE', 'RED', 'YELLOW'.

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 color
 my $color = $banner->color();
 #Modify color
 $banner->color("RED");

message( )

Use this method to set the message that will be displayed on the login page of Grid Manager.

Parameter

A string containing the message.

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 message
 my $message = $banner->message();
 #Modify message
 $banner->message("Test message");

AUTHOR

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