Parameter |
Choices/Defaults |
Comments |
add_analytics
boolean
|
|
Collects statistics of the BIG-IP to which the application is deployed.
This parameter is only relevant when specifying a service_environment which is a BIG-IP; not an SSG.
|
client_ssl_profile
dictionary
|
|
Specifies the SSL profile for managing client-side SSL traffic.
|
|
cert_key_chain
raw
|
|
One or more certificates and keys to associate with the SSL profile.
This option is always a list. The keys in the list dictate the details of the client/key/chain/passphrase combination.
BIG-IPs can only have one of each type of each certificate/key type. This means you can only have one RSA, one DSA, and one ECDSA per profile.
If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device rejects it.
This list is a complex list that specifies a number of keys.
When creating a new profile, if this parameter is not specified, the default value is inherit .
|
|
|
cert
string
|
|
Specifies a cert name for use.
|
|
|
chain
string
|
|
Specifies a certificate chain that is relevant to the specified certificate and key.
This key is optional.
|
|
|
key
string
|
|
Specifies a key name.
|
|
|
passphrase
string
|
|
Contains the passphrase of the key file, should it require one.
Passphrases are encrypted on the remote BIG-IP device.
|
|
name
string
|
Default:
"clientssl"
|
The name of the client SSL profile to created and used.
When creating a new application, if this value is not specified, the default value is clientssl .
|
description
string
|
|
Description of the application.
|
inbound_virtual
dictionary
|
|
Settings to configure the virtual which receives the inbound connection.
This virtual is used to host the HTTPS endpoint of the application.
Traffic destined to the redirect_virtual is offloaded to this parameter to ensure proper redirection from insecure to secure occurs.
|
|
address
string
/ required
|
|
Specifies destination IP address information to which the virtual server sends traffic.
This parameter is required when creating a new application.
|
|
netmask
string
/ required
|
|
Specifies the netmask to associate with the given address .
This parameter is required when creating a new application.
|
|
port
string
|
Default:
443
|
The port on which the virtual listens for connections.
When creating a new application, if this parameter is not specified, the default value is 443 .
|
name
string
/ required
|
|
Name of the new application.
|
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 .
|
redirect_virtual
dictionary
|
|
Settings to configure the virtual which receives the connection to be redirected.
This virtual is used to host the HTTP endpoint of the application.
Traffic destined to this parameter is offloaded to the inbound_virtual parameter to ensure proper redirection from insecure to secure occurs.
|
|
address
string
/ required
|
|
Specifies destination IP address information to which the virtual server sends traffic.
This parameter is required when creating a new application.
|
|
netmask
string
/ required
|
|
Specifies the netmask to associate with the given address .
This parameter is required when creating a new application.
|
|
port
string
|
Default:
80
|
The port on which the virtual listens for connections.
When creating a new application, if this parameter is not specified, the default value is 80 .
|
servers
list
/ elements=dictionary
|
|
A list of servers on which the application is hosted.
If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members.
When creating a new application, at least one server is required.
|
|
address
string
/ required
|
|
The IP address of the server.
|
|
port
string
|
Default:
80
|
The port of the server.
|
service_environment
string
|
|
Specifies the name of service environment or the hostname of the BIG-IP to which the application will be deployed.
When creating a new application, this parameter is required.
|
state
string
|
Choices:
- absent
present ←
|
The state of the resource on the system.
When present , guarantees the resource exists with the provided attributes.
When absent , removes the resource from the system.
|
wait
boolean
|
|
If the module should wait for the application to be created, deleted or updated.
|