nsxt_policy_tier0 – Create/Update/Delete a Tier-0 and associated resources

New in version 2.8.

Synopsis

  • Creates/Updates/Deletes a Tier-0 resource using the Policy API. Assocaited resources include ‘Tier-0 Locale Service’ and ‘Tier-0 Interface’. ‘Tier-0 Locale Service’ and ‘Tier-0 Interface’ attributes must be prepended with ‘t0ls’ and ‘t0iface’ respectively.

Parameters

Parameter Choices/Defaults Comments
achieve_subresource_state_if_del_parent
boolean
    Choices:
  • no ←
  • yes
Can be used to achieve the state of subresources even if the parent(base) resource's state is absent.
Can be specified for each subresource.
bfd_peers
list
This is a list of BFD Peers that need to be created, updated, or deleted
bfd_config_display_name
string
The associated BFD Config display name
Either this, bfd_config_id, or bfd_config_path must be specified
BFD configuration is not supported for IPv6 networks.
bfd_config_id
string
The associated BFD Config ID
Either this, bfd_config_display_name, or bfd_config_path must be specified
BFD configuration is not supported for IPv6 networks.
bfd_config_path
string
The associated BFD Config policy path
Either this, bfd_config_display_name, or bfd_config_id must be specified
BFD configuration is not supported for IPv6 networks.
description
string
Tier-0 BFD Peer description. config
display_name
string
Tier-0 BFD Peer display name.
Either this or id must be specified. If both are specified, id takes precedence.
enabled
list / elements=dictionary
Flag to enable BFD peer.
admin_distance
integer
Default:
1
Cost associated with next hop route
id
string
Tier-0 BFD Peer ID.
state
-
    Choices:
  • present
  • absent
State can be either 'present' or 'absent'. 'present' is used to create or update resource. 'absent' is used to delete resource.
Must be specified in order to modify the resource
tags
dictionary
Opaque identifiers meaningful to the API user
scope
string / required
Tag scope.
tag
string / required
Tag value.
ca_path
string
Path to the CA bundle to be used to verify host's SSL certificate
create_or_update_subresource_first
boolean
    Choices:
  • no ←
  • yes
Can be used to create subresources first.
Can be specified for each subresource.
default_rule_logging
-
Default:
"no"
Enable logging for whitelisted rule. Indicates if logging should be enabled for the default whitelisting rule.
delete_subresource_first
boolean
    Choices:
  • no
  • yes ←
Can be used to delete subresources first.
Can be specified for each subresource.
description
string
Tier-0 description
dhcp_config_display_name
string
Same as dhcp_config_id. Either one can be specified. If both are specified, dhcp_config_id takes precedence.
dhcp_config_id
string
DHCP configuration for Segments connected to Tier-0. DHCP service is configured in relay mode.
disable_firewall
boolean
    Choices:
  • no ←
  • yes
Disable or enable gateway fiewall.
display_name
string
Display name.
If resource ID is not specified, display_name will be used as ID.
do_wait_till_create
boolean
    Choices:
  • no ←
  • yes
Can be used to wait for the realization of subresource before the request to create the next resource is sent to the Manager.
Can be specified for each subresource.
failover_mode
string
    Choices:
  • NON_PREEMPTIVE ←
  • PREEMPTIVE
Determines the behavior when a Tier-0 instance in ACTIVE-STANDBY high-availability mode restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. This property must not be populated unless the ha_mode property is set to ACTIVE_STANDBY.
force_whitelisting
boolean
    Choices:
  • no ←
  • yes
Flag to add whitelisting FW rule during realization.
ha_mode
string
    Choices:
  • ACTIVE_STANDBY
  • ACTIVE_ACTIVE ←
High-availability Mode for Tier-0
hostname
string / required
Deployed NSX manager hostname.
id
string
Tier-0 ID
internal_transit_subnets
list
Default:
"no"
Internal transit subnets in CIDR format. Specify subnets that are used to assign addresses to logical links connecting service routers and distributed routers. Only IPv4 addresses are supported. When not specified, subnet 169.254.0.0/ 24 is assigned by default in ACTIVE_ACTIVE HA mode or 169.254.0.0/28 in ACTIVE_STANDBY mode.
intersite_config
dictionary
Inter site routing configuration when the gateway is streched.
fallback_sites
list
Fallback site to be used as new primary site on current primary site failure. Disaster recovery must be initiated via API/UI. Fallback site configuration is supported only for T0 gateway. T1 gateway will follow T0 gateway's primary site during disaster recovery
intersite_transit_subnet
string
Default:
"169.254.32.0/20"
Transit subnet in CIDR format
IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured
last_admin_active_epoch
integer
Epoch of last time admin changing active LocaleServices
Epoch(in seconds) is auto updated based on system current timestamp when primary locale service is updated. It is used for resolving conflict during site failover. If system clock not in sync then User can optionally override this. New value must be higher than the current value.
primary_site_path
string
Primary egress site for gateway.
Primary egress site for gateway. T0/T1 gateway in Active/Standby mode supports stateful services on primary site. In this mode primary site must be set if gateway is stretched to more than one site. For T0 gateway in Active/Active primary site is optional field. If set then secondary site prefers routes learned from primary over locally learned routes. This field is not applicable for T1 gateway with no services
ipv6_dad_profile_display_name
string
Same as ipv6_dad_profile_id. Either one can be specified. If both are specified, ipv6_dad_profile_id takes precedence.
ipv6_dad_profile_id
string
IPv6 DRA profile configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured. Related attribute ipv6_ndra_profile_id.
ipv6_ndra_profile_display_name
string
Same as ipv6_ndra_profile_id. Either one can be specified. If both are specified, ipv6_ndra_profile_id takes precedence.
ipv6_ndra_profile_id
string
IPv6 NDRA profile configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured. Related attribute ipv6_dad_profile_id.
locale_services
list
This is a list of Locale Services that need to be created, updated, or deleted
achieve_subresource_state_if_del_parent
boolean
    Choices:
  • no ←
  • yes
Can be used to achieve the state of subresources even if the parent(base) resource's state is absent.
Can be specified for each subresource.
BGP
dictionary
Specify the BGP spec in this section
ecmp
boolean
    Choices:
  • no
  • yes ←
Flag to enable ECMP.
enabled
boolean
    Choices:
  • no
  • yes ←
Flag to enable BGP configuration. Disabling will stop feature and BGP peering.
graceful_restart_config
dictionary
Configuration field to hold BGP Restart mode and timer.
mode
string
    Choices:
  • DISABLE
  • GR_AND_HELPER
  • HELPER_ONLY ←
BGP Graceful Restart Configuration Mode
If mode is DISABLE, then graceful restart and helper modes are disabled.
If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled.
If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart.
GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.
timer
dictionary
BGP Graceful Restart Timer
restart_timer
integer
Default:
180
BGP Graceful Restart Timer
Maximum time taken (in seconds) for a BGP session to be established after a restart. This can be used to speed up routing convergence by its peer in case the BGP speaker does not come back up after a restart. If the session is not re-established within this timer, the receiving speaker will delete all the stale routes from that peer. Min 1 and Max 3600
stale_route_timer
integer
Default:
600
BGP Stale Route Timer
Maximum time (in seconds) before stale routes are removed from the RIB (Routing Information Base) when BGP restarts. Min 1 and Max 3600
inter_sr_ibgp
boolean
    Choices:
  • no
  • yes
Flag to enable inter SR IBGP configuration. When not specified, inter SR IBGP is automatically enabled if Tier-0 is created in ACTIVE_ACTIVE ha_mode.
local_as_num
string / required
BGP AS number in ASPLAIN/ASDOT Format.
Specify BGP AS number for Tier-0 to advertize to BGP peers. AS number can be specified in ASPLAIN (e.g., "65546") or ASDOT (e.g., "1.10") format. Empty string disables BGP feature.
multipath_relax
boolean
    Choices:
  • no
  • yes ←
Flag to enable BGP multipath relax option.
neighbors
list
Specify the BGP neighbors in this section that need to be created, updated, or deleted
address
string / required
Neighbor IP Address
allow_as_in
boolean
    Choices:
  • no ←
  • yes
Flag to enable allowas_in option for BGP neighbor
bfd
dictionary
BFD configuration for failure detection
BFD is enabled with default values when not configured
enabled
boolean
    Choices:
  • no
  • yes
Flag to enable BFD cofiguration
interval
integer
Default:
1000
Time interval between heartbeat packets in milliseconds. Min 300 and Max 60000
multiple
integer
Default:
3
Declare dead multiple.
Number of times heartbeat packet is missed before BFD declares the neighbor is down. Min 2 and Max 16
graceful_restart_mode
string
    Choices:
  • DISABLE
  • GR_AND_HELPER
  • HELPER_ONLY
BGP Graceful Restart Configuration Mode
If mode is DISABLE, then graceful restart and helper modes are disabled.
If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled.
If mode is HELPER_ONLY, then helper mode is enabled. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart.
GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.
hold_down_time
integer
Default:
180
Wait time in seconds before declaring peer dead. Min 1 and Max 65535
keep_alive_time
integer
Default:
60
Interval between keep alive messages sent to peer. Min 1 and Max 65535.
maximum_hop_limit
integer
Default:
1
Maximum number of hops allowed to reach BGP neighbor. Min 1 and Max 255
password
string
Password for BGP Neighbor authentication. Empty string ("") clears existing password.
remote_as_num
string / required
4 Byte ASN of the neighbor in ASPLAIN Format
route_filtering
list / elements=dictionary
Enable address families and route filtering in each direction
address_family
string
    Choices:
  • IPV4
  • IPV6
  • VPN
enabled
boolean
    Choices:
  • no
  • yes ←
Flag to enable address family
in_route_filters
list
Prefix-list or route map path for IN direction
Specify path of prefix-list or route map to filter routes for IN direction.
out_route_filters
list
Prefix-list or route map path for OUT direction
Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied.
source_addresses
list
Source IP Addresses for BGP peering
Source addresses should belong to Tier0 external or loopback interface IP Addresses. BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1.
route_aggregations
dictionary
List of routes to be aggregated
prefix
string / required
CIDR of aggregate address
summary_only
boolean
    Choices:
  • no
  • yes ←
Send only summarized route.
Summarization reduces number of routes advertised by representing multiple related routes with prefix property
create_or_update_subresource_first
boolean
    Choices:
  • no ←
  • yes
Can be used to create subresources first.
Can be specified for each subresource.
delete_subresource_first
boolean
    Choices:
  • no
  • yes ←
Can be used to delete subresources first.
Can be specified for each subresource.
description
string
Tier-0 Locale Service description.
display_name
string
Tier-0 Locale Service display name.
Either this or id must be specified. If both are specified, id takes precedence
do_wait_till_create
boolean
    Choices:
  • no ←
  • yes
Can be used to wait for the realization of subresource before the request to create the next resource is sent to the Manager.
Can be specified for each subresource.
edge_cluster_info
dictionary
Used to create path to edge cluster. Auto-assigned if associated enforcement-point has only one edge cluster.
edge_cluster_display_name
string
display name of the edge cluster.
Either this or edge_cluster_id must be specified. If both are specified, edge_cluster_id takes precedence
edge_cluster_id
string
ID of the edge cluster
enforcementpoint_id
string
Default:
"default"
enforcementpoint_id where edge cluster is located
site_id
string
Default:
"default"
site_id where edge cluster is located
ha_vip_configs
list / elements=dictionary
Array of HA VIP Config.
This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed.
enabled
boolean
    Choices:
  • no
  • yes ←
Flag to enable this HA VIP config.
external_interface_paths
list
Policy paths to Tier0 external interfaces for providing redundancy
Policy paths to Tier0 external interfaces which are to be paired to provide redundancy. Floating IP will be owned by one of these interfaces depending upon which edge node is Active.
vip_subnets
list
VIP floating IP address subnets
Array of IP address subnets which will be used as floating IP addresses.
ip_addresses
list / required
IP addresses assigned to interface
prefix_len
integer / required
Subnet prefix length
id
string
Tier-0 Locale Service ID.
interfaces
list
Specify the interfaces associated with the Gateway in this section that need to be created, updated, or deleted
access_vlan_id
integer
Vlan id
achieve_subresource_state_if_del_parent
boolean
    Choices:
  • no ←
  • yes
Can be used to achieve the state of subresources even if the parent(base) resource's state is absent.
Can be specified for each subresource.
create_or_update_subresource_first
boolean
    Choices:
  • no ←
  • yes
Can be used to create subresources first.
Can be specified for each subresource.
delete_subresource_first
boolean
    Choices:
  • no
  • yes ←
Can be used to delete subresources first.
Can be specified for each subresource.
description
string
Tier-0 Interface description
display_name
string
Tier-0 Interface display name
Either this or id must be specified. If both are specified, id takes precedence.
do_wait_till_create
boolean
    Choices:
  • no ←
  • yes
Can be used to wait for the realization of subresource before the request to create the next resource is sent to the Manager.
Can be specified for each subresource.
edge_node_info
dictionary
Info to create policy path to edge node to handle externalconnectivity.
Required if interface type is EXTERNAL and id != null
edge_cluster_display_name
string
display name of the edge cluster.
either this or edge_cluster_id must be specified. If both are specified, edge_cluster_id takes precedence
edge_cluster_id
string
edge_cluster_id where edge node is located
edge_node_display_name
string
Display name of the edge node.
either this or edge_node_id must be specified. If both are specified, edge_node_id takes precedence.
edge_node_id
string
ID of the edge node
enforcementpoint_id
string
Default:
"default"
enforcementpoint_id where edge node is located
site_id
string
Default:
"default"
site_id where edge node is located
id
string
Tier-0 Interface ID
ipv6_ndra_profile_display_name
string
Same as ipv6_ndra_profile_id. Either one should be specified.
ipv6_ndra_profile_id
string
Configuration IPv6 NDRA profile. Only one NDRA profile can be configured.
mtu
integer
MTU size
Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.
multicast
dictionary
Multicast PIM configuration
enabled
boolean
    Choices:
  • no ←
  • yes
enable/disable PIM configuration
segment_display_name
string
Same as segment_id
Either this or segment_id must be specified. If both are specified, segment_id takes precedence.
segment_id
string
Specify Segment to which this interface is connected to. Required if id is specified.
state
-
    Choices:
  • present
  • absent
State can be either 'present' or 'absent'. 'present' is used to create or update resource. 'absent' is used to delete resource.
Required if segp_id != null
subnets
list
IP address and subnet specification for interface
Specify IP address and network prefix for interface.
Required if id != null.
tags
dictionary
Opaque identifiers meaningful to the API user
scope
string / required
Tag scope.
tag
string / required
Tag value.
type
string
    Choices:
  • EXTERNAL ←
  • LOOPBACK
  • SERVICE
Interface type
urpf_mode
string
    Choices:
  • NONE
  • STRICT ←
Unicast Reverse Path Forwarding mode
preferred_edge_nodes_info
list
Used to create paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE, not applicable otherwise.
edge_cluster_display_name
string
display name of the edge cluster.
either this or edge_cluster_id must be specified. If both are specified, edge_cluster_id takes precedence
edge_cluster_id
string
edge_cluster_id where edge node is located
edge_node_display_name
string
Display name of the edge node.
either this or edge_node_id must be specified. If both are specified, edge_node_id takes precedence
edge_node_id
string
ID of the edge node
enforcementpoint_id
string
Default:
"default"
enforcementpoint_id where edge node is located
site_id
string
Default:
"default"
site_id where edge node is located
route_redistribution_config
dictionary
Configure all route redistribution properties like enable/disable redistributon, redistribution rule and so on.
bgp_enabled
boolean
    Choices:
  • no ←
  • yes
Flag to enable route redistribution.
redistribution_rules
list / elements=dictionary
List of redistribution rules.
name
string
Rule name
route_map_path
string
Route map to be associated with the redistribution rule
route_redistribution_types
list
    Choices:
  • TIER0_STATIC - Redistribute user added static routes.
  • TIER0_CONNECTED - Redistribute all subnets configured on Interfaces and routes related to TIER0_ROUTER_LINK, TIER0_SEGMENT, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT types.
  • TIER1_STATIC - Redistribute all subnets and static routes advertised by Tier-1s.
  • TIER0_EXTERNAL_INTERFACE - Redistribute external interface subnets on Tier-0.
  • TIER0_LOOPBACK_INTERFACE - Redistribute loopback interface subnets on Tier-0.
  • TIER0_SEGMENT - Redistribute subnets configured on Segments connected to Tier-0.
  • TIER0_ROUTER_LINK - Redistribute router link port subnets on Tier-0.
  • TIER0_SERVICE_INTERFACE - Redistribute Tier0 service interface subnets.
  • TIER0_DNS_FORWARDER_IP - Redistribute DNS forwarder subnets.
  • TIER0_IPSEC_LOCAL_IP - Redistribute IPSec subnets.
  • TIER0_NAT - Redistribute NAT IPs owned by Tier-0.
  • TIER0_EVPN_TEP_IP - Redistribute EVPN local endpoint subnets on Tier-0.
  • TIER1_NAT - Redistribute NAT IPs advertised by Tier-1 instances.
  • TIER1_LB_VIP - Redistribute LB VIP IPs advertised by Tier-1 instances.
  • TIER1_LB_SNAT - Redistribute LB SNAT IPs advertised by Tier-1 instances.
  • TIER1_DNS_FORWARDER_IP - Redistribute DNS forwarder subnets on Tier-1 instances.
  • TIER1_CONNECTED - Redistribute all subnets configured on Segments and Service Interfaces.
  • TIER1_SERVICE_INTERFACE - Redistribute Tier1 service interface subnets.
  • TIER1_SEGMENT - Redistribute subnets configured on Segments connected to Tier1.
  • TIER1_IPSEC_LOCAL_ENDPOINT - Redistribute IPSec VPN local-endpoint subnets advertised by TIER1.
Tier-0 route redistribution types
route_redistribution_types
list
    Choices:
  • TIER0_STATIC - Redistribute user added static routes.
  • TIER0_CONNECTED - Redistribute all subnets configured on Interfaces and routes related to TIER0_ROUTER_LINK, TIER0_SEGMENT, TIER0_DNS_FORWARDER_IP, TIER0_IPSEC_LOCAL_IP, TIER0_NAT types.
  • TIER1_STATIC - Redistribute all subnets and static routes advertised by Tier-1s.
  • TIER0_EXTERNAL_INTERFACE - Redistribute external interface subnets on Tier-0.
  • TIER0_LOOPBACK_INTERFACE - Redistribute loopback interface subnets on Tier-0.
  • TIER0_SEGMENT - Redistribute subnets configured on Segments connected to Tier-0.
  • TIER0_ROUTER_LINK - Redistribute router link port subnets on Tier-0.
  • TIER0_SERVICE_INTERFACE - Redistribute Tier0 service interface subnets.
  • TIER0_DNS_FORWARDER_IP - Redistribute DNS forwarder subnets.
  • TIER0_IPSEC_LOCAL_IP - Redistribute IPSec subnets.
  • TIER0_NAT - Redistribute NAT IPs owned by Tier-0.
  • TIER0_EVPN_TEP_IP - Redistribute EVPN local endpoint subnets on Tier-0.
  • TIER1_NAT - Redistribute NAT IPs advertised by Tier-1 instances.
  • TIER1_LB_VIP - Redistribute LB VIP IPs advertised by Tier-1 instances.
  • TIER1_LB_SNAT - Redistribute LB SNAT IPs advertised by Tier-1 instances.
  • TIER1_DNS_FORWARDER_IP - Redistribute DNS forwarder subnets on Tier-1 instances.
  • TIER1_CONNECTED - Redistribute all subnets configured on Segments and Service Interfaces.
  • TIER1_SERVICE_INTERFACE - Redistribute Tier1 service interface subnets.
  • TIER1_SEGMENT - Redistribute subnets configured on Segments connected to Tier1.
  • TIER1_IPSEC_LOCAL_ENDPOINT - Redistribute IPSec VPN local-endpoint subnets advertised by TIER1.
Enable redistribution of different types of routes on Tier-0.
This property is only valid for locale-service under Tier-0.
This property is deprecated, please use "route_redistribution_config" property to configure redistribution rules.
state
-
    Choices:
  • present
  • absent
State can be either 'present' or 'absent'. 'present' is used to create or update resource. 'absent' is used to delete resource
Required if id is specified.
tags
dictionary
Opaque identifiers meaningful to the API user
scope
string / required
Tag scope.
tag
string / required
Tag value.
nsx_cert_path
string
Path to the certificate created for the Principal Identity using which the CRUD operations should be performed
nsx_key_path
string
Path to the certificate key created for the Principal Identity using which the CRUD operations should be performed
Must be specified if nsx_cert_path is specified
password
string
The password to authenticate with the NSX manager.
Must be specified if username is specified
rd_admin_field
string
Route distinguisher administrator address
If you are using EVPN service, then route distinguisher administrator address should be defined if you need auto generation of route distinguisher on your VRF configuration
request_headers
dictionary
HTTP request headers to be sent to the host while making any request
state
- / required
    Choices:
  • present
  • absent
State can be either 'present' or 'absent'. 'present' is used to create or update resource. 'absent' is used to delete resource.
static_routes
list
This is a list of Static Routes that need to be created, updated, or deleted
achieve_subresource_state_if_del_parent
boolean
    Choices:
  • no ←
  • yes
Can be used to achieve the state of subresources even if the parent(base) resource's state is absent.
Can be specified for each subresource.
description
string
Tier-0 Static Route description.
display_name
string
Tier-0 Static Route display name.
Either this or id must be specified. If both are specified, id takes precedence.
do_wait_till_create
boolean
    Choices:
  • no ←
  • yes
Can be used to wait for the realization of subresource before the request to create the next resource is sent to the Manager
id
string
Tier-0 Static Route ID.
network
string / required
Network address in CIDR format
next_hops
list / elements=dictionary
Next hop routes for network
admin_distance
integer
Default:
1
Cost associated with next hop route
state
-
    Choices:
  • present
  • absent
State can be either 'present' or 'absent'. 'present' is used to create or update resource. 'absent' is used to delete resource.
Must be specified in order to modify the resource
tags
dictionary
Opaque identifiers meaningful to the API user
scope
string / required
Tag scope.
tag
string / required
Tag value.
tags
dictionary
Opaque identifiers meaningful to the API user.
scope
string / required
Tag scope.
tag
string / required
Tag value.
transit_subnets
list
Transit subnets in CIDR format. Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 addresses are supported. When not specified, subnet 100.64.0.0/16 is configured by default.
username
string
The username to authenticate with the NSX manager.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Enable server certificate verification.
vrf_config
dictionary
VRF config, required for VRF Tier0
description
string
Description of this resource
display_name
string
Identifier to use when displaying entity in logs or GUI
Defaults to id if not set
Error if both not specified
evpn_transit_vni
integer
L3 VNI associated with the VRF for overlay traffic.
VNI must be unique and belong to configured VNI pool.
id
string
Unique identifier of this resource
Defaults to display_name if not set
Error if both not specified
route_distinguisher
string
Route distinguisher. 'ASN:<>' or 'IPAddress:<>'.
route_targets
list
Route targets
description
string
Description of this resource
display_name
string
Identifier to use when displaying entity in logs or GUI
Defaults to id if not set
Error if both not specified
export_route_targets
list
Export route targets. 'ASN:' or 'IPAddress:<>'
id
string
Unique identifier of this resource
Defaults to display_name if not set
Error if both not specified
import_route_targets
list
Import route targets. 'ASN:' or 'IPAddress:<>'
tags
list
Opaque identifiers meaningful to the API user
scope
string
Tag scope
tag
string
Tag value
tags
list
Opaque identifiers meaningful to the API user
scope
string
Tag scope
tag
string
Tag value
tier0_display_name
string
Default tier0 display name. Cannot be modified after realization. Either this or tier0_id must be specified
tier0_id
string
Default tier0 id. Cannot be modified after realization. Either this or tier0_id must be specified

Examples

- name: create Tier0
  nsxt_policy_tier0:
    hostname: "10.10.10.10"
    nsx_cert_path: /root/com.vmware.nsx.ncp/nsx.crt
    nsx_key_path: /root/com.vmware.nsx.ncp/nsx.key
    validate_certs: False
    display_name: test-tier0-1
    state: present
    ha_mode: "ACTIVE_STANDBY"
    failover_mode: "PREEMPTIVE"
    disable_firewall: True
    force_whitelisting: True
    rd_admin_field: "122.34.12.124"
    tags:
      - scope: "a"
        tag: "b"
    static_routes:
      - state: present
        display_name: test-sr
        network: '12.12.12.0/24'
        next_hops:
          - ip_address: "192.165.1.4"
    bfd_peers:
      - state: present
        display_name: test-peer-1
        peer_address: "192.100.100.5"
        bfd_config_id: test-bfd-config
    locale_services:
      - state: present
        id: "test-t0ls"
        route_redistribution_config:
          redistribution_rules:
            - name: abc
              route_redistribution_types: ["TIER0_STATIC", "TIER0_NAT"]
        edge_cluster_info:
          edge_cluster_id: "7ef91a10-c780-4f48-a279-a5662db4ffa3"
        preferred_edge_nodes_info:
          - edge_cluster_id: "7ef91a10-c780-4f48-a279-a5662db4ffa3"
            edge_node_id: "e10c42dc-db27-11e9-8cd0-000c291af7ee"
        BGP:
          state: present
          local_as_num: '1211'
          inter_sr_ibgp: False
          graceful_restart_config:
          mode: "GR_AND_HELPER"
          timer:
            restart_timer: 12
          route_aggregations:
            - prefix: "10.1.1.0/24"
            - prefix: "11.1.0.0/24"
              summary_only: False
          neighbors:
            - display_name: neigh1
              address: "1.2.3.4"
              remote_as_num: "12"
              state: present
        interfaces:
          - id: "test-t0-t0ls-iface"
            display_name: "test-t0-t0ls-iface"
            state: present
            subnets:
              - ip_addresses: ["35.1.1.1"]
                prefix_len: 24
            segment_id: "test-seg-4"
            edge_node_info:
              edge_cluster_id: "7ef91a10-c780-4f48-a279-a5662db4ffa3"
              edge_node_id: "e10c42dc-db27-11e9-8cd0-000c291af7ee"
            mtu: 1500
            urpf_mode: "NONE"
            multicast:
              enabled: True
            ipv6_ndra_profile_display_name: test
    vrf_config:
      display_name: my-vrf
      id: my-vrf2
      tier0_display_name: node-t0
      tags:
        - scope: scope-tag-1
          tag: value-tag-1
      route_distinguisher: 'ASN:4000'
      evpn_transit_vni: 6000

Status

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

  • This module is maintained by the Ansible Community. [community]

Authors

  • Gautam Verma