Transport Management VPN Feature
Catalyst SD-WANConfigure out of band management VPN (VPN 512) and its’ settings.
Diagram
Section titled “Diagram”Diagram
Section titled “Diagram”Classes
Section titled “Classes”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| feature_ | Class | feature_ | No |
feature_profiles (sdwan)
Section titled “feature_profiles (sdwan)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| transport_ | List | transport_ | No |
transport_profiles (sdwan.feature_profiles)
Section titled “transport_profiles (sdwan.feature_profiles)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| management_vpn | Class | management_vpn | No |
management_vpn (sdwan.feature_profiles.transport_profiles)
Section titled “management_vpn (sdwan.feature_profiles.transport_profiles)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | No | management_vpn |
| description | String | No | ||
| ethernet_ | List | ethernet_ | No | |
| host_mappings | List | host_mappings | No | |
| ipv4_ | IP | No | ||
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | IP | No | ||
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | List | ipv4_ | No | |
| ipv6_ | IP | No | ||
| ipv6_ | String | Regex: ^[. | No | |
| ipv6_ | IP | No | ||
| ipv6_ | String | Regex: ^[. | No | |
| ipv6_ | List | ipv6_ | No | |
| vpn_description | String | min: 0, max: 244 | No | |
| vpn_ | String | Regex: ^[. | No |
management_vpn (sdwan.feature_profiles.transport_profiles)
Section titled “management_vpn (sdwan.feature_profiles.transport_profiles)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | No | management_vpn |
| description | String | No | ||
| ethernet_ | List | ethernet_ | No | |
| host_mappings | List | host_mappings | No | |
| ipv4_ | IP | No | ||
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | IP | No | ||
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | List | ipv4_ | No | |
| ipv6_ | IP | No | ||
| ipv6_ | String | Regex: ^[. | No | |
| ipv6_ | IP | No | ||
| ipv6_ | String | Regex: ^[. | No | |
| ipv6_ | List | ipv6_ | No | |
| vpn_description | String | min: 0, max: 244 | No | |
| vpn_ | String | Regex: ^[. | No |
ethernet_interfaces (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “ethernet_interfaces (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| arp_entries | List | arp_entries | No | |
| arp_timeout | Integer | min: 0, max: 2147483 | No | |
| arp_ | String | Regex: ^[. | No | |
| auto_ | Boolean | true, false | No | |
| auto_ | String | Regex: ^[. | No | |
| autonegotiate | Boolean | true, false | No | |
| autonegotiate_ | String | Regex: ^[. | No | |
| duplex | Choice | full, half, auto | No | |
| duplex_variable | String | Regex: ^[. | No | |
| icmp_ | Boolean | true, false | No | |
| icmp_ | String | Regex: ^[. | No | |
| interface_ | String | max: 200 | No | |
| interface_ | String | Regex: ^[. | No | |
| interface_mtu | Integer | min: 1500, max: 9216 | No | |
| interface_ | String | Regex: ^[. | No | |
| interface_name | String | Regex: (ATM| | No | |
| interface_ | String | Regex: ^[. | No | |
| ip_ | Boolean | true, false | No | |
| ip_ | String | Regex: ^[. | No | |
| ip_mtu | Integer | min: 576, max: 9216 | No | |
| ip_mtu_variable | String | Regex: ^[. | No | |
| iperf_server | String | No | ||
| iperf_ | String | Regex: ^[. | No | |
| ipv4_address | IP | No | ||
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | Choice | dynamic, static | No | |
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | List | IP | No | |
| ipv4_ | String | Regex: ^[^"~`$&+, | No | |
| ipv4_ | List | ipv4_ | No | |
| ipv4_ | Choice | 255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0 | No | |
| ipv4_ | String | Regex: ^[. | No | |
| ipv6_address | IP | No | ||
| ipv6_ | String | Regex: ^[. | No | |
| ipv6_ | Choice | dynamic, static | No | |
| ipv6_ | String | Regex: ^[. | No | |
| load_interval | Integer | min: 30, max: 600 | No | |
| load_ | String | Regex: ^[. | No | |
| mac_address | String | Regex: ^(([a-fA-F\d] | No | |
| mac_ | String | Regex: ^[^"~`$&+, | No | |
| media_type | Choice | auto-select, rj45, sfp | No | |
| media_ | String | Regex: ^[. | No | |
| shutdown | Boolean | true, false | No | |
| shutdown_ | String | Regex: ^[. | No | |
| speed | Choice | 10, 100, 1000, 2500, 10000 | No | |
| speed_variable | String | Regex: ^[. | No | |
| tcp_mss | Integer | min: 500, max: 1460 | No | |
| tcp_ | String | Regex: ^[. | No |
ethernet_interfaces (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “ethernet_interfaces (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| arp_entries | List | arp_entries | No | |
| arp_timeout | Integer | min: 0, max: 2147483 | No | |
| arp_ | String | Regex: ^[. | No | |
| auto_ | Boolean | true, false | No | |
| auto_ | String | Regex: ^[. | No | |
| autonegotiate | Boolean | true, false | No | |
| autonegotiate_ | String | Regex: ^[. | No | |
| duplex | Choice | full, half, auto | No | |
| duplex_variable | String | Regex: ^[. | No | |
| icmp_ | Boolean | true, false | No | |
| icmp_ | String | Regex: ^[. | No | |
| interface_ | String | max: 200 | No | |
| interface_ | String | Regex: ^[. | No | |
| interface_mtu | Integer | min: 1500, max: 9216 | No | |
| interface_ | String | Regex: ^[. | No | |
| interface_name | String | Regex: (ATM| | No | |
| interface_ | String | Regex: ^[. | No | |
| ip_ | Boolean | true, false | No | |
| ip_ | String | Regex: ^[. | No | |
| ip_mtu | Integer | min: 576, max: 9216 | No | |
| ip_mtu_variable | String | Regex: ^[. | No | |
| iperf_server | String | No | ||
| iperf_ | String | Regex: ^[. | No | |
| ipv4_address | IP | No | ||
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | Choice | dynamic, static | No | static |
| ipv4_ | Integer | min: 1, max: 255 | No | |
| ipv4_ | String | Regex: ^[. | No | |
| ipv4_ | List | IP | No | |
| ipv4_ | String | Regex: ^[^"~`$&+, | No | |
| ipv4_ | List | ipv4_ | No | |
| ipv4_ | Choice | 255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0 | No | |
| ipv4_ | String | Regex: ^[. | No | |
| ipv6_ | Choice | dynamic, static, none | No | none |
| ipv6_address | IP | No | ||
| ipv6_ | String | Regex: ^[. | No | |
| load_interval | Integer | min: 30, max: 600 | No | |
| load_ | String | Regex: ^[. | No | |
| mac_address | String | Regex: ^(([a-fA-F\d] | No | |
| mac_ | String | Regex: ^[^"~`$&+, | No | |
| media_type | Choice | auto-select, rj45, sfp | No | |
| media_ | String | Regex: ^[. | No | |
| shutdown | Boolean | true, false | No | |
| shutdown_ | String | Regex: ^[. | No | |
| speed | Choice | 10, 100, 1000, 2500, 10000 | No | |
| speed_variable | String | Regex: ^[. | No | |
| tcp_mss | Integer | min: 500, max: 1460 | No | |
| tcp_ | String | Regex: ^[. | No |
host_mappings (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “host_mappings (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| hostname | String | min: 1, max: 32 | No | |
| hostname_ | String | Regex: ^[. | No | |
| ips | List | IP | No | |
| ips_variable | String | Regex: ^[. | No |
host_mappings (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “host_mappings (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| hostname | String | min: 1, max: 32 | No | |
| hostname_ | String | Regex: ^[. | No | |
| ips | List | IP | No | |
| ips_variable | String | Regex: ^[. | No |
ipv4_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “ipv4_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| administrative_ | Integer | min: 1, max: 255 | No | |
| administrative_ | String | Regex: ^[. | No | |
| gateway | Choice | nexthop, dhcp, null0 | No | nexthop |
| network_address | IP | No | ||
| network_ | String | Regex: ^[. | No | |
| next_hops | List | next_hops | No | |
| subnet_mask | Choice | 255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0 | No | |
| subnet_ | String | Regex: ^[. | No |
ipv4_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “ipv4_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| administrative_ | Integer | min: 1, max: 255 | No | |
| administrative_ | String | Regex: ^[. | No | |
| gateway | Choice | nexthop, dhcp, null0 | No | nexthop |
| network_address | IP | No | ||
| network_ | String | Regex: ^[. | No | |
| next_hops | List | next_hops | No | |
| subnet_mask | Choice | 255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0 | No | |
| subnet_ | String | Regex: ^[. | No |
ipv6_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “ipv6_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| gateway | Choice | nexthop, nat, null0 | No | nexthop |
| nat | Choice | NAT64, NAT66 | No | |
| next_hops | List | next_hops | No | |
| prefix | String | Regex: ((^\s*((([0-9A-Fa-f] | No | |
| prefix_variable | String | Regex: ^[. | No |
ipv6_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)
Section titled “ipv6_static_routes (sdwan.feature_profiles.transport_profiles.management_vpn)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| gateway | Choice | nexthop, nat, null0 | No | nexthop |
| nat | Choice | nat64, nat66 | No | |
| next_hops | List | next_hops | No | |
| prefix | String | Regex: ((^\s*((([0-9A-Fa-f] | No | |
| prefix_variable | String | Regex: ^[. | No |
arp_entries (sdwan.feature_profiles.transport_profiles.management_vpn.ethernet_interfaces)
Section titled “arp_entries (sdwan.feature_profiles.transport_profiles.management_vpn.ethernet_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ip_address | IP | No | ||
| ip_ | String | Regex: ^[^"~`$&+, | No | |
| mac_address | String | Regex: ^(([a-fA-F\d] | No | |
| mac_ | String | Regex: ^[^"~`$&+, | No |
ipv4_secondary_addresses (sdwan.feature_profiles.transport_profiles.management_vpn.ethernet_interfaces)
Section titled “ipv4_secondary_addresses (sdwan.feature_profiles.transport_profiles.management_vpn.ethernet_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | IP | No | ||
| address_ | String | Regex: ^[. | No | |
| subnet_mask | Choice | 255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0 | No | |
| subnet_ | String | Regex: ^[. | No |
ipv4_secondary_addresses (sdwan.feature_profiles.transport_profiles.management_vpn.ethernet_interfaces)
Section titled “ipv4_secondary_addresses (sdwan.feature_profiles.transport_profiles.management_vpn.ethernet_interfaces)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | IP | No | ||
| address_ | String | Regex: ^[. | No | |
| subnet_mask | Choice | 255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0 | No | |
| subnet_ | String | Regex: ^[. | No |
next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv4_static_routes)
Section titled “next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv4_static_routes)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | IP | No | ||
| address_ | String | Regex: ^[. | No | |
| administrative_ | Integer | min: 1, max: 255 | No | |
| administrative_ | String | Regex: ^[. | No |
next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv4_static_routes)
Section titled “next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv4_static_routes)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | IP | No | ||
| address_ | String | Regex: ^[. | No | |
| administrative_ | Integer | min: 1, max: 255 | No | |
| administrative_ | String | Regex: ^[. | No |
next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv6_static_routes)
Section titled “next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv6_static_routes)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | IP | No | ||
| address_ | String | Regex: ^[. | No | |
| administrative_ | Integer | min: 1, max: 255 | No | |
| administrative_ | String | Regex: ^[. | No |
next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv6_static_routes)
Section titled “next_hops (sdwan.feature_profiles.transport_profiles.management_vpn.ipv6_static_routes)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| address | IP | No | ||
| address_ | String | Regex: ^[. | No | |
| administrative_ | Integer | min: 1, max: 255 | No | |
| administrative_ | String | Regex: ^[. | No |
Examples
Section titled “Examples”Example-1: The example below demonstrates how to configure the management_vpn feature within a transport profile. It sets DNS addresses as global values, meaning they will be the same for all devices attached to a configuration group that contains this profile. Additionally, it includes one IPv4 static default route, where the next hop is defined as a variable. The value for this variable will be provided when a device is attached to a configuration group that contains this profile.
sdwan: feature_profiles: transport_profiles: - name: transport1 management_vpn: name: management_vpn ipv4_primary_dns_address: 1.1.1.1 ipv4_secondary_dns_address: 1.0.0.1 ipv4_static_routes: - network_address: 0.0.0.0 subnet_mask: 0.0.0.0 next_hops: - address_variable: vpn512_default_gateway