# nvmet.port.create

Create a NVMe target port.

ports are the means through which subsystems (subsys) are made available to clients (hosts).

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: nvmet_port_create

#### nvmet_port_create

NVMe-oF port configuration data for creation (TCP/RDMA or Fibre Channel).

## One of

#### NVMetPortCreateRDMATCP

Type: object
No Additional Properties

##

#### Addr Trtype

Type: enum (of string)

##### Must be one of:

- "TCP"
- "RDMA"

##

#### Addr Trsvcid

Type: integer Default: 4420

Value must be greater or equal to `1024` and lesser or equal to `65535`

##

#### Addr Traddr

## Any of

Type: const
Specific value: `""`
Type: string

##

#### Inline Data Size

Default: null

Maximum size for inline data transfers or `null` for default.

## Any of

Type: integer
Type: null

##

#### Max Queue Size

Default: null

Maximum number of queue entries or `null` for default.

## Any of

Type: integer
Type: null

##

#### Pi Enable

Default: null

Whether Protection Information (PI) is enabled or `null` for default.

## Any of

Type: boolean
Type: null

##

#### Enabled

Type: boolean Default: true

Port enabled. When NVMe target is running, cannot make changes to an enabled port.

#### NVMetPortCreateFC

Type: object
No Additional Properties

##

#### Addr Trtype

Type: const

Fabric transport technology name.

Specific value: `"FC"`

##

#### Addr Traddr

Type: string

A transport-specific field identifying the NVMe host port to use for the connection to the controller.

Must be at least `1` characters long

##

#### Inline Data Size

Default: null

Maximum size for inline data transfers or `null` for default.

## Any of

Type: integer
Type: null

##

#### Max Queue Size

Default: null

Maximum number of queue entries or `null` for default.

## Any of

Type: integer
Type: null

##

#### Pi Enable

Default: null

Whether Protection Information (PI) is enabled or `null` for default.

## Any of

Type: boolean
Type: null

##

#### Enabled

Type: boolean Default: true

Port enabled. When NVMe target is running, cannot make changes to an enabled port.

##

#### NVMetPortEntry

Type: object

The created NVMe-oF port configuration.

No Additional Properties

##

#### Id

Type: integer

Unique identifier for the NVMe-oF port.

##

#### Index

Type: integer

Index of the port, for internal use.

##

#### Addr Trtype

Type: enum (of string)

Fabric transport technology name.

##### Must be one of:

- "TCP"
- "RDMA"
- "FC"

##

#### Addr Trsvcid

Transport-specific TRSVCID field. When configured for TCP/IP or RDMA this will be the port number.

## Any of

Type: integer
Type: string

Must be at least `1` characters long

Type: null

##

#### Addr Traddr

Type: string

A transport-specific field identifying the NVMe host port to use for the connection to the controller.

For TCP or RDMA transports, this will be an IPv4 or IPv6 address.

##

#### Addr Adrfam

Type: enum (of string)

Address family.

##### Must be one of:

- "IPV4"
- "IPV6"
- "FC"

##

#### Inline Data Size

Default: null

Maximum size for inline data transfers or `null` for default.

## Any of

Type: integer
Type: null

##

#### Max Queue Size

Default: null

Maximum number of queue entries or `null` for default.

## Any of

Type: integer
Type: null

##

#### Pi Enable

Default: null

Whether Protection Information (PI) is enabled or `null` for default.

## Any of

Type: boolean
Type: null

##

#### Enabled

Type: boolean Default: true

Port enabled. When NVMe target is running, cannot make changes to an enabled port.

Required roles: SHARING_NVME_TARGET_WRITE