Networking::ProfileGRE¶
Introduced : BIG-IP_v10.1.0
The ProfileGRE interface allows you to manipulate a GRE tunnel profile
to configure the General Routing Encapsulation tunneling protocol. The
General Routing Encapsulation supports RFC2784, allowing the packets
of any L3 protocol to be carried inside encapsulating IP packets.
Methods¶
| Method | Description | Introduced |
| create | Creates a set of GRE tunnel profiles. | BIG-IP_v10.1.0 |
| delete_all_profiles | Deletes all non-system GRE tunnel profiles. | BIG-IP_v10.1.0 |
| delete_profile | Deletes a set of GRE tunnel profiles. | BIG-IP_v10.1.0 |
| get_default_profile | Gets the existing GRE tunnel profile from which this set of GRE profiles inherits its unspecified attribute values. | BIG-IP_v10.1.0 |
| get_description | Gets the descriptions for a set of GRE tunnel profiles. | BIG-IP_v11.0.0 |
| get_encapsulation | Gets the encapsulation for the specified GRE profiles. | BIG-IP_v11.5.0 |
| get_flooding_type | Gets the flooding type for the specified GRE profiles. Note: Flooding type cannot be set to PROFILE_GRE_FLOODING_TYPE_MULTIPOINT if encapsulation type is PROFILE_GRE_ENCAPSULATION_TYPE_STANDARD. | BIG-IP_v11.5.0 |
| get_include_checksum_state | Gets whether the checksum should be included in the transmitted packets for a set of GRE tunnel profiles. | BIG-IP_v10.1.0 |
| get_list | Gets the names for all GRE tunnel profiles. | BIG-IP_v10.1.0 |
| get_validate_checksum_state | Gets whether the checksum should be validated on the received packets for a set of GRE tunnel profiles. | BIG-IP_v10.1.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v10.1.0 |
| is_base_profile | Determines whether the specified GRE tunnel profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). | BIG-IP_v10.1.0 |
| is_system_profile | Determines whether the specified GRE tunnel profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). | BIG-IP_v11.0.0 |
| set_default_profile | Sets the existing GRE tunnel profile from which this set of GRE tunnel profiles inherits their unspecified attribute values. | BIG-IP_v10.1.0 |
| set_description | Sets the description for a set of GRE tunnel profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_encapsulation | Sets the encapsulation to specify the flavor of the GRE header used for encapsulation. Note: Encapsulation type cannot be set to PROFILE_GRE_ENCAPSULATION_TYPE_STANDARD if flooding type is set to PROFILE_GRE_FLOODING_TYPE_MULTIPOINT. | BIG-IP_v11.5.0 |
| set_flooding_type | Sets the flooding type to use to transmit multicast, broadcast and unknown destination frames. The default is PROFILE_GRE_FLOODING_TYPE_NONE. | BIG-IP_v11.5.0 |
| set_include_checksum_state | Sets whether the checksum should be included in the transmitted packets for a set of GRE tunnel profiles. | BIG-IP_v10.1.0 |
| set_validate_checksum_state | Sets whether the checksum should be validated on the received packets for a set of GRE tunnel profiles. | BIG-IP_v10.1.0 |
Structures¶
Structure
Description
A structure that specifies encapsulation type used in profile attributes.
A structure that specifies flooding type used in profile attributes.
Enumerations¶
| Enumeration | Description |
| GREEncapsulationType | The encapsulation type to specify the flavor of the GRE header used for encapsulation. |
| GREFloodingType | The flooding type to use to transmit multicast, broadcast and unknown destination frames. |
Aliases¶
| Alias | Type | Description |
| ProfileGREEncapsulationTypeSequence | ProfileGREEncapsulationType [] | A sequence of profile encapsulation types. |
| ProfileGREFloodingTypeSequence | ProfileGREFloodingType [] | A sequence of profile flooding types. |
See Also¶
iControl ::
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.