Parameter |
Choices/Defaults |
Comments |
description
string
|
|
Description of the IKE peer.
|
name
string
/ required
|
|
Specifies the name of the IKE peer.
|
partition
string
|
Default:
"Common"
|
Device partition to manage resources on.
|
phase1_auth_method
string
|
Choices:
- pre-shared-key
- rsa-signature
|
Specifies the authentication method for phase 1 negotiation.
When creating a new IKE peer, if this value is not specified, the default is rsa-signature .
|
phase1_cert
string
|
|
Specifies the digital certificate to use for the RSA signature.
When creating a new IKE peer, if this value is not specified, and phase1_auth_method is rsa-signature , the default is default.crt .
This parameter is invalid when phase1_auth_method is pre-shared-key .
|
phase1_encryption_algorithm
string
|
Choices:
- 3des
- des
- blowfish
- cast128
- aes128
- aes192
- aes256
- camellia
|
Specifies the algorithm to use for IKE encryption.
IKE version v2 does not support blowfish , camellia , or cast128 .
|
phase1_hash_algorithm
string
|
Choices:
- sha1
- md5
- sha256
- sha384
- sha512
|
Specifies the algorithm to use for IKE authentication.
|
phase1_key
string
|
|
Specifies the public key the digital certificate contains.
When creating a new IKE peer, if this value is not specified, and phase1_auth_method is rsa-signature , the default is default.key .
This parameter is invalid when phase1_auth_method is pre-shared-key .
|
phase1_lifetime
integer
added in 1.1.0 of f5networks.f5_modules
|
|
Defines the lifetime in minutes of an IKE SA which will be proposed in the phase 1 negotiations.
The accepted value range is 1 - 4294967295 minutes.
When creating a new IKE peer, if this value is not specified, the default value set by the system is 1440 minutes.
|
phase1_perfect_forward_secrecy
string
|
Choices:
- ecp256
- ecp384
- ecp521
- modp768
- modp1024
- modp1536
- modp2048
- modp3072
- modp4096
- modp6144
- modp8192
|
Specifies the Diffie-Hellman group to use for IKE Phase 1 and Phase 2 negotiations.
|
phase1_verify_peer_cert
boolean
|
|
In IKEv2, specifies whether the certificate sent by the IKE peer is verified using the Trusted Certificate Authorities, a CRL, and/or a peer certificate.
In IKEv1, specifies whether the identifier sent by the peer is verified with the credentials in the certificate, in the following manner - ASN1DN; specifies that the entire certificate subject name is compared with the identifier. Address, FQDN, or User FQDN; specifies that the certificate's subjectAltName is compared with the identifier. If the two do not match, the negotiation fails.
When creating a new IKE peer, if this value is not specified, and phase1_auth_method is rsa-signature , the default is no .
This parameter is invalid when phase1_auth_method is pre-shared-key .
|
presented_id_type
string
|
Choices:
- address
- asn1dn
- fqdn
- keyid-tag
- user-fqdn
- override
|
Specifies the identifier type the local system uses to identify itself to the peer during IKE Phase 1 negotiations.
|
presented_id_value
string
|
|
Specifies a value for the identity when using a presented_id_type of override .
This is a required value when version includes (Cv2).
|
preshared_key
string
|
|
Specifies a string the IKE peers share for authenticating each other.
This parameter is only relevant when phase1_auth_method is pre-shared-key .
This parameter is invalid when phase1_auth_method is rsa-signature .
|
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
|
|
A dict object containing connection details.
|
|
auth_provider
string
|
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|
no_f5_teem
boolean
|
|
If yes , TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM .
|
|
password
string
/ required
|
|
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD .
aliases: pass, pwd
|
|
server
string
/ required
|
|
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER .
|
|
server_port
integer
|
Default:
443
|
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT .
|
|
timeout
integer
|
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|
user
string
/ required
|
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable F5_USER .
|
|
validate_certs
boolean
|
|
If no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS .
|
remote_address
string
|
|
Displays the IP address of the BIG-IP system that is remote to the system you are configuring.
|
state
string
|
Choices:
present ←
- absent
|
When present , ensures the resource exists.
When absent , ensures the resource is removed.
|
update_password
string
|
Choices:
always ←
- on_create
|
always will allow updating passwords if the user chooses to do so. on_create will only set the password for newly created IKE peers.
|
verified_id_type
string
|
Choices:
- address
- asn1dn
- fqdn
- keyid-tag
- user-fqdn
- override
|
Specifies the identifier type that the local system uses to identify the peer during IKE Phase 1 negotiation.
This is a required value when version includes (Cv2).
When user-fqdn , value of verified_id_value must be in the form of User @ DNS domain string.
|
verified_id_value
string
|
|
Specifies a value for the identity when using a verified_id_type of override .
This is a required value when version includes (Cv2).
|
version
list
/ elements=string
|
|
Specifies which version of IKE is used.
If the system you are configuring is the IPsec initiator, and you select both versions, the system tries using IKEv2 for negotiation. If the remote peer does not support IKEv2, the IPsec tunnel fails. To use IKEv1 in this case, you must deselect Version 2 and try again.
If the system you are configuring is the IPsec responder, and you select both versions, the IPsec initiator system determines which IKE version to use.
When creating a new IKE peer, this value is required.
|