vlan

Configures a VLAN.

Resource URIs


URI	Description
<base_URI>/config/running/vlan	Configures a VLAN.


GET URIs	Description
<base_URI>/config/running/vlan/{vlan-num}/ip/pim	Configures IP PIM on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/pim/snooping	Configures IP PIM snooping on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/pim/snooping/enable	Enables IP PIM snooping on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp	Configures IGMP.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	Configures IGMP snooping on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/version	Enables IGMP snooping on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/last-member-query-interval	Configures the IGMP snooping last-member query interval.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/query-interval	Configures the IGMP snooping query interval.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/query-max-response-time	Configures the maximum response time for IGMP snooping queries.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/enable	Enables IGMP snooping on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/fast-leave	Enables IGMP snooping fast-leave processing for a VLAN. This allows the removal of an interface from the forwarding table without sending out group-specific queries to the interface.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/querier	Configures the IGMP snooping querier on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/querier/enable	Activates the IGMP snooping querier on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/mrouter	Configures a VLAN port member to be a multicast router interface.


POST URIs	Payload	Description
<base_URI>/config/running/	<vlan><name>{uint32}</name></vlan>	Creates a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/mrouter	<interface><igmps-if-type>ethernet</igmps-if-type><value>{string}</value></interface>	Configures a VLAN port member to be a multicast router interface.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	<static-group><mcast-address>{inet:ipv4-address}</mcast-address><interface>{enumeration}</interface><igmps-if-type>{enumeration}</igmps-if-type><value>{string-type}</value></static-group>	Configures an interface in a VLAN as a static member of a multicast group.


PUT URIs	Payload	Description
<base_URI>/config/running/vlan/{vlan-num}/router-interface/Ve	<Ve>{uint32}</Ve>	Ceates a router VLAN interface.
<base_URI>/config/running/vlan/{vlan-num}/statistics	<statistics>(enum)</statistics>	Enables statistics.
<base_URI>/config/running/vlan/{vlan-num}/desription	<description>(string)</description>	Adds the VLAN description.
<base_URI>/config/running/vlan/{vlan-num}/ip/pim/snooping/enable	<enable>{enumeration}</enable>	Enables IP PIM snooping.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/version	<version>{unit32}</version>	Configures the IGMP snooping version.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/last-member-query-interval	<last-member-query-interval>{unit32}</last-member-query-interval>	Configures the IGMP snooping last-member query interval.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/query-interval	<query-interval>{unit32}</query-interval>	Configures the IGMP snooping query interval.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/query-max-response-time	<query-max-response-time>{unit32}</query-max-response-time>	Configures the maximum response time for IGMP snooping queries.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/enable	<enable>{enumeration}</enable>	Enables IGMP snooping on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/fast-leave	<fast-leave>{enumeration}</fast-leave>	Enables IGMP snooping fast-leave processing for a VLAN. This allows the removal of an interface from the forwarding table without sending out group-specific queries to the interface.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/querier/enable	<enable>{enumeration}</enable>	Configures the IGMP snooping querier on a VLAN.


PATCH URIs	Payload	Description
<base_URI>/config/running/vlan/{vlan-num}/ip/pim/snooping	<snooping><enable>{enumeration}</enable></snooping>	Creates a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	<snooping><version>{unit32}</version></snooping>	Configures the IGMP snooping version.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	<snooping><last-member-query-interval>{unit32}</last-member-query-nterval></snooping>	Configures the IGMP snooping last-member query interval.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	<snooping><query-interval>{unit32}</query-interval></snooping>	Configures the IGMP snooping query interval.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	<snooping><query-max-response-time>{unit32}</query-max-response-time></snooping>	Configures the maximum response time for IGMP snooping queries.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	<snooping><enable>{enumeration}</enable></snooping>	Enables IGMP snooping on a VLAN.
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping	<snooping><fast-leave>{enumeration}</fast-leave></snooping>	Enables IGMP snooping fast-leave processing for a VLAN. This allows the removal of an interface from the forwarding table without sending out group-specific queries to the interface.


DELETE URIs
<base_URI>/config/running/vlan/{vlan-num}/ip/pim/snooping/enable
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/version
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/last-member-query-interval
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/query-interval
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/query-max-response-time
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/enable
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/fast-leave
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/querier/enable
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/mrouter/interface/{igmps-interface-type},{interface-name}
<base_URI>/config/running/vlan/{vlan-num}/ip/igmp/snooping/static-group/{igmpl3-sg-addr}/interface/{igmps-interface-type},{interface-name}

Parameters

last-member-query-interval: Specifies the the IGMP snooping last-member query interval time in milliseconds. Range is from 100 through 25500 milliseconds. The default is 1000.
query-interval: Specifies the IGMP query interval time in seconds. Range is from 1 through 18000 seconds. The default is 125.
query-max-response-time: Specifies the maximum response time for IGMP queries for an interface in seconds. Range is from 1 through 25 seconds. The default is 10.
version: Specifies the IGMP version number on a device: 1, 2, or 3. Version 2 is the default.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/vlan/11/ip/igmp

None

<igmp xmlns="urn:brocade.com:mgmt:brocade-igmp-snooping" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/vlan/11/ip/igmp">
  <snooping y:self="/rest/config/running/vlan/11/ip/igmp/snooping">
    <version>3</version>
    <querier y:self="/rest/config/running/vlan/11/ip/igmp/snooping/querier">
    </querier>
    <mrouter y:self="/rest/config/running/vlan/11/ip/igmp/snooping/mrouter">
    </mrouter>
  </snooping>
</igmp>

URI

The following is an example of the POST operation to configure a VLAN port member to be a multicast router interface.

http://host:80/rest/config/running/vlan/11/ip/igmp/snooping/mrouter

<interface><igmps-if-type>ethernet</igmps-if-type><value>3/12</value></interface>"

None

URI

The following is an example of the DELETE operation to remove IGMP snooping last-member query interval.

http://host:80/rest/config/running/vlan/{vlan-num}/ip/igmp/snooping/last-member-query-interval

None