Skip to main content
A newer release of this product is available.

Update an IP subnet

Contributors
PDFs

PATCH /network/ip/subnets/{uuid}

Introduced In: 9.11

Updates an IP subnet.

  • network subnet modify

  • network subnet rename

  • network subnet add-ranges

  • network subnet remove-ranges

Parameters

Name Type In Required Description

uuid

string

path

True

IP subnet UUID

Request Body

Name Type Description

_links

_links

available_count

integer

available_ip_ranges

array[ip_address_range]

broadcast_domain

broadcast_domain

The broadcast domain that the subnet is associated with. Either the UUID or name must be supplied on POST.

fail_if_lifs_conflict

boolean

This action will fail if any existing interface is using an IP address in the ranges provided. Set this to false to associate any manually addressed interfaces with the subnet and allow the action to succeed.

gateway

string

The IP address of the gateway for this subnet.

ip_ranges

array[ip_address_range]

ipspace

ipspace

The IPspace that the subnet is associated with. Either the UUID or name must be supplied on POST.

name

string

Subnet name

subnet

ip_info

IP information

total_count

integer

used_count

integer

uuid

string

The UUID that uniquely identifies the subnet.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "available_count": 0,
  "available_ip_ranges": {
    "end": "10.10.10.7",
    "family": "ipv4",
    "start": "10.10.10.7"
  },
  "broadcast_domain": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "bd1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "gateway": "10.1.1.1",
  "ip_ranges": {
    "end": "10.10.10.7",
    "family": "ipv4",
    "start": "10.10.10.7"
  },
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "exchange",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "name": "subnet1",
  "subnet": {
    "address": "10.10.10.7",
    "family": "ipv4",
    "netmask": "24"
  },
  "total_count": 0,
  "used_count": 0,
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

Fill error codes below. ONTAP Error Response Codes

Error Code Description

1377658

Invalid gateway for subnet in IPspace.

1377659

Subnet would overlap with existing subnet named in IPspace.

1377660

A subnet with the name already exists in the IPspace.

1377661

Subnet in IPspace cannot use subnet address because that address is already used by subnet in the same IPspace.

1377662

The IP range address is not within the subnet in IPspace.

1377663

The specified IP address range of subnet in IPspace contains an address already in use by a LIF.

1377664

The specified IP address range of subnet in IPspace contains an address already in use by the Service Processor.

1377669

The specified gateway address exists in a configured range.

1377673

The addresses provided must have the same address family.

1377674

Modifying the netmask is not supported because the subnet has one or more interfaces associated with it.

1377675

The netmask of the interface did not match the netmask of the subnet.

1377681

Cannot update LIF associations for LIF. The broadcast domain of the LIF does not match the broadcast domain of the subnet.

1966269

IPv4 Addresses must have a prefix length between 1 and 32.

1966778

IPv6 addresses must have a prefix length between 1 and 127.

53282568

The subnet.address must be specified together with subnet.netmask.

53282569

The specified subnet.netmask is not valid.

53282570

Each pair of ranges must have ip_ranges.start less than or equal to ip_ranges.end.

53282571

The ip_ranges.start and ip_ranges.end fields must have the same number of items.

53282572

PATCH partially succeeded with error.

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

ip_address_range

IP address range

Name Type Description

end

string

IPv4 or IPv6 address

family

string

IPv4 or IPv6

start

string

IPv4 or IPv6 address

broadcast_domain

The broadcast domain that the subnet is associated with. Either the UUID or name must be supplied on POST.

Name Type Description

_links

_links

name

string

Name of the broadcast domain, scoped to its IPspace

uuid

string

Broadcast domain UUID

ipspace

The IPspace that the subnet is associated with. Either the UUID or name must be supplied on POST.

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

ip_info

IP information

Name Type Description

address

string

IPv4 or IPv6 address

family

string

IPv4 or IPv6

netmask

string

Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always netmask length.

ip_subnet

Name Type Description

_links

_links

available_count

integer

available_ip_ranges

array[ip_address_range]

broadcast_domain

broadcast_domain

The broadcast domain that the subnet is associated with. Either the UUID or name must be supplied on POST.

fail_if_lifs_conflict

boolean

This action will fail if any existing interface is using an IP address in the ranges provided. Set this to false to associate any manually addressed interfaces with the subnet and allow the action to succeed.

gateway

string

The IP address of the gateway for this subnet.

ip_ranges

array[ip_address_range]

ipspace

ipspace

The IPspace that the subnet is associated with. Either the UUID or name must be supplied on POST.

name

string

Subnet name

subnet

ip_info

IP information

total_count

integer

used_count

integer

uuid

string

The UUID that uniquely identifies the subnet.