Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ethernet Interfaces - Terraform documentation #260

Open
Tracked by #231
kklimonda-cl opened this issue Dec 16, 2024 · 0 comments
Open
Tracked by #231

Ethernet Interfaces - Terraform documentation #260

kklimonda-cl opened this issue Dec 16, 2024 · 0 comments
Assignees
Labels
component/docs Improvements or additions to documentation resources/panos_ethernet_interface

Comments

@kklimonda-cl
Copy link
Contributor

kklimonda-cl commented Dec 16, 2024

panos_ethernet_interface (Resource)

Schema

Required

Optional

Nested Schema for location

Optional:

Nested Schema for location.ngfw

Optional:

  • ngfw_device (String) The NGFW device

Nested Schema for location.template

Required:

  • vsys (String)

Optional:

  • name (String) Specific Panorama template
  • ngfw_device (String) The NGFW device
  • panorama_device (String) Specific Panorama device

Nested Schema for location.template_stack

Optional:

  • name (String) Specific Panorama template stack
  • ngfw_device (String) The NGFW device
  • panorama_device (String) Specific Panorama device

Nested Schema for decrypt_mirror

Nested Schema for ha

Nested Schema for lacp

Optional:

  • port_priority (Number) port priority in LACP

Nested Schema for layer2

Optional:

Nested Schema for layer2.lldp

Optional:

Nested Schema for layer2.lldp.high_availability

Optional:

  • passive_pre_negotiation (Boolean) Enable LLDP pre-negotiation in HA passive state

Nested Schema for layer3

Optional:

Nested Schema for layer3.adjust_tcp_mss

Optional:

  • enable (Boolean) Set if TCP MSS value should be reduced based on mtu
  • ipv4_mss_adjustment (Number) IPv4 MSS adjustment size (in bytes)
  • ipv6_mss_adjustment (Number) IPv6 MSS adjustment size (in bytes)

Nested Schema for layer3.arp

Required:

  • name (String)

Optional:

  • hw_address (String) MAC address (format xx:xx:xx:xx:xx:xx)

Nested Schema for layer3.bonjour

Optional:

  • enable (Boolean) Set to support Bonjour service
  • group_id (Number) default 0: NO-Group
  • ttl_check (Boolean) Set to check and update TTL

Nested Schema for layer3.ddns_config

Optional:

  • ddns_cert_profile (String)
  • ddns_enabled (Boolean)
  • ddns_hostname (String) ddns hostname variable or real address
  • ddns_ip (List of String)
  • ddns_ipv6 (List of String)
  • ddns_update_interval (Number)
  • ddns_vendor (String) Vendor and product type
  • ddns_vendor_config (Attributes List) (see below for nested schema)

Nested Schema for layer3.ddns_config.ddns_vendor_config

Required:

  • name (String)

Optional:

  • value (String)

Nested Schema for layer3.dhcp_client

Optional:

  • create_default_route (Boolean) Automatically create default route pointing to default gateway provided by server
  • default_route_metric (Number) Metric of the default route created
  • enable (Boolean)
  • send_hostname (Attributes) (see below for nested schema)

Nested Schema for layer3.dhcp_client.send_hostname

Optional:

  • enable (Boolean)
  • hostname (String) Set Interface Hostname

Nested Schema for layer3.ips

Required:

  • name (String)

Optional:

  • sdwan_gateway (String) Gateway IPv4 Address

Nested Schema for layer3.ipv6

Optional:

Nested Schema for layer3.ipv6.addresses

Required:

  • name (String)

Optional:

Nested Schema for layer3.ipv6.addresses.advertise

Optional:

  • auto_config_flag (Boolean) Set the Auto Address Configuration Flag (A-bit) of the prefix in Router Advertisement messages
  • enable (Boolean) enable advertising this prefix in router advertisements
  • onlink_flag (Boolean) Set the On-Link Flag (L-bit) of the prefix in Router Advertisement messages
  • preferred_lifetime (String) Preferred Lifetime (in seconds) of the prefix advertised in Router Advertisement messages
  • valid_lifetime (String) Valid Lifetime (in seconds) of the prefix advertised in Router Advertisement messages

Nested Schema for layer3.ipv6.addresses.anycast

Nested Schema for layer3.ipv6.addresses.prefix

Nested Schema for layer3.ipv6.dhcp_client

Optional:

  • accept_ra_route (Boolean) Accept Router Advertised Default Route
  • default_route_metric (Number) Metric of the default route created
  • enable (Boolean) Enable DHCPv6 Client
  • neighbor_discovery (Attributes) (see below for nested schema)
  • preference (String) Select Low/Medium/High
  • prefix_delegation (Attributes) (see below for nested schema)
  • v6_options (Attributes) (see below for nested schema)

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery

Optional:

  • dad_attempts (Number) Number of consecutive neighbor solicitation messages sent for duplicate address detection
  • dns_server (Attributes) (see below for nested schema)
  • dns_suffix (Attributes) (see below for nested schema)
  • enable_dad (Boolean) Enable Duplicate ADdress Detection (DAD)
  • enable_ndp_monitor (Boolean) Enable NDP Monitoring
  • neighbor (Attributes List) Static entries in neighbor cache (see below for nested schema)
  • ns_interval (Number) Interval (in seconds) between consecutive neighbor solicitation messages
  • reachable_time (Number) Time (in seconds) that the Reachable status for a neighbor can be maintained

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_server

Optional:

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_server.source

Optional:

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_server.source.dhcpv6

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_server.source.manual

Optional:

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_server.source.manual.server

Required:

  • name (String)

Optional:

  • lifetime (Number) (4-3600) Lifetime in Seconds

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_suffix

Optional:

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_suffix.source

Optional:

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_suffix.source.dhcpv6

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_suffix.source.manual

Optional:

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.dns_suffix.source.manual.suffix

Required:

  • name (String)

Optional:

  • lifetime (Number) (4-3600) lifetime in seconds

Nested Schema for layer3.ipv6.dhcp_client.neighbor_discovery.neighbor

Required:

  • name (String)

Optional:

  • hw_address (String) MAC address (format xx:xx:xx:xx:xx:xx)

Nested Schema for layer3.ipv6.dhcp_client.prefix_delegation

Optional:

Nested Schema for layer3.ipv6.dhcp_client.prefix_delegation.enable

Optional:

Nested Schema for layer3.ipv6.dhcp_client.prefix_delegation.enable.no

Nested Schema for layer3.ipv6.dhcp_client.prefix_delegation.enable.yes

Optional:

  • pfx_pool_name (String) Configure unique Prefix Pool Name
  • prefix_len (Number) Hint DHCP Prefix Length (bits)
  • prefix_len_hint (Boolean) Send prefix length hint to server

Nested Schema for layer3.ipv6.dhcp_client.v6_options

Optional:

  • duid_type (String) Select DUID-LLT/DUID-LL
  • enable (Attributes) (see below for nested schema)
  • rapid_commit (Boolean) Enable Rapid Commit
  • support_srvr_reconfig (Boolean) Enable DHCPv6 Server Re-Configuration Support

Nested Schema for layer3.ipv6.dhcp_client.v6_options.enable

Optional:

Nested Schema for layer3.ipv6.dhcp_client.v6_options.enable.no

Nested Schema for layer3.ipv6.dhcp_client.v6_options.enable.yes

Optional:

  • non_temp_addr (Boolean) Request Non-Temporary Address Type
  • temp_addr (Boolean) Request Temporary Address Type

Nested Schema for layer3.ipv6.inherited

Optional:

Nested Schema for layer3.ipv6.inherited.assign_addr

Required:

  • name (String)

Optional:

Nested Schema for layer3.ipv6.inherited.assign_addr.type

Optional:

Nested Schema for layer3.ipv6.inherited.assign_addr.type.gua

Optional:

Nested Schema for layer3.ipv6.inherited.assign_addr.type.gua.advertise

Optional:

  • auto_config_flag (Boolean) Set the Auto Address Configuration Flag (A-bit) of the prefix in Router Advertisement messages
  • enable (Boolean) Enable advertising this prefix in router advertisements
  • onlink_flag (Boolean) Set the On-Link Flag (L-bit) of the prefix in Router Advertisement messages

Nested Schema for layer3.ipv6.inherited.assign_addr.type.gua.pool_type

Optional:

Nested Schema for layer3.ipv6.inherited.assign_addr.type.gua.pool_type.dynamic

Nested Schema for layer3.ipv6.inherited.assign_addr.type.gua.pool_type.dynamic_id

Optional:

  • identifier (Number) Range [0-4095] must be unqiue for this prefix-pool

Nested Schema for layer3.ipv6.inherited.assign_addr.type.ula

Optional:

  • addresses (String) Configure ULA (Unique Local Address)
  • advertise (Attributes) (see below for nested schema)
  • anycast (Boolean) Anycast Address
  • enable_on_interface (Boolean) Configure this address on Interface
  • prefix (Boolean) Use this as prefix to form full address with interface id/EUI-64

Nested Schema for layer3.ipv6.inherited.assign_addr.type.ula.advertise

Optional:

  • auto_config_flag (Boolean) Set the Auto Address Configuration Flag (A-bit) of the prefix in Router Advertisement messages
  • enable (Boolean) enable advertising this prefix in router advertisements
  • onlink_flag (Boolean) Set the On-Link Flag (L-bit) of the prefix in Router Advertisement messages
  • preferred_lifetime (String) Preferred Lifetime (in seconds) of the prefix advertised in Router advertisement messages
  • valid_lifetime (String) Valid Lifetime (in seconds) of the prefix advertised in Router Advertisement messages

Nested Schema for layer3.ipv6.inherited.neighbor_discovery

Optional:

  • dad_attempts (Number) Number of consecutive neighbor solicitation messages sent for duplicate address detection
  • dns_server (Attributes) (see below for nested schema)
  • dns_suffix (Attributes) (see below for nested schema)
  • enable_dad (Boolean) Enable Duplicate ADdress Detection (DAD)
  • enable_ndp_monitor (Boolean) Enable NDP Monitoring
  • neighbor (Attributes List) Static entries in neighbor cache (see below for nested schema)
  • ns_interval (Number) Interval (in seconds) between consecutive neighbor solicitation messages
  • reachable_time (Number) Time (in seconds) that the Reachable status for a neighbor can be maintained
  • router_advertisement (Attributes) (see below for nested schema)

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_server

Optional:

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_server.source

Optional:

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_server.source.dhcpv6

Optional:

  • prefix_pool (String) Prefix-Pool Name

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_server.source.manual

Optional:

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_server.source.manual.server

Required:

  • name (String)

Optional:

  • lifetime (Number) (4-3600) Lifetime in Seconds

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_suffix

Optional:

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_suffix.source

Optional:

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_suffix.source.dhcpv6

Optional:

  • prefix_pool (String) Prefix-Pool Name

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_suffix.source.manual

Optional:

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.dns_suffix.source.manual.suffix

Required:

  • name (String)

Optional:

  • lifetime (Number) (4-3600) lifetime in seconds

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.neighbor

Required:

  • name (String)

Optional:

  • hw_address (String) MAC address (format xx:xx:xx:xx:xx:xx)

Nested Schema for layer3.ipv6.inherited.neighbor_discovery.router_advertisement

Optional:

  • enable (Boolean)
  • enable_consistency_check (Boolean) check consistency of RA messages from other routers.
  • hop_limit (String) Current Hop Limit advertised in Router Advertisement messages
  • lifetime (Number) Router Lifetime (in seconds) advertised in Router Advertisement messages
  • link_mtu (String) value of MTU option in Router Advertisement messages, upto 9216 in Jumbo-Frame mode, up to 1500 otherwise
  • managed_flag (Boolean) Set the Managed Configuration Flag (M-bit) in Router Advertisement messages
  • max_interval (Number) Maximum interval (seconds) between consecutive unsolicited Router Advertisement messages
  • min_interval (Number) Minimum interval (seconds) between consecutive unsolicited Router Advertisement messages
  • other_flag (Boolean) Set the Other Stateful Configuration Flag (O-bit) in Router Advertisement messages
  • reachable_time (String) Reachable Time (in milliseconds) advertised in Router Advertisement messages
  • retransmission_timer (String) Retransmission Timer (in milliseconds) advertised in Router Advertisement messages
  • router_preference (String) Router Preference

Nested Schema for layer3.ipv6.neighbor_discovery

Optional:

  • dad_attempts (Number) Number of consecutive neighbor solicitation messages sent for duplicate address detection
  • enable_dad (Boolean) Enable Duplicate ADdress Detection (DAD)
  • enable_ndp_monitor (Boolean) Enable NDP Monitoring
  • neighbor (Attributes List) Static entries in neighbor cache (see below for nested schema)
  • ns_interval (Number) Interval (in seconds) between consecutive neighbor solicitation messages
  • reachable_time (Number) Time (in seconds) that the Reachable status for a neighbor can be maintained
  • router_advertisement (Attributes) (see below for nested schema)

Nested Schema for layer3.ipv6.neighbor_discovery.neighbor

Required:

  • name (String)

Optional:

  • hw_address (String) MAC address (format xx:xx:xx:xx:xx:xx)

Nested Schema for layer3.ipv6.neighbor_discovery.router_advertisement

Optional:

  • dns_support (Attributes) (see below for nested schema)
  • enable (Boolean)
  • enable_consistency_check (Boolean) check consistency of RA messages from other routers.
  • hop_limit (String) Current Hop Limit advertised in Router Advertisement messages
  • lifetime (Number) Router Lifetime (in seconds) advertised in Router Advertisement messages
  • link_mtu (String) value of MTU option in Router Advertisement messages, upto 9216 in Jumbo-Frame mode, up to 1500 otherwise
  • managed_flag (Boolean) Set the Managed Configuration Flag (M-bit) in Router Advertisement messages
  • max_interval (Number) Maximum interval (seconds) between consecutive unsolicited Router Advertisement messages
  • min_interval (Number) Minimum interval (seconds) between consecutive unsolicited Router Advertisement messages
  • other_flag (Boolean) Set the Other Stateful Configuration Flag (O-bit) in Router Advertisement messages
  • reachable_time (String) Reachable Time (in milliseconds) advertised in Router Advertisement messages
  • retransmission_timer (String) Retransmission Timer (in milliseconds) advertised in Router Advertisement messages
  • router_preference (String) Router Preference

Nested Schema for layer3.ipv6.neighbor_discovery.router_advertisement.dns_support

Optional:

Nested Schema for layer3.ipv6.neighbor_discovery.router_advertisement.dns_support.server

Required:

  • name (String)

Optional:

  • lifetime (Number) Router Lifetime (in seconds) advertised in Router Advertisement messages

Nested Schema for layer3.ipv6.neighbor_discovery.router_advertisement.dns_support.suffix

Required:

  • name (String)

Optional:

  • lifetime (Number) Router Lifetime (in seconds) advertised in Router Advertisement messages

Nested Schema for layer3.lldp

Optional:

Nested Schema for layer3.lldp.high_availability

Optional:

  • passive_pre_negotiation (Boolean) Enable LLDP pre-negotiation in HA passive state

Nested Schema for layer3.ndp_proxy

Optional:

Nested Schema for layer3.ndp_proxy.addresses

Required:

  • name (String)

Optional:

  • negate (Boolean) put the prefix or address on a block list

Nested Schema for layer3.pppoe

Optional:

  • access_concentrator (String) desired access concentrator
  • authentication (String) authentication protocol
  • create_default_route (Boolean) automatically create default route pointing to peer
  • default_route_metric (Number) metric of the default route created
  • enable (Boolean)
  • passive (Attributes) (see below for nested schema)
  • password (String) password for ppp autentication
  • service (String) desired service
  • static_address (Attributes) (see below for nested schema)
  • username (String) username for ppp authentication

Nested Schema for layer3.pppoe.passive

Optional:

  • enable (Boolean)

Nested Schema for layer3.pppoe.static_address

Optional:

  • ips (String) static ip address

Nested Schema for layer3.sdwan_link_settings

Optional:

  • enable (Boolean) Enable sdwan on this ethernet interface
  • sdwan_interface_profile (String) Sdwan link characteristics
  • upstream_nat (Attributes) (see below for nested schema)

Nested Schema for layer3.sdwan_link_settings.upstream_nat

Optional:

Nested Schema for layer3.sdwan_link_settings.upstream_nat.ddns

Nested Schema for layer3.sdwan_link_settings.upstream_nat.static_ip

Optional:

  • fqdn (String) Upstream NAT address FQDN name configuration
  • ip_address (String) Upstream NAT IP address

Nested Schema for log_card

Optional:

  • default_gateway (String) log forwarding card default gateway
  • ip_address (String) IP address for the log card forwarding interface
  • ipv6_address (String) IPv6 address for the log card forwarding interface
  • ipv6_default_gateway (String) log forwarding IPv6 card default gateway
  • netmask (String) IP netmask for the log card forwarding interface

Nested Schema for poe

Optional:

  • enabled (Boolean) PoE Enable
  • poe_reserved_power (Number) Reserved Power

Nested Schema for tap

Optional:

  • netflow_profile (String) Netflow Server Profile

Nested Schema for virtual_wire

Optional:

Nested Schema for virtual_wire.lacp

Optional:

Nested Schema for virtual_wire.lacp.high_availability

Optional:

  • passive_pre_negotiation (Boolean) Allow LACP traffic to traverse this device in HA passive state

Nested Schema for virtual_wire.lldp

Optional:

Nested Schema for virtual_wire.lldp.high_availability

Optional:

  • passive_pre_negotiation (Boolean) Enable LLDP pre-negotiation in HA passive state
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/docs Improvements or additions to documentation resources/panos_ethernet_interface
Projects
None yet
Development

No branches or pull requests

2 participants