Networking::IPsecManualSecurityAssociation

Introduced : BIG-IP_v11.2.0
This interface configures the IPsec Protocol suite for securing Internet Protocol (IP) communications by authenticating and encrypting each IP packet of a communication session. The Manual Security Association component is used to manually configure the Security Association Database (SAD) entries. The alternative is to use IKE to negotiate automatically keyed security associations.

Methods

Method Description Introduced
create Creates a set of IPsec manual security associations. BIG-IP_v11.2.0
delete_all_manual_security_associations Deletes all IPsec manual security associations. BIG-IP_v11.2.0
delete_manual_security_association Deletes a set of IPsec manual security associations. BIG-IP_v11.2.0
get_auth_algorithm Gets the IPsec authentication algorithm for each specified IPsec manual security association. BIG-IP_v11.2.0
get_auth_key Gets the IPsec authentication keys for each specified IPsec manual security association. BIG-IP_v11.4.0
get_auth_key_encrypted This method is deprecated. Please use get_auth_key instead. Gets the IPsec authentication keys (encrypted) for each specified IPsec manual security association. BIG-IP_v11.2.0
get_description Gets the description for each specified IPsec manual security association. BIG-IP_v11.2.0
get_destination_address Gets the IPsec destination address for each specified IPsec manual security association. BIG-IP_v11.2.0
get_encrypt_algorithm Gets the IPsec encrypt algorithm for each specified IPsec manual security association. BIG-IP_v11.2.0
get_encrypt_key Gets the IPsec encryption keys for each specified IPsec manual security association. BIG-IP_v11.5.0
get_encrypt_key_encrypted This method is deprecated. Please use get_encrypt_key instead. Gets the IPsec encryption keys (encrypted) for each specified IPsec manual security association. BIG-IP_v11.2.0
get_list Gets the names for all IPsec manual security associations. BIG-IP_v11.2.0
get_policy Gets the IPsec policy for each specified IPsec manual security association. BIG-IP_v11.2.0
get_protocol Gets the IPsec protocol for each specified IPsec manual security association. BIG-IP_v11.2.0
get_source_address Gets the IPsec manual security association source address for each specified IPsec manual security association. BIG-IP_v11.2.0
get_spi Gets the IPsec SPI for each specified IPsec manual security association. BIG-IP_v11.2.0
get_version Gets the version information for this interface. BIG-IP_v11.2.0
set_auth_algorithm Sets the IPsec authentication algorithm for each specified IPsec manual security association. BIG-IP_v11.2.0
set_auth_key Sets the IPsec authentication key for each specified IPsec manual security association. BIG-IP_v11.2.0
set_auth_key_encrypted This method is deprecated. The system automatically encrypts the auth key using the master key, and no longer requires a pre-encrypted value. Please use set_auth_key instead. Sets the IPsec authentication key (encrypted) for each specified IPsec manual security association. Requires an already encrypted key. BIG-IP_v11.2.0
set_description Sets the description for each specified IPsec manual security association. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.2.0
set_destination_address Sets the IPsec destination address for each specified IPsec manual security association. BIG-IP_v11.2.0
set_encrypt_algorithm Sets the IPsec encrypt algorithm for each specified IPsec manual security association. BIG-IP_v11.2.0
set_encrypt_key Sets the IPsec encryption key for each specified IPsec manual security association. BIG-IP_v11.2.0
set_encrypt_key_encrypted This method is deprecated. The system automatically encrypts the manual security association using the master key, and no longer requires a pre-encrypted value. Please use set_encrypt_key instead. Sets the IPsec encryption key (encrypted) for each specified IPsec manual security association. Requires an already encrypted key. BIG-IP_v11.2.0
set_policy Sets the IPsec policy for each specified IPsec manual security association. It specifies the ipsec policy associated with this manual security association. BIG-IP_v11.2.0
set_protocol Sets the IPsec protocol for each specified IPsec manual security association. Possible values are Encapsulating Security Payload - ESP or Authentication Header - AH. BIG-IP_v11.2.0
set_source_address Sets the IPsec manual security association source address for each specified IPsec manual security association. BIG-IP_v11.2.0
set_spi Sets the IPsec SPI for each specified IPsec manual security association. SPI specifies the Security Parameters Index. If this is the Security Association(SA) for the outbound traffic, make sure it matches the SPI of the inbound SA configured on the remote site and vice versa. SPI values between 0 and 255 are reserved for the future use by IANA and cannot be used. BIG-IP_v11.2.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

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.