The 2018 State of DevOps Report
Get the report

Resource Type: interface

+ expand all - collapse all
+ open menu - close menu

Open source Puppet documentation

  1. interface
    1. Description
    2. Attributes
    3. Providers

NOTE: This page was generated from the Puppet source code on 2018-08-28 06:48:02 -0700

interface

Description

This represents a router or switch interface. It is possible to manage interface mode (access or trunking, native vlan and encapsulation) and switchport characteristics (speed, duplex).

Attributes

interface { 'resource title':
  name                => # (namevar) The interface's...
  ensure              => # The basic property that the resource should be...
  access_vlan         => # Interface static access vlan.  Values can match...
  allowed_trunk_vlans => # Allowed list of Vlans that this trunk can...
  description         => # Interface...
  device_url          => # The URL at which the router or switch can be...
  duplex              => # Interface duplex.  Valid values are `auto`...
  encapsulation       => # Interface switchport encapsulation.  Valid...
  etherchannel        => # Channel group this interface is part of.  Values 
  ipaddress           => # IP Address of this interface. Note that it might 
  mode                => # Interface switchport mode.  Valid values are...
  native_vlan         => # Interface native vlan when trunking.  Values can 
  provider            => # The specific backend to use for this `interface` 
  speed               => # Interface speed.  Valid values are `auto`...
  # ...plus any applicable metaparameters.
}

name

(Namevar: If omitted, this attribute’s value defaults to the resource’s title.)

The interface’s name.

(↑ Back to interface attributes)

ensure

(Property: This attribute represents concrete state on the target system.)

The basic property that the resource should be in.

Default: present

Allowed values:

  • present
  • absent
  • shutdown
  • no_shutdown

(↑ Back to interface attributes)

access_vlan

(Property: This attribute represents concrete state on the target system.)

Interface static access vlan.

Allowed values:

  • /^\d+/

(↑ Back to interface attributes)

allowed_trunk_vlans

(Property: This attribute represents concrete state on the target system.)

Allowed list of Vlans that this trunk can forward.

Allowed values:

  • all
  • /./

(↑ Back to interface attributes)

description

(Property: This attribute represents concrete state on the target system.)

Interface description.

(↑ Back to interface attributes)

device_url

The URL at which the router or switch can be reached.

(↑ Back to interface attributes)

duplex

(Property: This attribute represents concrete state on the target system.)

Interface duplex.

Allowed values:

  • auto
  • full
  • half

(↑ Back to interface attributes)

encapsulation

(Property: This attribute represents concrete state on the target system.)

Interface switchport encapsulation.

Allowed values:

  • none
  • dot1q
  • isl
  • negotiate

(↑ Back to interface attributes)

etherchannel

(Property: This attribute represents concrete state on the target system.)

Channel group this interface is part of.

Allowed values:

  • /^\d+/

(↑ Back to interface attributes)

ipaddress

(Property: This attribute represents concrete state on the target system.)

IP Address of this interface. Note that it might not be possible to set an interface IP address; it depends on the interface type and device type.

Valid format of ip addresses are:

  • IPV4, like 127.0.0.1
  • IPV4/prefixlength like 127.0.1.1/24
  • IPV6/prefixlength like FE80::21A:2FFF:FE30:ECF0/128
  • an optional suffix for IPV6 addresses from this list: eui-64, link-local

It is also possible to supply an array of values.

(↑ Back to interface attributes)

mode

(Property: This attribute represents concrete state on the target system.)

Interface switchport mode.

Allowed values:

  • access
  • trunk
  • dynamic auto
  • dynamic desirable

(↑ Back to interface attributes)

native_vlan

(Property: This attribute represents concrete state on the target system.)

Interface native vlan when trunking.

Allowed values:

  • /^\d+/

(↑ Back to interface attributes)

provider

The specific backend to use for this interface resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

Available providers are:

(↑ Back to interface attributes)

speed

(Property: This attribute represents concrete state on the target system.)

Interface speed.

Allowed values:

  • auto
  • /^\d+/

(↑ Back to interface attributes)

Providers

cisco

Cisco switch/router provider for interface.

NOTE: This page was generated from the Puppet source code on 2018-08-28 06:48:02 -0700

Back to top