f5networks.f5_modules.bigip_profile_sip module – Manage SIP profiles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_profile_sip
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage SIP profiles on a BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
When the |
|
Description of the profile. To remove the entry completely, set a value of |
|
When Choices:
|
|
Specifies whether the Advanced Firewall Manager (AFM) policy is enabled. When Choices:
|
|
When Choices:
|
|
When Via headers indicate the path taken through proxy devices and transports used. The response message uses this routing information. Choices:
|
|
Specifies the logging settings the publisher uses to send log messages. The format of the name can be either be prepended by partition ( To remove the entry. set a value of |
|
Specifies the publisher defined to log messages. Format of the name can be either be prepended by partition ( To remove the entry. set a value of |
|
Specifies the maximum SIP message size that the BIG-IP system accepts. The accepted value range is |
|
Specifies the name of the SIP profile to manage. |
|
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 |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
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, Choices:
|
|
When Choices:
|
|
When When Choices:
|
|
When A BYE transaction is a message an application sends to another application when it is ready to close the connection between the two. Choices:
|
|
When The valid value must include SIP protocol and sent_by settings, for example: To remove the entry completely, set a value of |
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create a SIP profile
bigip_profile_sip:
name: foo
parent: sip
log_profile: alg_log
log_publisher: foo-publisher
description: this is a new profile
security: true
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Update SIP profile
bigip_profile_sip:
name: foo
insert_record_route_header: true
enable_sip_firewall: true
insert_via_header: true
user_via_header: "SIP/2.0/UDP 10.10.10.10:5060"
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Delete a SIP profile
bigip_profile_sip:
name: foo
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Indicates whether the pair belongs to the same SIP proxy functional group. Returned: changed Sample: |
|
Description of the profile. Returned: changed Sample: |
|
Specifies if the system gathers SIP dialog information. Returned: changed Sample: |
|
Specifies whether the Advanced Firewall Manager policy is enabled. Returned: changed Sample: |
|
Specifies if the system will insert a Record-Route SIP header. Returned: changed Sample: |
|
Specifies if the system will insert a Via header in the forwarded SIP request. Returned: changed Sample: |
|
The logging settings the publisher uses to send log messages. Returned: changed Sample: |
|
The publisher defined to log messages. Returned: changed Sample: |
|
Specifies if the system will close a connection when a BYE transaction finishes. Returned: changed Sample: |
|
Specifies the profile from which this profile inherits settings. Returned: changed Sample: |
|
Specifies if the system will insert a secure Via header in the forwarded SIP request. Returned: changed Sample: |
|
Enables the use of enhanced Horizontal Security Layer security checking. Returned: changed Sample: |
|
Specifies if the system will close a connection when a BYE transaction finishes. Returned: changed Sample: |
|
The value the system inserts as the top Via header in a SIP REQUEST message. Returned: changed Sample: |