Infoblox::Grid::ThreatProtection::NATRule - a NAT Threat Protection Rule object.


NAME

Infoblox::Grid::ThreatProtection::NATRule - a NAT Threat Protection Rule object.


DESCRIPTION

The NAT Threat Protection Rule object provides information about NAT rules configured for the threat protection NAT mapping feature.


CONSTRUCTOR

 my $nat_rule = Infoblox::Grid::ThreatProtection::NATRule->new(
    rule_type     => 'ADDRESS' | 'NETWORK' | 'RANGE', #Required
    address       => $ipaddress,                      #Required if rule_type is 'ADDRESS'
    network       => $ipaddress,                      #Required if rule_type is 'NETWORK'
    cidr          => $uint,                           #Required if rule_type is 'NETWORK'
    start_address => $ipaddress,                      #Required if rule_type is 'RANGE'
    end_address   => $ipaddress,                      #Required if rule_type is 'RANGE'
    nat_ports     => $nat_ports,                      #Optional
 );


SESSION METHODS

The object does not support any session methods.


MODULE METHODS

The following functions are available to apply to a NAT Port object.

Infoblox::Grid::ThreatProtection->nat_rules( )

Use this method to set or retrieve the list of rules configured for the threat protection NAT mapping feature. See Infoblox::Grid::ThreatProtection->nat_rules() for parameters and return values.

Example
 #Get nat_rules
 my $nat_rules = $nat_rule->nat_rules();
 #Modify nat_rules
 $nat_rule->nat_rules($nat_rules);

Infoblox::Grid::Member::ThreatProtection->nat_rules( )

Use this method to set or retrieve the list of rules configured for the threat protection NAT mapping feature. See Infoblox::Grid::Member::ThreatProtection->nat_rules() for parameters and return values.

Example
 #Get nat_rules
 my $nat_rules = $nat_rule->nat_rules();
 #Modify nat_rules
 $nat_rule->nat_rules($nat_rules);


METHODS

This section describes all the methods that you can use to configure and retrieve the attribute values of a Threat Protection NAT Port.

address( )

Use this method to set or retrieve the IP address for the threat protection NAT mapping rule.

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

Parameter

The valid value is a desired IP 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 = $object->address();
 #Modify attribute value
 $object->address('1.1.1.1');

cidr( )

Use this method to set or retrieve the network CIDR for the threat protection NAT mapping rule.

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

Parameter

The valid value is an unsigned integer.

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->cidr();
 #Modify attribute value
 $object->cidr(8);

end_address( )

Use this method to set or retrieve the end address for the range of the threat protection NAT mapping rule.

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

Parameter

The valid value is a desired IP 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 = $object->end_address();
 #Modify attribute value
 $object->end_address('1.1.0.255');

nat_ports( )

Use this method to set or retrieve the NAT port configuration for the threat protection NAT mapping rule.

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

Parameter

The valid value is an array of Infoblox::Grid::ThreatProtection::NATPort objects.

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

network( )

Use this method to set or retrieve the network address for the threat protection NAT mapping rule.

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

Parameter

The valid value is an unsigned integer.

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

rule_type( )

Use this method to set or retrieve the rule type for the threat protection NAT mapping rule.

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

Parameter

The valid values are 'ADDRESS', 'RANGE', 'NETWORK'.

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

start_address( )

Use this method to set or retrieve the start address of the range for the threat protection NAT mapping rule.

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

Parameter

The valid value is a desired IP 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 = $object->start_address();
 #Modify attribute value
 $object->start_address('1.1.0.255');


AUTHOR

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


SEE ALSO

Infoblox::Grid::ThreatProtection::NATPort, Infoblox::Grid::ThreatProtection->nat_rules(), Infoblox::Grid::ThreatProtection, Infoblox::Grid::Member::ThreatProtection->nat_rules(), Infoblox::Grid::Member::ThreatProtection.


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.