a10_slb_template_sip

Synopsis

SIP Template

Parameters

Parameters

Choices/Defaults

Comment

state

str/required

[‘noop’, ‘present’, ‘absent’]

State of the object to be created.

ansible_host

str/required

Host for AXAPI authentication

ansible_username

str/required

Username for AXAPI authentication

ansible_password

str/required

Password for AXAPI authentication

ansible_port

int/required

Port for AXAPI authentication

a10_device_context_id

int

[‘1-8’]

Device ID for aVCS configuration

a10_partition

str

Destination/target partition for object/command

name

str/required

SIP Template Name

alg_source_nat

bool

Translate source IP to NAT IP in SIP message when source NAT is used

alg_dest_nat

bool

Translate VIP to real server IP in SIP message when destination NAT is used

call_id_persist_disable

bool

Disable call-ID persistence

client_keep_alive

bool

Respond client keep-alive packet directly instead of forwarding to server

pstn_gw

str

configure pstn gw host name for tel= uri translate to sip= uri (Hostname String, default is ‘pstn’)

client_request_header

list

Field client_request_header

client_request_header_erase

str

Erase a SIP header (Header Name)

client_request_erase_all

bool

Erase all headers

client_request_header_insert

str

Insert a SIP header (Header Content (Format= ‘name=value’))

insert_condition_client_request

str

‘insert-if-not-exist’= Only insert the header when it does not exist; ‘insert- always’= Always insert the header even when there is a header with the same name;

client_response_header

list

Field client_response_header

client_response_header_erase

str

Erase a SIP header (Header Name)

client_response_erase_all

bool

Erase all headers

client_response_header_insert

str

Insert a SIP header (Header Content (Format= ‘name=value’))

insert_condition_client_response

str

‘insert-if-not-exist’= Only insert the header when it does not exist; ‘insert- always’= Always insert the header even when there is a header with the same name;

exclude_translation

list

Field exclude_translation

translation_value

str

‘start-line’= SIP request line or status line; ‘header’= SIP message headers; ‘body’= SIP message body;

header_string

str

SIP header name

failed_client_selection

bool

Define action when select client fail

drop_when_client_fail

bool

Drop current SIP message when select client fail

failed_client_selection_message

str

Send SIP message (includs status code) to server when select client fail(Format= 3 digits(1XX~6XX) space reason)

failed_server_selection

bool

Define action when select server fail

drop_when_server_fail

bool

Drop current SIP message when select server fail

failed_server_selection_message

str

Send SIP message (includs status code) to client when select server fail(Format= 3 digits(1XX~6XX) space reason)

insert_client_ip

bool

Insert Client IP address into SIP header

keep_server_ip_if_match_acl

bool

Use Real Server IP for addresses matching the ACL for a Call-Id

acl_id

int

ACL id

acl_name_value

str

IPv4 Access List Name

service_group

str

service group name

server_keep_alive

bool

Send server keep-alive packet for every persist connection when enable conn- reuse

interval

int

The interval of keep-alive packet for each persist connection (second)

server_request_header

list

Field server_request_header

server_request_header_erase

str

Erase a SIP header (Header Name)

server_request_erase_all

bool

Erase all headers

server_request_header_insert

str

Insert a SIP header (Header Content (Format= ‘name=value’))

insert_condition_server_request

str

‘insert-if-not-exist’= Only insert the header when it does not exist; ‘insert- always’= Always insert the header even when there is a header with the same name;

server_response_header

list

Field server_response_header

server_response_header_erase

str

Erase a SIP header (Header Name)

server_response_erase_all

bool

Erase all headers

server_response_header_insert

str

Insert a SIP header (Header Content (Format= ‘name=value’))

insert_condition_server_response

str

‘insert-if-not-exist’= Only insert the header when it does not exist; ‘insert- always’= Always insert the header even when there is a header with the same name;

smp_call_id_rtp_session

bool

Create the across cpu call-id rtp session

server_selection_per_request

bool

Force server selection on every SIP request

timeout

int

Time in minutes

dialog_aware

bool

Permit system processes dialog session

uuid

str

uuid of the object

user_tag

str

Customized tag

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by community.

Authors

  • A10 Networks 2021