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

Resource URIs

URI Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip Configures an IP address on an interface.
GET URIs Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip Configures an IP address on an interface. Allowed interface types: Management, Ethernet, Port-channel, Ve, Loopback.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/address Specifies the IP address. Allowed interface types: Management, Management, Ethernet, Port-channel, Ve, Loopback.
POST URIs Payload Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip <address><address>{inet:ipv4-prefix}</address></address> Specifies the mask for the associated IP subnet. Allowed interface types: Ethernet, Ve, Loopback.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ <shutdown>{enumeration}</shutdown> Shuts down the interface.
PATCH URIs Payload Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/address <address><address>{inet:ipv4-prefix}</address></address> Specifies the mask for the associated IP subnet. Allowed interface types: Ethernet, Ve, Loopback.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/shutdown <shutdown>{enumeration}</shutdown> Shuts down the interface. Allowed interface types: Ethernet, Port-channel, Ve.
DELETE URIs
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip
<base_URI>/config/running/interface/{interface-type}/{interface-name}/shutdown
<base_URI>/config/running/interface/{interface-type}/{interface-name}/ip/mtu

Usage Guidelines

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

Examples

URI

The following example uses the GET option to retrieve an IP address.

http://host:80/rest/config/running/interface/ethernet/%220/10%22/ip/address

None

<address xmlns="urn:brocade.com:mgmt:brocade-ip-config" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/interface/Ethernet/%220/10%22/ip/address/%2210.20.1.1/20%22">
  <address>10.20.1.1/20</address>
</address>

URI

The following example uses the PATCH option to configure an IP address on an interface.

http://host:80/rest/config/running/interface/ethernet/%220/10%22/ip/address

<address><address>10.20.1.1/20</address></address>

None

URI

The following example uses the DELETE option to remove an IP address on an interface.

http://host:80/rest/config/running/interface/ethernet/%220/10%22/ip/address

None

None