Parameter |
Choices/Defaults |
Comments |
community
string
|
|
When the dialog_aware is yes and the configuration requires multiple SIP virtual server-profile pairings, this string value indicates whether the pair belongs to the same SIP proxy functional group.
|
description
string
|
|
Description of the profile.
To remove the entry completely, set a value of '' .
|
dialog_aware
boolean
|
|
When yes , the system gathers SIP dialog information and automatically forwards SIP messages belonging to the known SIP dialog.
|
enable_sip_firewall
boolean
|
|
Specifies whether the Advanced Firewall Manager (AFM) policy is enabled.
When yes , the SIP Security settings configured in the DoS Profile in AFM apply to the virtual servers that use this profile.
|
insert_record_route_header
boolean
|
|
When yes , inserts a Record-Route SIP header, which indicates the next hop for the following SIP request messages.
|
insert_via_header
boolean
|
|
When yes , inserts a Via header in the forwarded SIP request.
Via headers indicate the path taken through proxy devices and transports used. The response message uses this routing information.
|
log_profile
string
|
|
Specifies the logging settings the publisher uses to send log messages.
The format of the name can be either be prepended by partition (/Common/foo ), or specified just as an object name (foo ).
To remove the entry. set a value of '' , however the profile log_publisher must also be set as '' .
|
log_publisher
string
|
|
Specifies the publisher defined to log messages.
Format of the name can be either be prepended by partition (/Common/foo ), or specified just as an object name (foo ).
To remove the entry. set a value of '' , however the profile log_profile must also be set as '' .
|
max_size
integer
|
|
Specifies the maximum SIP message size that the BIG-IP system accepts.
The accepted value range is 0 - 4294967295 bytes.
|
name
string
/ required
|
|
Specifies the name of the SIP profile to manage.
|
parent
string
|
|
Specifies the profile from which this profile inherits settings.
When creating a new profile, if this parameter is not specified, the default is the system-supplied sip profile.
|
partition
string
|
Default:
"Common"
|
Device partition to manage resources 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 .
|
secure_via_header
boolean
|
|
When checked (enabled), inserts a secure Via header in the forwarded SIP request.
A secure Via header indicates where the message originated.
This parameter causes the inserted Via header to specify Transport Layer Security. For this option to take effect, insert_via_header must be set to (yes).
|
security
boolean
|
|
When yes . enables the use of enhanced Horizontal Security Layer (HSL) security checking.
|
state
string
|
Choices:
present ←
- absent
|
When present , ensures the profile exists.
When absent , ensures the profile is removed.
|
terminate_on_bye
boolean
|
|
When yes , closes a connection when a BYE transaction finishes.
A BYE transaction is a message an application sends to another application when it is ready to close the connection between the two.
|
user_via_header
string
|
|
When insert_via_header is yes , specifies the Via value the system inserts as the top Via header in a SIP REQUEST message.
The valid value must include SIP protocol and sent_by settings, for example: SIP/2.0/UDP 10.10.10.10:5060 .
To remove the entry completely, set a value of '' .
|