a10_router_bgp_neighbor_peer_group_neighbor

Synopsis

Specify a peer-group neighbor router

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

bgp_as_number

str/required

Key to identify parent object

peer_group

str/required

Neighbor tag

peer_group_key

bool

Configure peer-group

peer_group_remote_as

str

Specify AS number of BGP neighbor

activate

bool

Enable the Address Family for this Neighbor

advertisement_interval

int

Minimum interval between sending BGP routing updates (time in seconds)

allowas_in

bool

Accept as-path with my AS present in it

allowas_in_count

int

Number of occurrences of AS number

as_origination_interval

int

Minimum interval between sending AS-origination routing updates (time in seconds)

dynamic

bool

Advertise dynamic capability to this neighbor

route_refresh

bool

Advertise route-refresh capability to this neighbor

extended_nexthop

bool

Advertise extended-nexthop capability to this neighbor

collide_established

bool

Include Neighbor in Established State for Collision Detection

default_originate

bool

Originate default route to this neighbor

route_map

str

Route-map to specify criteria to originate default (route-map name)

description

str

Neighbor specific description (Up to 80 characters describing this neighbor)

dont_capability_negotiate

bool

Do not perform capability negotiation

ebgp_multihop

bool

Allow EBGP neighbors not on directly connected networks

ebgp_multihop_hop_count

int

maximum hop count

enforce_multihop

bool

Enforce EBGP neighbors to perform multihop

bfd

bool

Bidirectional Forwarding Detection (BFD)

multihop

bool

Enable multihop

maximum_prefix

int

Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

maximum_prefix_thres

int

threshold-value, 1 to 100 percent

override_capability

bool

Override capability negotiation result

pass_value

str

Key String

pass_encrypted

str

Field pass_encrypted

passive

bool

Don’t send open messages to this neighbor

remove_private_as

bool

Remove private AS number from outbound updates

neighbor_route_map_lists

list

Field neighbor_route_map_lists

nbr_route_map

str

Apply route map to neighbor (Name of route map)

nbr_rmap_direction

str

‘in’= in; ‘out’= out;

inbound

bool

Allow inbound soft reconfiguration for this neighbor

shutdown

bool

Administratively shut down this neighbor

strict_capability_match

bool

Strict capability negotiation match

timers_keepalive

int

Keepalive interval

timers_holdtime

int

Holdtime

connect

int

BGP connect timer

update_source_ip

str

IP address

update_source_ipv6

str

IPv6 address

ethernet

str

Ethernet interface (Port number)

loopback

str

Loopback interface (Port number)

ve

str

Virtual ethernet interface (Virtual ethernet interface number)

trunk

str

Trunk interface (Trunk interface number)

lif

str

Logical interface (Lif interface name)

tunnel

str

Tunnel interface (Tunnel interface number)

weight

int

Set default weight for routes from this neighbor

uuid

str

uuid of the object

Examples


Return Values

modified_values (changed, dict, )

Values modified (or potential changes if using check_mode) as a result of task operation

axapi_calls (always, list, )

Sequential list of AXAPI calls made by the task

endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])

The AXAPI endpoint being accessed.

http_method (, str, [‘POST’, ‘GET’])

HTTP method being used by the primary task to interact with the AXAPI endpoint.

request_body (, complex, )

Params used to query the AXAPI

response_body (, complex, )

Response from the AXAPI

Status

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

  • This module is maintained by community.

Authors

  • A10 Networks