Networking::iSessionRemoteInterfaceV2¶
Introduced : BIG-IP_v11.0.0
Remote endpoint for the traffic from the local WAN Optimization Module
endpoint. A single local endpoint can work with multiple remote
endpoints.
Methods¶
| Method | Description | Introduced |
| create | Creates a set of remote endpoints. | BIG-IP_v11.0.0 |
| delete_all_peers | Deletes all remote endpoints. | BIG-IP_v11.0.0 |
| delete_peer | Deletes a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_UUID | Gets the universal Unique Identifier, a 128-bit number that identifies this remote endpoint for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_address | Gets the local endpoint IP address for a set of remote endpoints. Note: A set_address method is not supported. | BIG-IP_v11.0.0 |
| get_behind_nat_state | Gets the state to indicate that this is located behind a Network Address Translation device for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_dedup_cache | Gets the total amount of cache available for symmetric data deduplication for a set of remote endpoints. The system apportions this cache according to the number of remote endpoints and the amount of cache available at each endpoint. | BIG-IP_v11.0.0 |
| get_description | Gets the descriptions for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_internal_forwarding | Gets the internal forwarding state of the local endpoint. | BIG-IP_v11.6.0 |
| get_list | Gets the names of all remote endpoints. | BIG-IP_v11.0.0 |
| get_management_address | Gets the management IP address for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_nat_config_status | Gets the configuration status for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_nat_source_address | Gets the SNAT address source for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_origin | Gets the how the remote endpoint was created for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_peer_enabled_state | Gets the state to optimize traffic between the local endpoint and this remote endpoint for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_peer_ip_list | Gets the list of IP addresses that the local endpoint uses to communicate with the WAN Optimization Module on a remote BIG-IP system for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_peer_name | Gets the host name of the BIG-IP system that hosts this remote endpoint for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_peer_routing_state | Gets the state to indicate that a route exists from the local endpoint to this remote endpoint through which the local endpoint can establish connections for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_profile_serverssl | Gets the sSL profile used for authenticating (encrypting for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_tunnel_port | Gets the local endpoint IP service that the WAN Optimization Module uses to control connections for a set of remote endpoints. | BIG-IP_v11.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.0.0 |
| set_behind_nat_state | Sets the state to indicate that this is located behind a Network Address Translation device for a set of remote endpoints. | BIG-IP_v11.0.0 |
| set_description | Sets the description for a set of remote endpoints. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_internal_forwarding | Sets the internal forwarding states of the remote endpoints. The internal forwarding state of local endpoint and the internal forwarding state of remote endpoint, controls the forwarding of internal data traffic to remote endpoints. | BIG-IP_v11.6.0 |
| set_management_address | Sets the management IP address for a set of remote endpoints. | BIG-IP_v11.0.0 |
| set_nat_config_status | Sets the configuration status for a set of remote endpoints. | BIG-IP_v11.0.0 |
| set_nat_source_address | Sets the SNAT address source for a set of remote endpoints. | BIG-IP_v11.0.0 |
| set_origin | Sets the how the remote endpoint was created for a set of remote endpoints. You can change the origin from “discovered” to “persistable”, if you want to save the endpoint configuration. After a remote endpoint has been saved, this attribute is changed to “manually saved”. Any remote endpoints marked as “discovered” are not saved. | BIG-IP_v11.0.0 |
| set_peer_enabled_state | Sets the state to optimize traffic between the local endpoint and this remote endpoint for a set of remote endpoints. Disabling a remote endpoint affects only the connection between the local endpoint and this remote endpoint. | BIG-IP_v11.0.0 |
| set_peer_routing_state | Sets the state to indicate that a route exists from the local endpoint to this remote endpoint through which the local endpoint can establish connections for a set of remote endpoints. If not set, the local endpoint cannot initiate traffic to the remote endpoint. | BIG-IP_v11.0.0 |
| set_profile_serverssl | Sets the sSL profile used for authenticating (encrypting for a set of remote endpoints.) traffic to this remote endpoint. Note that this setting overrides the analogous setting in the local endpoint. | BIG-IP_v11.0.0 |
| set_tunnel_port | Sets the local endpoint IP service that the WAN Optimization Module uses to control connections for a set of remote endpoints. This must be a service that is allowed access through the firewall. | BIG-IP_v11.0.0 |
Enumerations¶
| Enumeration | Description |
| InternalForwarding | An enumeration of internal forwarding states. The internal forwarding state of local endpoint and the internal forwarding state of remote endpoint, controls the forwarding of internal data traffic to remote endpoints. |
| NatSourceAddress | An enumeration of SNAT address sources. |
| OriginState | An enumeration of origin states. |
Aliases¶
| Alias | Type | Description |
| InternalForwardingSequence | InternalForwarding [] | |
| NatSourceAddressSequence | NatSourceAddress [] | A sequence of NatSourceAddress states. |
| OriginStateSequence | OriginState [] | A sequence of NatSourceAddress states. |
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.