Skip to main content

Batch Configure

POST 

/vyos/wwan/batch

Configure a WWAN interface using batch operations.

Basic operations (all versions):

OperationValueDescription
set_interfaceNoCreate interface node
delete_interfaceNoDelete entire interface
set_descriptionYesSet interface description
delete_descriptionNoRemove description
set_addressYesAdd IP address (CIDR, dhcp, or dhcpv6)
delete_addressYesRemove a specific IP address
delete_address_allNoRemove all addresses
set_disableNoAdministratively disable interface
delete_disableNoRe-enable interface
set_disable_link_detectNoDisable link state detection
delete_disable_link_detectNoEnable link state detection
set_connect_on_demandNoConnect when traffic is sent
delete_connect_on_demandNoAlways-on connection
set_mtuYesSet MTU (68-1500)
delete_mtuNoReset MTU to default
set_vrfYesAssign to VRF instance
delete_vrfNoRemove VRF assignment
set_redirectYesRedirect incoming packets to interface
delete_redirectNoRemove redirect

APN / Authentication: | set_apn | Yes | Set Access Point Name | | delete_apn | No | Remove APN | | set_auth_username | Yes | Set APN username | | delete_auth_username | No | Remove username | | set_auth_password | Yes | Set APN password | | delete_auth_password | No | Remove password | | delete_authentication | No | Remove all authentication config |

DHCP options: | set_dhcp_client_id | Yes | DHCP client identifier | | delete_dhcp_client_id | No | Remove client identifier | | set_dhcp_default_route_distance | Yes | Default route distance (1-255) | | delete_dhcp_default_route_distance | No | Remove distance override | | set_dhcp_host_name | Yes | Override hostname sent to DHCP server | | delete_dhcp_host_name | No | Remove hostname override | | set_dhcp_mtu | Yes | Override MTU via DHCP | | delete_dhcp_mtu | No | Remove MTU override | | set_dhcp_no_default_route | No | Do not install default route from DHCP | | delete_dhcp_no_default_route | No | Allow default route from DHCP | | set_dhcp_reject | Yes | Reject leases from IP/subnet | | delete_dhcp_reject | Yes | Remove specific reject entry | | delete_dhcp_reject_all | No | Remove all reject entries | | set_dhcp_user_class | Yes | DHCP user class identifier | | delete_dhcp_user_class | No | Remove user class | | set_dhcp_vendor_class_id | Yes | DHCP vendor class identifier | | delete_dhcp_vendor_class_id | No | Remove vendor class | | delete_dhcp_options | No | Remove all DHCP options |

DHCPv6 options: | set_dhcpv6_duid | Yes | DHCPv6 DUID | | delete_dhcpv6_duid | No | Remove DUID | | set_dhcpv6_no_release | No | Do not send Release on client exit | | delete_dhcpv6_no_release | No | Send Release on exit | | set_dhcpv6_parameters_only | No | Request parameters only, no address | | delete_dhcpv6_parameters_only | No | Request address and parameters | | set_dhcpv6_rapid_commit | No | Enable rapid commit (2-message exchange) | | delete_dhcpv6_rapid_commit | No | Disable rapid commit | | set_dhcpv6_temporary | No | Request temporary address | | delete_dhcpv6_temporary | No | Do not request temporary address | | set_dhcpv6_pd_instance | Yes | Create prefix delegation instance (e.g. "0") | | delete_dhcpv6_pd_instance | Yes | Delete prefix delegation instance | | delete_dhcpv6_pd_all | No | Remove all prefix delegations | | delete_dhcpv6_options | No | Remove all DHCPv6 options |

Mirror: | set_mirror_ingress | Yes | Mirror ingress traffic to destination interface | | delete_mirror_ingress | No | Remove ingress mirror | | set_mirror_egress | Yes | Mirror egress traffic to destination interface | | delete_mirror_egress | No | Remove egress mirror |

IP settings: | set_ip_adjust_mss | Yes | Clamp TCP MSS to PMTU | | delete_ip_adjust_mss | No | Remove MSS clamping | | set_ip_arp_cache_timeout | Yes | ARP cache timeout (seconds) | | delete_ip_arp_cache_timeout | No | Reset ARP cache timeout | | set_ip_disable_arp_filter | No | Disable ARP filter | | delete_ip_disable_arp_filter | No | Enable ARP filter | | set_ip_disable_forwarding | No | Disable IPv4 forwarding | | delete_ip_disable_forwarding | No | Enable IPv4 forwarding | | set_ip_enable_arp_accept | No | Enable ARP accept | | delete_ip_enable_arp_accept | No | Disable ARP accept | | set_ip_enable_arp_announce | No | Enable ARP announce | | delete_ip_enable_arp_announce | No | Disable ARP announce | | set_ip_enable_arp_ignore | No | Enable ARP ignore | | delete_ip_enable_arp_ignore | No | Disable ARP ignore | | set_ip_enable_directed_broadcast | No | Enable directed broadcast | | delete_ip_enable_directed_broadcast | No | Disable directed broadcast | | set_ip_enable_proxy_arp | No | Enable proxy ARP | | delete_ip_enable_proxy_arp | No | Disable proxy ARP | | set_ip_proxy_arp_pvlan | No | Enable proxy ARP PVLAN | | delete_ip_proxy_arp_pvlan | No | Disable proxy ARP PVLAN | | set_ip_source_validation | Yes | Source validation (strict/loose/disable) | | delete_ip_source_validation | No | Remove source validation |

IPv6 settings: | set_ipv6_accept_dad | Yes | DAD mode (0=disable, 1=enable, 2=enable+no-link-local-if-duplicate) | | delete_ipv6_accept_dad | No | Reset DAD | | set_ipv6_address_autoconf | No | Enable SLAAC | | delete_ipv6_address_autoconf | No | Disable SLAAC | | set_ipv6_address_eui64 | Yes | EUI-64 prefix | | delete_ipv6_address_eui64 | Yes | Remove specific EUI-64 prefix | | delete_ipv6_address_eui64_all | No | Remove all EUI-64 prefixes | | set_ipv6_address_no_default_link_local | No | Disable default link-local address | | delete_ipv6_address_no_default_link_local | No | Enable default link-local address | | set_ipv6_adjust_mss | Yes | Clamp TCP MSS to PMTU (IPv6) | | delete_ipv6_adjust_mss | No | Remove IPv6 MSS clamping | | set_ipv6_base_reachable_time | Yes | Neighbor base reachable time | | delete_ipv6_base_reachable_time | No | Reset base reachable time | | set_ipv6_disable_forwarding | No | Disable IPv6 forwarding | | delete_ipv6_disable_forwarding | No | Enable IPv6 forwarding | | set_ipv6_dup_addr_detect_transmits | Yes | DAD transmit count | | delete_ipv6_dup_addr_detect_transmits | No | Reset DAD transmit count | | set_ipv6_source_validation | Yes | IPv6 source validation (strict/loose/disable) | | delete_ipv6_source_validation | No | Remove IPv6 source validation |

VyOS 1.5 only: | set_dhcpv6_no_request_dns | No | Do not request DNS servers via DHCPv6 | | delete_dhcpv6_no_request_dns | No | Request DNS servers via DHCPv6 | | set_dhcpv6_no_request_domain_name | No | Do not request domain name via DHCPv6 | | delete_dhcpv6_no_request_domain_name | No | Request domain name via DHCPv6 | | set_ipv6_address_interface_identifier | Yes | SLAAC interface identifier (::h:h:h:h) | | delete_ipv6_address_interface_identifier | No | Remove interface identifier |

Request

Responses

Successful Response