Parameter |
Choices/Defaults |
Comments |
description
string
|
|
The user-defined description of the router profile.
|
ignore_client_port
boolean
|
|
When yes , the remote port on clientside connections (connections where the peer connected to the BIG-IP) is ignored when searching for an existing connection.
|
inherited_traffic_group
boolean
|
|
When set to yes , the traffic_group will be inherited from the containing folder. When not specified the system sets this to no when creating new router profile.
|
max_pending_bytes
integer
|
|
The maximum number of bytes worth of pending messages that will be held while waiting for a connection to a peer to be created. Once reached, any additional messages to the peer will be flagged as undeliverable and returned to the originator.
The accepted range is between 0 and 4294967295 inclusive.
|
max_pending_messages
integer
|
|
The maximum number of pending messages that will be held while waiting for a connection to a peer to be created. Once reached, any additional messages to the peer will be flagged as undeliverable and returned to the originator.
The accepted range is between 0 and 65535 inclusive.
|
max_retries
integer
|
|
Sets the maximum number of time a message may be resubmitted for rerouting by the MR::retry iRule command.
The accepted range is between 0 and 4294967295 inclusive.
|
mirror
boolean
|
|
Enables or disables state mirroring. State mirroring can be used to maintain the same state information in the standby unit that is in the active unit.
|
mirrored_msg_sweeper_interval
integer
|
|
Specifies the maximum time in milliseconds that a message will be held on the standby device as it waits for the active device to route the message.
Messages on the standby device held for longer than the configurable sweeper interval, will be dropped.
The acceptable range is between 0 and 4294967295 inclusive.
|
name
string
/ required
|
|
Specifies the name of the router profile.
|
parent
string
|
|
The parent template of this router profile. Once this value has been set, it cannot be changed.
The default values are set by the system if not specified and they correspond to the router type created, for example, /Common/messagerouter for generic type and so on.
|
partition
string
|
Default:
"Common"
|
Device partition to create router profile on.
|
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 .
|
routes
list
/ elements=string
|
|
Specifies a list of static routes for the router instance to use.
The route must be on the same partition as router profile.
|
state
string
|
Choices:
present ←
- absent
|
When present , ensures the router profile exists.
When absent , ensures the router profile is removed.
|
traffic_group
string
|
|
Specifies the traffic-group of the router profile.
Setting the traffic_group to an empty string value "" will cause the device to inherit from containing folder, which means the value of inherited_traffic_group on device will be yes .
|
type
string
|
|
Parameter used to specify the type of the router profile to manage.
Default setting is generic with more options coming.
|
use_local_connection
boolean
|
|
If yes , the router will route a message to an existing connection on the same TMM as the message was received.
|