Infoblox::Grid::RIR - Regional Internet Registry object.

• NAME
• DESCRIPTION
• CONSTRUCTOR
• SESSION METHODS
• Infoblox::Session->get( )
• Infoblox::Session->modify( )
• Infoblox::Session->search( )
• METHODS
• communication_mode( )
• name( )
• email( )
• url( )
• override_email( )
• override_url( )
• AUTHOR
• SEE ALSO
• COPYRIGHT

NAME

Infoblox::Grid::RIR - Regional Internet Registry (RIR) object.

DESCRIPTION

Regional Internet Registry (RIR) object.

CONSTRUCTOR

 my $rir = Infoblox::Grid::RIR->new(
    communication_mode   => 'API' | 'EMAIL' | 'NONE', # Required
    name                 => 'RIPE',                   # Optional, Default is 'RIPE'
    email                => $string,                  # Optional
    override_email       => 'true' | 'false',         # Optional, Default is 'false'
    url                  => $string,                  # Optional
    override_url         => 'true' | 'false',         # Optional, Default is 'false'
 );

SESSION METHODS

This section describes all the methods in an Infoblox::Session module that you can apply to a RIR object.

Support for RIR/SWIP must be enabled at the Grid level. See Infoblox::Grid->enable_rir_swip() method.

Infoblox::Session->get( )

Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.

Key References

 Apply the following attributes to get a specific RIR object:

  name    - Optional. The RIR name.

Example

 my @retrieved_objs = $session->get(
    object => 'Infoblox::Grid::RIR',
    name   => 'RIPE',
 );

Infoblox::Session->modify( )

Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.

Example

 # Use this method to modify email of a RIR object.
 $rir->email('support@infoblox.com');
 # Submit modification
 my $response = $session->modify( $rir );

Infoblox::Session->search( )

Use this method to search for RIR objects in the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.

Key References

 Apply the following attributes to search a specific RIR object:

  name         - Optional. The RIR name.

Example

 my @retrieved_objs = $session->search(
    object => 'Infoblox::Grid::RIR',
    name   => 'RIPE',
 );

METHODS

This section describes all the methods that you can use to configure and retrieve the attribute values of a RIR object.

communication_mode( )

Use this method to set or retrieve a communication mode for RIR.

Parameter

Valid values are 'API', 'EMAIL' and 'NONE'. The default value is 'API'.

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 = $rir->communication_mode();
 #Modify attribute value
 $rir->communication_mode('EMAIL');

name( )

Use this method to set or retrieve a name of RIR.

Parameter

Valid value is 'RIPE'. The default value is 'RIPE'.

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 = $rir->name();
 #Modify attribute value
 $rir->name('RIPE');

email( )

Use this method to set or retrieve an email address for RIR.

Parameter

Email address 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 = $rir->email();
 #Modify attribute value
 $rir->email('support@infoblox.com');

url( )

Use this method to set or retrieve the Web API URL for RIR.

Parameter

Web API URL 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 = $rir->url();
 #Modify attribute value
 $rir->url('http://www.infoblox.com');

override_email( )

Use this method to set or retrieve the override_email flag of RIR.

Parameter

Specify "true" to override the predefined email address or "false" to use the predefined email address. 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 attribute value
 my $value = $rir->override_email();
 #Modify attribute value
 $rir->override_email('true');

override_url( )

Use this method to set or retrieve the override_url flag of RIR.

Parameter

Specify "true" to override the predefined Web API URL or "false" to use the predefined Web API URL. 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 attribute value
 my $value = $rir->override_url();
 #Modify attribute value
 $rir->override_url('true');

AUTHOR

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

SEE ALSO

Infoblox::Session, Infoblox::Grid->enable_rir_swip()

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.