Skip to main content

Create a new domain with unique IP addresses

Contributors
PDFs

POST /network/ipspaces

Introduced In: 9.6

Creates a new domain within which IP addresses are unique. SVMs, ports, and networks are scoped to a single IPspace.

Required properties

  • name - Name of the IPspace to create.

  • network ipspace create

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

The UUID that uniquely identifies the IPspace.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "name": "ipspace1",
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

1377261

An IPspace with the same name already exists.

1966449

Invalid IPspace name in MetroCluster configurations.

1966586

The specified IPspace name is invalid because it is already used by a peered SVM.

1967102

A POST operation might have left the configuration in an inconsistent state. Check the configuration.

9240587

Name cannot be empty.

9240588

The name is too long.

9240589

Invalid character in name.

9240590

The name is reserved by the system.

9240591

The name is not valid. The name is already in use by a cluster node, Vserver, or it is the name of the local cluster.

53281576

Cannot create IPspace because the maximum number of custom IPspaces has already been reached on the cluster.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

ipspace

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

The UUID that uniquely identifies the IPspace.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.