interface/{interface-type}/{interface-name}/ip/igmp

Configures, modifies, or retrieves the Internet Group Management Protocol (IGMP).

Resource URIs


URI	Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	Configures IGMP. Valid interface type: Ethernet.


GET URIs	Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	Retrieves IGMP. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/last-member-query-interval	Retrieves the IGMP last-member query interval for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-interval	Retrieves the IGMP query interval for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-max-response-time	Retrieves the maximum response time for IGMP queries for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/immediate-leave	Removes a group from the IGMP table immediately following receipt of a Leave Group request. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/version	Retrieves the IGMP version on a device. Valid interface type: Ethernet.


POST URIs	Payload	Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	<static-group><igmpl3-sg-addr>{igmpl3-sg-addr}</igmpl3-sg-addr></static-group>	Configures the IGMP static group membership entries for a specific interface.Valid interface type: Ethernet.


PATCH URIs	Payload	Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	"<igmp><last-member-query-interval>{unit32}</last-member-query-interval></igmp>	Configures the IGMP last-member query interval for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	"<igmp><query-interval>{unit32}</query-interval></igmp>	Configures the IGMP query interval for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	<igmp><query-max-response-time>{unit32}</query-max-response-time></igmp>	Configures the maximum response time for IGMP queries for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	<igmp><immediate-leave>{enumeration}</immediate-leave></igmp>	Removes a group from the IGMP table immediately following receipValid interface type: Ethernet.t of a Leave Group request.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp	<igmp><version>{unit32}</version></igmp>	Configures the IGMP version on a device. Valid interface type: Ethernet.


PUT URIs	Payload	Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/last-member-query-interval	<last-member-query-interval>{unit32}</last-member-query-interval>	Configures the IGMP last-member query interval for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-interval	<query-interval>{unit32}</query-interval>	Configures the IGMP query interval for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-max-response-time	"<query-max-response-time>{unit32}</query-max-response-time>	Configures the maximum response time for IGMP queries for an interface. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/immediate-leave	"<immediate-leave>{enumeration}</immediate-leave>	Removes a group from the IGMP table immediately following receipt of a Leave Group request. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/version	"<version>{unit32}</version>	Configures the IGMP version on a device. Valid interface type: Ethernet.


DELETE URIs
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/last-member-query-interval
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-interval
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-max-response-time
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/immediate-leave
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/version
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/static-group/{igmpl3-sg-addr}
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-interval
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/query-max-response-time
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/immediate-leave
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/igmp/version

Parameters

interface-type: Valid interface type:Ethernet only.
last-member-query-interval: Specifies the the IGMP 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/interface/Ethernet/%221/1%22/ip/igmp

None

<igmp xmlns="urn:brocade.com:mgmt:brocade-igmp" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/interface/Ethernet/%223/12%22/ip/igmp">
  <last-member-query-interval>2000</last-member-query-interval>
  <query-interval>200</query-interval>
  <query-max-response-time>20</query-max-response-time>
  <immediate-leave>true</immediate-leave>
  <version>3</version>
</igmp>

URI

The following is an example of the POST operation to configure the IGMP static group membership entries for a specific interface.

http://host:80/rest/config/running/interface/Ve/11/ip/igmp

<static-group><igmpl3-sg-addr>230.100.100.100</igmpl3-sg-addr></static-group>

None

URI

The following is an example of the DELETE operation to remove managed config flag on a specified interface.

http://host:80/rest/config/running/interface/Ve/11/ip/igmp/last-member-query-interval

None