LocalLB::SNAT¶
Introduced : BIG-IP_v9.0
The SNAT interface enables you to work with the definitions contained
in a local load balancer&aposs top-level secure network address
translations (SNAT) object. The top-level SNAT configuration object is
a named object in the definition of a standard or a selective SNAT.
Standard SNATs translate to a single address, while selective SNATs
translate to a pool of translation addresses, i.e. SNAT pool.
Methods¶
| Method | Description | Introduced |
| add_metadata | Adds the metadata for the specified snats. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| add_original_address | Adds original client addresses to the filters used to match incoming traffic. | BIG-IP_v9.0 |
| create | Creates the specified top-level SNAT objects. | BIG-IP_v9.0 |
| delete_all_snats | Deletes all SNATs. | BIG-IP_v9.0 |
| delete_snat | Deletes a specified list of SNATs. | BIG-IP_v9.0 |
| get_all_statistics | Gets the statistics for all top-level SNATs. | BIG-IP_v9.0 |
| get_auto_lasthop | Gets the attribute that specifies auto-lasthop behavior, for the specified SNATs. | BIG-IP_v11.4.0 |
| get_connection_mirror_state | Gets the connection mirror states for a specified SNATs. | BIG-IP_v9.0 |
| get_description | Gets the descriptions for a set of SNATs. | BIG-IP_v11.0.0 |
| get_list | Gets a list of all top-level SNAT configuration objects. | BIG-IP_v9.0 |
| get_metadata | Gets the user metadata for the specified snats. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. | BIG-IP_v11.2.0 |
| get_metadata_description | Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_persistence | Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_metadata_value | Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| get_original_address | Gets the list of original client addresses used to filter the traffic to the SNATs. | BIG-IP_v9.0 |
| get_source_port_behavior | Gets the source port behavior for the specified SNATs. | BIG-IP_v10.0.0 |
| get_statistics | Gets the statistics for a list of top-level SNATs. | BIG-IP_v9.0 |
| get_translation_target | Gets the translation targets for the specified SNATs. If the target type is SNAT_TYPE_AUTOMAP, then the translation object should be empty. | BIG-IP_v9.0 |
| get_version | Get the version information for this interface. | BIG-IP_v9.0 |
| get_vlan | Gets the list of VLANs on which access to the specified SNATs is disabled/enabled. | BIG-IP_v9.0 |
| remove_all_metadata | Removes all the metadata instances for the specified snats. | BIG-IP_v11.2.0 |
| remove_all_original_addresses | Removes all original client addresses in the filters. | BIG-IP_v9.0 |
| remove_metadata | Removes the metadata for the specified snats and names. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| remove_original_address | Removes original client addresses from the filters used to match incoming traffic. | BIG-IP_v9.0 |
| reset_statistics | Resets the statistics for a list of top-level SNATs. | BIG-IP_v9.0 |
| set_auto_lasthop | Sets the attribute that specifies auto-lasthop behavior, for the specified SNATs. This controls how the system routes return traffic. The default is AUTO_LASTHOP_DEFAULT. | BIG-IP_v11.4.0 |
| set_connection_mirror_state | Sets the connection mirror state for the specified SNATs. | BIG-IP_v9.0 |
| set_description | Sets the description for a set of SNATs. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_metadata_description | Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_persistence | Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_metadata_value | Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. | BIG-IP_v11.2.0 |
| set_source_port_behavior | Sets the source port behavior for the specified SNATs. | BIG-IP_v10.0.0 |
| set_translation_target | Sets the translation targets for the specified SNATs. If the target type is SNAT_TYPE_AUTOMAP, then the translation object should be empty. | BIG-IP_v9.0 |
| set_vlan | Sets the VLANSs on which access to the specified SNATs is disabled/enabled. | BIG-IP_v9.0 |
Structures¶
Structure
Description
A struct that describes a definition for a SNAT.
A struct that describes a SNAT original address filter.
A struct that describes statistics for a specified top-level SNAT object.
A struct that describes SNAT pool statistics and timestamp.
A struct that describes a translation target.
Aliases¶
| Alias | Type | Description |
| SNATDefinitionSequence | SNATDefinition [] | A sequence of SNATDefinition&aposs. |
| SNATOriginalAddressSequence | SNATOriginalAddress [] | A sequence of SNATOriginalAddress&aposs. |
| SNATOriginalAddressSequenceSequence | SNATOriginalAddress [] [] | An alias for a sequence of SNATOriginalAddress&aposs. |
| SNATStatisticEntrySequence | SNATStatisticEntry [] | A sequence of SNAT statistics. |
| TranslationSequence | Translation [] | A sequence of Translation&aposs. |
See Also¶
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.