openapi: 3.0.1 info: title: FlashArray REST Active Directory Network Interfaces API version: '2.52' description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. ' servers: - url: / tags: - name: Network Interfaces description: 'Manages the interfaces and the network connection attributes of the array. ' paths: /api/2.52/network-interfaces: get: tags: - Network Interfaces summary: Pure Storage List Network Interfaces description: Displays all network interfaces for all controllers on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceGetResponse' post: tags: - Network Interfaces summary: Pure Storage Create Network Interface description: Creates a network interface on a controller on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePost' required: true x-codegen-request-body-name: network responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceResponse' x-codegen-request-body-name: network delete: tags: - Network Interfaces summary: Pure Storage Delete Network Interface description: Deletes a network interface on a controller. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Network Interfaces summary: Pure Storage Modify Network Interface description: Modifies a network interface on a controller. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePatch' required: true x-codegen-request-body-name: network responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceResponse' x-codegen-request-body-name: network /api/2.52/network-interfaces/neighbors: get: tags: - Network Interfaces summary: Pure Storage List Network Interface Neighbors description: Displays all neighbors for all network interfaces on the array. parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_port_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceNeighborGetResponse' /api/2.52/network-interfaces/performance: get: tags: - Network Interfaces summary: Pure Storage List Network Performance Statistics description: 'Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePerformanceGetResponse' /api/2.52/network-interfaces/port-details: get: tags: - Network Interfaces summary: Pure Storage List SFP Port Details description: 'Displays Ethernet and Fibre Channel SFP details. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacesPortDetailsGetResponse' /api/2.26/network-interfaces: get: tags: - Network Interfaces summary: Pure Storage GET Network-interfaces description: List network interfaces and their attributes. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceGetResponse_2' post: tags: - Network Interfaces summary: Pure Storage POST Network-interfaces description: Create a VIP to export data or perform replication. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkInterface_2' required: true x-codegen-request-body-name: network-interface responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceResponse_2' x-codegen-request-body-name: network-interface delete: tags: - Network Interfaces summary: Pure Storage DELETE Network-interfaces description: Remove a VIP. Once a data VIP is removed, any clients connected through the data VIP will lose their connection to the file system or bucket. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Network Interfaces summary: Pure Storage PATCH Network-interfaces description: Modify the attributes of a VIP. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePatch_2' required: true x-codegen-request-body-name: network-interface responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceResponse_2' x-codegen-request-body-name: network-interface /api/2.26/network-interfaces/ping: get: tags: - Network Interfaces summary: Pure Storage GET Network-interfaces/ping description: 'Display network interface ping result. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ping_trace_component' - $ref: '#/components/parameters/Ping_count' - $ref: '#/components/parameters/Ping_trace_destination' - $ref: '#/components/parameters/Packet_size' - $ref: '#/components/parameters/Print_latency' - $ref: '#/components/parameters/Resolve_hostname' - $ref: '#/components/parameters/Ping_trace_source' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacePingGetResponse' /api/2.26/network-interfaces/trace: get: tags: - Network Interfaces summary: Pure Storage GET Network-interfaces/trace description: 'Display network interface trace result. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ping_trace_component' - $ref: '#/components/parameters/Ping_trace_destination' - $ref: '#/components/parameters/Mtu' - $ref: '#/components/parameters/Fragment_packet' - $ref: '#/components/parameters/Method' - $ref: '#/components/parameters/Port' - $ref: '#/components/parameters/Resolve_hostname' - $ref: '#/components/parameters/Ping_trace_source' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceTraceGetResponse' /api/2.26/network-interfaces/connectors: get: tags: - Network Interfaces summary: Pure Storage GET Network-interfaces/connectors description: List network connector information parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacesConnectorsGetResponse' patch: tags: - Network Interfaces summary: Pure Storage PATCH Network-interfaces/connectors description: Modify network connector information. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/HardwareConnector' required: true x-codegen-request-body-name: network-connector responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacesConnectorsResponse' x-codegen-request-body-name: network-connector /api/2.26/network-interfaces/connectors/performance: get: tags: - Network Interfaces summary: Pure Storage GET Network Connectors Performance Statistics description: 'Displays network statistics, historical bandwidth, and error reporting for all specified network connectors. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Start_time' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformanceGetResponse' /api/2.26/network-interfaces/connectors/settings: get: tags: - Network Interfaces summary: Pure Storage GET Global Network Settings for Network Connectors description: Display the global network settings for network connectors. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingsGetResponse' /api/2.26/network-interfaces/network-connection-statistics: get: tags: - Network Interfaces summary: Pure Storage GET Network-interfaces/network-connection-statistics description: 'Display network interface status ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/NetworkConnectionStatisticsCurrent_state' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_host' - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_port' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_host' - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_port' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkConnectionStatisticsGetResponse' /api/2.26/network-interfaces/neighbors: get: tags: - Network Interfaces summary: Pure Storage List Network Interface Neighbors description: Displays all neighbors for all network interfaces on the array. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Local_port_names_2' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceNeighborGetResponse' /api/1.5/network-interfaces: get: tags: - Network Interfaces summary: Pure Storage Get Network Interfaces description: 'Retrieves information about physical and virtual network interface objects. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Names_2' - $ref: '#/components/parameters/Offset_3' - $ref: '#/components/parameters/Sort_3' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/NetworkInterfaceGetResponse_3' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' components: schemas: NetworkInterfacePerformance: allOf: - $ref: '#/components/schemas/_resourceNoId' - type: object properties: eth: title: NetworkInterfacePerformanceEth allOf: - $ref: '#/components/schemas/_networkInterfacePerformanceEth' fc: title: NetworkInterfacePerformanceFc allOf: - $ref: '#/components/schemas/_networkInterfacePerformanceFc' interface_type: description: 'The interface type. Valid values are `eth` and `fc`. ' type: string readOnly: true time: description: 'Sample time in milliseconds since UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true NetworkInterfaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/NetworkInterfaceResponse' - $ref: '#/components/schemas/_errorContextResponse' HardwareConnector: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: connector_type: description: 'Form-factor of the interface. Valid values include QSFP, QSFP+, QSFP28, QSFP56, QSFP-DD, RJ-45, and -. ' type: string readOnly: true example: QSFP lane_speed: description: 'Configured speed of each lane in the connector in bits-per-second. ' type: integer format: int64 example: 10000000000 lanes_per_port: description: Configured number of lanes comprising each port in the connector. type: integer format: int64 example: 4 port_count: description: 'Configured number of ports in the connector (1/2/4 for QSFP). ' type: integer format: int64 example: 1 port_speed: description: Configured speed of each port in the connector in bits-per-second. type: integer format: int64 example: 40000000000 transceiver_type: description: 'Details about the transceiver which is plugged into the connector port. Transceiver type will be read-only for pureuser. If nothing is plugged into QSFP port, value will be `Unused` and type cannot be auto-detected, and internal user has not specified a type - value will be `Unknown`. If transceiver is plugged in, and type is auto-detected, and/or type has been explicitly set by internal user - that value will be shown. Transceiver type is not applicable for RJ-45 connectors. ' type: string readOnly: true example: 40GBASE-LR4 _networkInterfacePortDetailsTx_power: type: object properties: channel: description: 'The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. ' type: integer example: 0 measurement: description: 'Tx output power in mW. ' type: number format: double status: description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx output power. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. ' type: string example: ok _networkInterfacePortDetailsVoltage: type: object properties: channel: description: 'The channel number if the diagnostic has an associated channel number. If not specified, defaults to `null`. ' type: integer example: 0 measurement: description: 'Supply voltage in volts. ' type: number format: double status: description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for supply voltage. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. ' type: string example: ok _timeAware: type: object properties: _as_of: description: The freshness of the data (timestamp in millis since epoch). type: integer format: int64 readOnly: true example: 1502729489760 ErrorNoContext: type: object properties: message: type: string example: Something was wrong NetworkInterface_3: allOf: - $ref: '#/components/schemas/_arraysBuiltIn' - description: 'A point of interconnection between the appliance and a private or public network. May be associated with a physical device or a representation of a virtual interface. ' type: object properties: address: description: IP address of this network interface. type: string example: 10.11.12.13 enabled: type: boolean example: true gateway: type: string example: 10.20.30.40 hwaddr: description: Hardware address. type: string example: 90:ef:ba:80:70:dc mtu: description: Maximum transmission unit. type: integer format: int32 example: 9000 netmask: type: string example: 255.255.255.0 services: description: Services and protocols that are enabled on the interface. type: array items: type: string description: "Valid values are `iscsi`, `management`, `nvme/fc`, `nvme/roce`,\n and `replication`.\n" example: iscsi speed: description: Speed in bytes per second. type: integer format: int64 example: 10000000000 subinterfaces: type: array items: type: string example: ct0.eth0 NetworkInterfaceTraceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/NetworkInterfaceTraceResponse' NetworkInterfaceResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/NetworkInterface' NetworkInterfacePatch: type: object properties: attached_servers: description: 'Applicable only to Ethernet interfaces. List of servers to be associated with the specified network interface for data ingress. At most one server can be specified for each interface. To attach the network interface to a server, `name` or `id` the desired server must be provided. To detach a network interface from all servers, an empty list `[]` should be passed to the `attached_servers` field. ' type: array maxItems: 1 items: $ref: '#/components/schemas/_reference' enabled: description: 'Returns a value of `true` if the specified network interface or Fibre Channel port is enabled. Returns a value of `false` if the specified network interface or Fibre Channel port is disabled. ' type: boolean eth: $ref: '#/components/schemas/_networkinterfacepatchEth' override_npiv_check: description: 'N-Port ID Virtualization (NPIV) requires a balanced configuration of Fibre Channel ports configured for SCSI on both controllers. Enabling or Disabling a Fibre Channel port configured for SCSI might cause the NPIV status to change from enabled to disabled or vice versa. Set this option to proceed with enabling or disabling the port. ' type: boolean services: description: 'The services provided by the specified network interface or Fibre Channel port. ' type: array items: type: string description: 'Valid values include `iscsi`, `management`, `nvme-fc`, `nvme-roce`, `nvme-tcp`, `offload`, `replication`, and `scsi-fc`. ' _networkInterfaceNeighborNeighborPortId: description: 'An administratively assigned identifier of the particular neighboring port. ' type: object properties: type: description: 'The port ID subtype. Valid values are `ifname`, `ifalias`, `local`, `mac`, `ip`, and `unhandled`. ' type: string example: ifname value: description: The specific identifier for the particular port. type: string example: Ethernet7 NetworkInterfacesPortDetailsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/NetworkInterfacesPortDetailsResponse' NetworkInterfaceResponse_3: type: object properties: items: description: A list of network interface objects. type: array items: $ref: '#/components/schemas/NetworkInterface_3' _builtIn: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true name: description: Name of the object (e.g., a file system or snapshot). type: string readOnly: true _builtInAsOf: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs). ' allOf: - $ref: '#/components/schemas/_timeAware' - type: object properties: id: description: A non-modifiable, globally unique ID chosen by the system. type: string readOnly: true example: 01c2889a-4124-49ff-8cbd-c33405ede123 name: description: A non-modifiable, locally unique name chosen by the system. type: string readOnly: true example: example_name NetworkInterfaceNeighborResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/NetworkInterfaceNeighbor' NetworkInterfacesConnectorsSettingRoce: description: 'RoCE(RDMA over Converged Ethernet) configuration for network connectors. ' allOf: - type: object properties: default_ecn: description: 'The default ECN(Explicit Congestion Notification) setting for network connectors. ' title: NetworkInterfacesConnectorsSettingRoceEcn allOf: - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRoceEcn' default_pfc: description: 'The default PFC(Priority Flow Control) setting for network connectors. ' title: NetworkInterfacesConnectorsSettingRocePfc allOf: - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRocePfc' enabled: description: 'If `true`, then RoCE networking is enabled. Otherwise, it is disabled. ' type: boolean network_congestion_mode: description: 'The RoCE network mode to be used. Valid values include `lossy` and `lossless`. For lossy mode, only Explicit Congestion Notification (ECN) is enabled. For lossless mode, both ECN and Priority Flow Control (PFC) are enabled. ' type: string trust_mode: description: 'The trust mode of the RoCE network. Valid values include `pcp` and `dscp`. ' type: string _networkInterfacePerformanceFc: description: 'Fibre Channel port statistics. ' type: object properties: received_bytes_per_sec: description: 'Bytes received per second. ' type: integer format: int64 minimum: 0 received_crc_errors_per_sec: description: 'Fibre Channel frame CRC errors per second. ' type: integer format: int64 minimum: 0 received_frames_per_sec: description: 'Fibre Channel frames received per second. ' type: integer format: int64 minimum: 0 received_link_failures_per_sec: description: 'Loss of connectivity errors per second. ' type: integer format: int64 minimum: 0 received_loss_of_signal_per_sec: description: 'Loss of signal errors on Fibre Channel port per second. ' type: integer format: int64 minimum: 0 received_loss_of_sync_per_sec: description: 'Loss of sync errors on Fibre Channel port per second. ' type: integer format: int64 minimum: 0 total_errors_per_sec: description: 'The sum of all reception and transmission errors per second. ' type: integer format: int64 minimum: 0 transmitted_bytes_per_sec: description: 'Bytes transmitted per second. ' type: integer format: int64 minimum: 0 transmitted_frames_per_sec: description: 'Fibre Channel frames transmitted per second. ' type: integer format: int64 minimum: 0 transmitted_invalid_words_per_sec: description: 'Bit errors in transmission word per second. ' type: integer format: int64 minimum: 0 NetworkInterfacePing: description: 'Output from running the linux command ''ping'' directly on the array with start and end location information. ' type: object properties: component_name: description: Name of the component running the check. type: string readOnly: true example: ch1-fm1 destination: description: 'The destination address or hostname provided in the request that the operation is run against. ' type: string readOnly: true example: 181.44.543.12 details: description: 'Giant text block that contains raw output of the operation and a client needs to parse. ' type: string readOnly: true source: description: 'The address where the check starts. Can be a subnet or IP inside the subnet. ' type: string readOnly: true example: net1 NetworkInterfacesPortDetailsResponse: type: object properties: items: description: 'A list of port details objects. ' type: array items: $ref: '#/components/schemas/NetworkInterfacesPortDetails' HardwareConnectorPerformance: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: link_aggregation_group: description: The link aggregation group which this entity belongs to. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' other_errors_per_sec: description: 'The sum of unspecified reception and transmission errors per second. ' type: integer format: int64 minimum: 0 readOnly: true received_bytes_per_sec: description: 'Bytes received per second. ' type: integer format: int64 minimum: 0 readOnly: true received_crc_errors_per_sec: description: 'Reception CRC errors per second. ' type: integer format: int64 minimum: 0 readOnly: true received_frame_errors_per_sec: description: 'Received packet frame errors per second. ' type: integer format: int64 minimum: 0 readOnly: true received_packets_per_sec: description: 'Packets received per second. ' type: integer format: int64 minimum: 0 readOnly: true time: description: 'Sample time in milliseconds since UNIX epoch. ' type: integer format: int64 readOnly: true total_errors_per_sec: description: 'The sum of all reception and transmission errors per second. ' type: integer format: int64 minimum: 0 readOnly: true transmitted_bytes_per_sec: description: 'Bytes transmitted per second. ' type: integer format: int64 minimum: 0 readOnly: true transmitted_carrier_errors_per_sec: description: 'Transmission carrier errors per second. ' type: integer format: int64 minimum: 0 readOnly: true transmitted_dropped_errors_per_sec: description: 'Transmitted packets dropped per second. ' type: integer format: int64 minimum: 0 readOnly: true transmitted_packets_per_sec: description: 'Packets transmitted per second. ' type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true NetworkInterfacesPortDetails: description: 'Network interface SFP details. ' allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: interface_type: description: 'The interface type. Valid values are `eth` and `fc`. ' type: string readOnly: true rx_los: description: 'Displays status flags for Rx LOS. A value of `true` indicates Rx Loss-of-Signal. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. ' type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsRx_los' rx_power: description: 'Displays real-time measurement of Rx input power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. ' type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsRx_power' static: title: NetworkInterfacePortDetailsStatic allOf: - $ref: '#/components/schemas/_networkInterfacePortDetailsStatic' temperature: description: 'Displays real-time measurement of transceiver temperature and range. If the transceiver does not support digital diagnostic monitoring, the array is empty. ' type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTemperature' tx_bias: description: 'Displays real-time measurement of Tx bias current and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. ' type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTx_bias' tx_fault: description: 'Displays status flags for Tx Fault. A value of `true` indicates transmitter/laser fault. For four-lane modules, the array contains a flag for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. ' type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTx_fault' tx_power: description: 'Displays real-time measurement of Tx output power and whether it is within range. For four-lane modules, the array contains a measurement and status for each channel. If the transceiver does not support digital diagnostic monitoring, the array is empty. ' type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsTx_power' voltage: description: 'Displays real-time measurement of supply voltage and whether it is within range. If the transceiver does not support digital diagnostic monitoring, the array is empty. ' type: array readOnly: true items: $ref: '#/components/schemas/_networkInterfacePortDetailsVoltage' x-readOnly: true PageInfo_3: type: object properties: continuation_token: description: 'Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My total_item_count: description: Total number of items after applying filter params. type: integer format: int32 example: 1 _networkInterfaceEth: description: Ethernet network interface properties. type: object properties: address: description: 'The IPv4 or IPv6 address to be associated with the specified network interface. ' type: string gateway: description: 'The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network. ' type: string mac_address: description: 'The media access control address associated with the specified network interface. ' type: string readOnly: true mtu: description: 'Maximum message transfer unit (packet) size for the network interface, in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. ' type: integer format: int32 netmask: description: 'Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface. ' type: string subinterfaces: description: 'List of network interfaces configured to be a subinterface of the specified network interface. ' type: array items: $ref: '#/components/schemas/_fixedReferenceNoId' subnet: description: 'Subnet that is associated with the specified network interface. ' title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' subtype: description: 'The subtype of the specified network interface. Only interfaces of subtype `virtual` can be created. Configurable on POST only. Valid values are `failover_bond`, `lacp_bond`, `physical`, and `virtual`. ' type: string vlan: description: VLAN ID type: integer format: int32 readOnly: true _referenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string _networkInterfacePortDetailsStaticTxPowerThresholds: description: 'The alarm low, warn low, warn high, alarm high thresholds for Tx output power in mW. ' type: object properties: alarm_high: description: The alarm high threshold for Tx output power in mW. type: number format: double alarm_low: description: The alarm low threshold for Tx output power in mW. type: number format: double warn_high: description: The warn high threshold for Tx output power in mW. type: number format: double warn_low: description: The warn low threshold for Tx output power in mW. type: number format: double _networkInterfacePortDetailsRx_los: type: object properties: channel: description: 'The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. ' type: integer example: 0 flag: description: A value of `true` indicates Rx Loss-of-Signal. type: boolean _networkInterfacePortDetailsTx_fault: type: object properties: channel: description: 'The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. ' type: integer example: 0 flag: description: A value of `true` indicates transmitter/laser fault. type: boolean _referenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string _errorErrors: type: object properties: context: type: string example: Error with ... message: type: string example: Something was wrong _arrays: type: object properties: arrays: description: 'The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceFqdn' x-readOnly: true _arraysBuiltIn: description: 'A built-in resource that exists on one or multiple arrays. ' allOf: - $ref: '#/components/schemas/_builtInAsOf' - $ref: '#/components/schemas/_arrays' _fixedReferenceNoId: type: object properties: name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true NetworkInterfacePerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: A list of performance objects. type: array items: $ref: '#/components/schemas/NetworkInterfacePerformance' total: description: 'The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each field where meaningful. ' type: array items: $ref: '#/components/schemas/NetworkInterfacePerformance' NetworkInterfacePatch_2: type: object properties: address: description: 'The IPv4 or IPv6 address to be associated with the specified network interface. ' type: string attached_servers: description: 'List of servers to be associated with the specified network interface for data ingress. At most one server can be specified for each interface. To attach the network interface to a server, name or id the desired server must be provided. To detach a network interface from all servers, an empty list [] should be passed to the attached_servers field. If services include ''data'' and attached_servers was [] then attached_servers defaults to [_array_server]. ' type: array items: $ref: '#/components/schemas/_referenceWithoutType' services: description: Services and protocols that are enabled on the interface. type: array items: type: string description: 'Valid values are `data`, `egress-only`, `management`, `replication`, and `support`. ' _networkInterfaceFc: description: Fibre Channel port properties. type: object properties: wwn: description: World Wide Name of the specified Fibre Channel port. type: string readOnly: true _networkInterfacePortDetailsTemperature: type: object properties: channel: description: 'The channel number if the diagnostic has an associated channel number. If not specified, defaults to `null`. ' type: integer example: 0 measurement: description: 'Temperature in degrees Celsius. ' type: number format: double status: description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for temperature. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. ' type: string example: ok _networkInterfacePortDetailsStaticRxPowerThresholds: description: 'The alarm low, warn low, warn high, alarm high thresholds for Rx input power in mW. ' type: object properties: alarm_high: description: The alarm high threshold for Rx input power in mW. type: number format: double alarm_low: description: The alarm low threshold for Rx input power in mW. type: number format: double warn_high: description: The warn high threshold for Rx input power in mW. type: number format: double warn_low: description: The warn low threshold for Rx input power in mW. type: number format: double NetworkInterface: allOf: - $ref: '#/components/schemas/_context' - $ref: '#/components/schemas/_builtInResourceNoId' - $ref: '#/components/schemas/_serverReference' - type: object properties: attached_servers: description: 'List of servers associated with the specified network interface for data ingress. ' type: array maxItems: 1 items: $ref: '#/components/schemas/_fixedReferenceWithType' enabled: description: 'Returns a value of `true` if the specified network interface or Fibre Channel port is enabled. Returns a value of `false` if the specified network interface or Fibre Channel port is disabled. ' type: boolean readOnly: true eth: $ref: '#/components/schemas/_networkInterfaceEth' fc: $ref: '#/components/schemas/_networkInterfaceFc' interface_type: description: 'The interface type. Valid values are `eth` and `fc`. ' type: string readOnly: true services: description: 'The services provided by the specified network interface or Fibre Channel port. ' type: array readOnly: true items: type: string description: 'Valid values include `iscsi`, `management`, `nvme-fc`, `nvme-roce`, `nvme-tcp`, `offload`, `replication`, and `scsi-fc`. ' speed: description: 'Configured speed of the specified network interface or Fibre Channel port (in Gb/s). Typically this is the maximum speed of the port or bond represented by the network interface. ' type: integer format: int64 readOnly: true _serverReference: description: 'An object that is server-aware and can be associated to a server. ' type: object properties: server: description: 'Reference to the server the object belongs to. When the value is empty or set to `null` it means the object lives outside of a server scope. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _fixedReferenceFqdn: allOf: - $ref: '#/components/schemas/_fixedReference_3' - type: object properties: fqdn: description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`, `null` otherwise. ' type: string readOnly: true example: example_name.dc1.example.com NetworkInterfaceNeighborGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/NetworkInterfaceNeighborResponse' _networkInterfacePortDetailsStaticTemperatureThresholds: description: 'The alarm low, warn low, warn high, alarm high thresholds for temperature in degrees Celsius. ' type: object properties: alarm_high: description: The alarm high threshold for temperature in degrees Celsius. type: number format: double alarm_low: description: The alarm low threshold for temperature in degrees Celsius. type: number format: double warn_high: description: The warn high threshold for temperature in degrees Celsius. type: number format: double warn_low: description: The warn low threshold for temperature in degrees Celsius. type: number format: double _fixedReference_2: allOf: - $ref: '#/components/schemas/_fixedReferenceWithoutType' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true _builtInResourceNoId: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs, file systems, file system snapshots, volume snapshot). ' type: object properties: name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true _networkInterfaceNeighborNeighborChassisId: description: 'An administratively assigned identifier of the particular neighboring chassis. ' type: object properties: type: description: 'The chassis ID subtype. Valid values are `ifname`, `ifalias`, `local`, `mac`, `ip`, and `unhandled`. ' type: string example: mac value: description: The specific identifier for the particular chassis. type: string example: 00:12:ab:cd:ab:cd PageInfo: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string more_items_remaining: description: 'Returns a value of `true` if subsequent items can be retrieved. ' type: boolean example: false total_item_count: description: 'The total number of records after applying all filter query parameters. The `total_item_count` will be calculated if and only if the corresponding query parameter `total_item_count` is set to `true`. If this query parameter is not set or set to `false`, a value of `null` will be returned. ' type: integer format: int32 NetworkInterfacesConnectorsPerformance: allOf: - $ref: '#/components/schemas/HardwareConnectorPerformance' - type: object properties: flow_control_received_congestion_packets_per_sec: description: 'Number of congestion control packets received per second. ' type: integer format: int64 minimum: 0 readOnly: true flow_control_received_discarded_packets_per_sec: description: 'Number of received packets that were physically discarded per second due to errors or other reasons. ' type: integer format: int64 minimum: 0 readOnly: true flow_control_received_lossless_bytes_per_sec: description: 'Bytes received per second with lossless flow control settings. ' type: integer format: int64 minimum: 0 readOnly: true flow_control_received_pause_frames_per_sec: description: 'Received pause frames per second. ' type: integer format: int64 minimum: 0 readOnly: true flow_control_transmitted_congestion_packets_per_sec: description: 'Number of congestion control packets transmitted per second. ' type: integer format: int64 minimum: 0 readOnly: true flow_control_transmitted_discarded_packets_per_sec: description: 'Number of transmitted packets that were physically discarded by the NIC per second due to errors or other reasons. ' type: integer format: int64 minimum: 0 readOnly: true flow_control_transmitted_lossless_bytes_per_sec: description: 'Bytes transmitted per second with lossless flow control settings. ' type: integer format: int64 minimum: 0 readOnly: true flow_control_transmitted_pause_frames_per_sec: description: 'Transmitted pause frames per second. ' type: integer format: int64 minimum: 0 readOnly: true rdma_received_req_cqe_errors_per_sec: description: 'The number of times port detected RDMA CQEs with error per second. ' type: integer format: int64 minimum: 0 readOnly: true rdma_received_sequence_errors_per_sec: description: 'The number of received RDMA packet sequence errors per second. ' type: integer format: int64 minimum: 0 readOnly: true rdma_transmitted_local_ack_timeout_errors_per_sec: description: 'The number of times RDMA ack timer expired for QPs per second. ' type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true _errorContextResponse: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorcontextresponseErrors' _networkInterfaceNeighborCapability: type: object properties: enabled: description: 'If true, this capability is enabled by this neighbor; false otherwise. ' type: boolean readOnly: true example: false supported: description: 'If true, this capability is supported by this neighbor; false otherwise. ' type: boolean readOnly: true example: false x-readOnly: true NetworkInterfacePost: allOf: - $ref: '#/components/schemas/_builtInResourceNoId' - type: object properties: attached_servers: description: 'Applies only to Ethernet interfaces. The list of servers to be associated with the specified network interface for data ingress. At most one server can be specified for each interface. To attach the network interface to a server, the name or id of the desired server must be provided. If not specified and the interface is created at the array level, defaults to the _array_server instance. If not specified and the interface is created within a server, defaults to that server. To create a network interface that is not attached to any server, specify an empty list []. ' type: array maxItems: 1 items: $ref: '#/components/schemas/_reference' eth: $ref: '#/components/schemas/_networkinterfacepostEth' services: description: 'The services provided by the specified network interface or Fibre Channel port. ' type: array items: type: string description: 'Valid values include `iscsi`, `management`, `nvme-fc`, `nvme-roce`, `nvme-tcp`, `offload`, `replication` and `scsi-fc`. ' NetworkInterfaceResponse_2: type: object properties: items: description: A list of network interface objects. type: array items: $ref: '#/components/schemas/NetworkInterface_2' Error: type: object properties: errors: description: The list of errors encountered. type: array items: $ref: '#/components/schemas/_errorErrors' NetworkInterfacesConnectorsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/NetworkInterfacesConnectorsResponse' _reference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string x-aliases: - _referenceWithoutType _networkInterfaceNeighborNeighborChassis: description: 'The neighboring physical component incorporating one or more IEEE 802 LAN stations and their associated application functionality. ' type: object properties: addresses: description: Management IP addresses of the neighbor. type: array items: type: string example: 10.202.101.70 bridge: description: Bridge capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' description: description: 'The textual description of the neighbor. The description may include the full name and version identification of the system hardware type, software operating system, and networking software. ' type: string example: Example Switch iscsi-sw-100-b version 1.0 docsis_cable_device: description: DOCSIS cable device capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' id: $ref: '#/components/schemas/_networkInterfaceNeighborNeighborChassisId' name: description: Administratively assigned name of the neighbour. type: string example: iscsi-sw-100-b.example.com repeater: description: Neighbor system's repeater capability. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' router: description: IP router capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' station_only: description: Station only status of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' telephone: description: Telephone capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' wlan_access_point: description: WLAN access point capability of the neighbor system. title: NetworkInterfaceNeighborCapability allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborCapability' _errorcontextresponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' message: description: A description of the error which occurred. type: string example: Resource does not exist. x-aliases: - _errorContextResponseErrors _networkInterfacePortDetailsTx_bias: type: object properties: channel: description: 'The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. ' type: integer example: 0 measurement: description: 'Tx bias current in mA. ' type: number format: double status: description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Tx bias current. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. ' type: string example: ok NetworkConnectionStatisticsGetResponse: allOf: - $ref: '#/components/schemas/NetworkConnectionStatisticsResponse' NetworkInterfacesConnectorsSettingRoceEcn: description: 'Default ECN(Explicit Network Notification) configuration for network connectors. ' allOf: - type: object properties: marking_probability: description: 'The ECN marking probability when min ECN marked threshold is reached. ' type: number format: float readOnly: true max_ecn_marked_threshold: description: 'The maximum threshold value in bytes at which the packets start being marked with ECN at the highest probability or dropped. ' type: integer format: int32 readOnly: true min_ecn_marked_threshold: description: 'The minimum threshold value in bytes at which the packets start being marked with ECN. ' type: integer format: int32 readOnly: true NetworkInterfacesConnectorsSetting: description: The global network setting for all network connectors. allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: roce: description: 'RoCE(RDMA over Converged Ethernet) configuration for network connectors. ' title: NetworkInterfacesConnectorsSettingRoce allOf: - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRoce' _networkInterfaceInfo: type: object properties: address: description: The address of the network interface. type: string readOnly: true example: 168.192.0.1 port: description: The port number of the network interface. type: string readOnly: true example: '8080' x-readOnly: true _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true x-aliases: - _fixedReference NetworkInterfaceNeighbor: type: object properties: initial_ttl_in_sec: description: 'The initial time to live in seconds from when the local port received notice that the neighbor information is regarded as valid. The time is not measured from when this endpoint was queried. ' type: integer format: uint32 readOnly: true example: 120 local_port: description: 'A reference to the local network interface the neighbor is connected to. ' title: FixedReferenceNoId allOf: - $ref: '#/components/schemas/_fixedReferenceNoId' neighbor_chassis: title: NetworkInterfaceNeighborNeighborChassis allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborChassis' neighbor_port: title: NetworkInterfaceNeighborNeighborPort allOf: - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborPort' x-readOnly: true NetworkInterfacesConnectorsSettingsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - type: object properties: items: description: A list of global network settings for network connectors. type: array items: $ref: '#/components/schemas/NetworkInterfacesConnectorsSetting' NetworkInterfacesConnectorsResponse: type: object properties: items: description: A list of network connector objects. type: array items: $ref: '#/components/schemas/HardwareConnector' _context: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _networkInterfacePerformanceEth: description: 'Ethernet network interface statistics. ' type: object properties: flow_control_received_congestion_packets_per_sec: description: 'Number of congestion control packets received per second. ' type: integer format: int64 minimum: 0 flow_control_received_discarded_packets_per_sec: description: 'Number of received packets that were physically discarded by the NIC per second due to errors or other reasons. ' type: integer format: int64 minimum: 0 flow_control_received_lossless_bytes_per_sec: description: 'Bytes received per second with lossless flow control settings. ' type: integer format: int64 minimum: 0 flow_control_received_pause_frames_per_sec: description: 'Received pause frames per second. ' type: integer format: int64 minimum: 0 flow_control_transmitted_congestion_packets_per_sec: description: 'Number of congestion control packets transmitted per second. ' type: integer format: int64 minimum: 0 flow_control_transmitted_discarded_packets_per_sec: description: 'Number of transmitted packets that were physically discarded by the NIC per second due to errors or other reasons. ' type: integer format: int64 minimum: 0 flow_control_transmitted_lossless_bytes_per_sec: description: 'Bytes transmitted per second with lossless flow control settings. ' type: integer format: int64 minimum: 0 flow_control_transmitted_pause_frames_per_sec: description: 'Transmitted pause frames per second. ' type: integer format: int64 minimum: 0 other_errors_per_sec: description: 'This field has been deprecated. Since Purity version 6.6.8, this will always return `null`. The sum of unspecified reception and transmission errors per second. ' type: integer format: int64 minimum: 0 rdma_received_req_cqe_errors_per_sec: description: 'The number of times port detected RDMA CQEs with error per second. ' type: integer format: int64 minimum: 0 rdma_received_sequence_errors_per_sec: description: 'The number of received RDMA packet sequence errors per second. ' type: integer format: int64 minimum: 0 rdma_transmitted_local_ack_timeout_errors_per_sec: description: 'The number of times RDMA ack timer expired for QPs per second. ' type: integer format: int64 minimum: 0 received_bytes_per_sec: description: 'Bytes received per second. ' type: integer format: int64 minimum: 0 received_crc_errors_per_sec: description: 'Reception CRC errors per second. ' type: integer format: int64 minimum: 0 received_frame_errors_per_sec: description: 'Received packet frame errors per second. ' type: integer format: int64 minimum: 0 received_packets_per_sec: description: 'Packets received per second. ' type: integer format: int64 minimum: 0 total_errors_per_sec: description: 'The sum of all reception and transmission errors per second. ' type: integer format: int64 minimum: 0 transmitted_bytes_per_sec: description: 'Bytes transmitted per second. ' type: integer format: int64 minimum: 0 transmitted_carrier_errors_per_sec: description: 'Transmission carrier errors per second. ' type: integer format: int64 minimum: 0 transmitted_dropped_errors_per_sec: description: 'Transmitted packets dropped per second. ' type: integer format: int64 minimum: 0 transmitted_packets_per_sec: description: 'Packets transmitted per second. ' type: integer format: int64 minimum: 0 NetworkInterface_2: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_realmsReference' - type: object properties: address: description: 'The IPv4 or IPv6 address to be associated with the specified network interface. ' type: string attached_servers: description: 'List of servers that are using this interface for data ingress. When services include ''data'' defaults to [_array_server], otherwise to []. ' type: array items: $ref: '#/components/schemas/_reference_2' enabled: description: 'Indicates if the specified network interface is enabled (`true`) or disabled (`false`). If not specified, defaults to `true`. ' type: boolean readOnly: true gateway: description: Derived from `subnet.gateway`. type: string readOnly: true mtu: description: Derived from `subnet.mtu`. type: integer format: int32 readOnly: true netmask: description: Derived from `subnet.prefix`. type: string readOnly: true services: description: Services and protocols that are enabled on the interface. type: array items: type: string description: 'Valid values are `data`, `egress-only`, `management`, `replication`, and `support`. ' subnet: type: object allOf: - $ref: '#/components/schemas/_fixedReference_2' - type: object readOnly: true type: description: 'The only valid value is `vip`. ' type: string vlan: description: Derived from `subnet.vlan`. type: integer format: int32 readOnly: true _reference_2: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and `policies/snapshot`, etc. ' type: string readOnly: true x-aliases: - _referenceWithFixedType NetworkInterfaceTrace: description: 'Output from running the linux command ''traceroute'' directly on the array with start and end location information. ' type: object properties: component_name: description: Name of the component running the check. type: string readOnly: true example: ch1-fm1 destination: description: 'The destination address or hostname provided in the request that the operation is run against. ' type: string readOnly: true example: 181.44.543.12 details: description: 'Giant text block that contains raw output of the operation and a client needs to parse. ' type: string readOnly: true source: description: 'The address where the check starts. Can be a subnet or IP inside the subnet. ' type: string readOnly: true example: net1 _networkInterfacePortDetailsStatic: description: 'Static module identity and capabilities information for the specified network interface or Fibre Channel port. ' type: object properties: cable_technology: description: 'The SFP+ cable technology supported by the transceiver. ' type: array items: type: string example: Active Cable connector_type: description: 'The media connector type of the transceiver. ' type: string example: LC encoding: description: 'The serial encoding algorithm of the transceiver. ' type: string example: 64B/66B extended_identifier: description: 'The extended identifier of the transceiver type. ' type: string example: GBIC/SFP function is defined by 2-wire interface ID only fc_link_lengths: description: 'The Fibre Channel distance capabilities supported by the transceiver. ' type: array items: type: string example: short distance (S) fc_speeds: description: The Fibre Channel speeds supported by the transceiver. Speeds are in units of 100 MBytes/sec, which correspond to GFC (Gb/s). type: string example: 16|32|64 Gb/s fc_technology: description: 'The Fibre Channel technologies supported by the transceiver. ' type: array items: type: string example: Electrical intra-enclosure (EL) fc_transmission_media: description: 'The Fibre Channel transmission media supported by the transceiver. ' type: array items: type: string example: Multimode, 62.5um (M6) identifier: description: 'The transceiver type. ' type: string example: SFP or SFP+ link_length: description: 'Link length and cable attenuation (for active or copper cables) for the specified transceiver. Values are comma-separated lists of fields and values, where each field is separated from its corresponding value by a colon. Valid fields include `Copper Cable Attenuation (12.9 GHz)`, `Copper Cable Attenuation (25.78 GHz)`, `Copper Cable`, `SMF`, `OM2`, `OM1`, `OM4`, and `OM3`. The unit for attenuation is dB, and the units for length are meters or kilometers. Unspecified fields are omitted. ' type: string example: 'OM2: 40 m, OM1: 20 m, OM3: 100 m' rate_identifier: description: 'The type of rate select functionality of the transceiver. ' type: string example: FC-PI-5 (16/8/4G Independent Rx, Tx Rate_select) rx_power_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticRxPowerThresholds' signaling_rate: description: 'The nominal signaling rate in MBd, rounded off to the nearest 100 MBd, or if greater than 25400 MBd, rounded off to the nearest 250 MBd. The value can be unspecified. ' type: string example: 14000 MBd signaling_rate_max: description: 'The upper signaling rate limit at which the transceiver still meets its specifications, specified as a percentage above the nominal signaling rate. The value can be unspecified. ' type: string example: 1% signaling_rate_min: description: 'The lower signaling rate limit at which the transceiver still meets its specifications, specified as a percentage below the nominal signaling rate. The value can be unspecified. ' type: string example: 1% specifications: description: 'The Ethernet, 10G Ethernet, ESCON, Infiniband, SONET, and other specifications supported by the transceiver. ' type: array items: type: string example: 1000BASE-T temperature_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticTemperatureThresholds' tx_bias_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticTxBiasThresholds' tx_power_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticTxPowerThresholds' vendor_date_code: description: 'The SFP vendor''s manufacturing date code. The first six characters are the date in YYMMDD format, and the last two characters are the vendor specific lot code. The last two characters are optional. ' type: string maxLength: 8 example: '190221' vendor_name: description: The SFP vendor name. type: string maxLength: 16 example: EMULEX vendor_oui: description: The SFP vendor IEEE company ID. type: string maxLength: 8 example: 00-17-6A vendor_part_number: description: The part number provided by the SFP vendor. type: string maxLength: 16 example: ABCD-12E3FG-ELX vendor_revision: description: The revision level for the part number provided by the SFP vendor. type: string maxLength: 4 vendor_serial_number: description: The serial number provided by the SFP vendor. type: string maxLength: 16 example: AB1234C56DE voltage_thresholds: $ref: '#/components/schemas/_networkInterfacePortDetailsStaticVoltageThresholds' wavelength: description: 'Laser wavelength (for optical variants) at room temperature, in units of nm. For passive and active cable variants, the value is unspecified. ' type: string example: 850 nm PageInfo_2: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the `continuation_token` to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The `continuation_token` is generated if the `limit` is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string total_item_count: description: Total number of items after applying `filter` params. type: integer format: int32 NetworkInterfaceGetResponse_3: allOf: - $ref: '#/components/schemas/PageInfo_3' - $ref: '#/components/schemas/NetworkInterfaceResponse_3' NetworkInterfacePingResponse: type: object properties: items: description: A list of network ping run result. type: array items: $ref: '#/components/schemas/NetworkInterfacePing' _fixedReference_3: type: object properties: id: description: The opaque and unique id of this resource. type: string readOnly: true example: 2a989a09-c851-4d52-9ec6-ab728b1c04db name: description: The name of this resource. type: string readOnly: true example: example_name resource_type: description: 'The type of this resource represented by the name of its REST endpoint. For example, "arrays", "network-interfaces", and "metrics". The value may be `null` if the resource is not represented. ' type: string readOnly: true example: example_resource_type x-readOnly: true _networkinterfacepatchEth: description: Ethernet network interface properties. type: object properties: add_subinterfaces: description: 'Child devices to be added to the specified bond interface. ' type: array items: $ref: '#/components/schemas/_referenceNoId' address: description: 'The IPv4 or IPv6 address to be associated with the specified network interface. ' type: string gateway: description: 'The IPv4 or IPv6 address of the gateway through which the specified network interface is to communicate with the network. ' type: string mtu: description: 'Maximum message transfer unit (packet) size for the network interface in bytes. MTU setting cannot exceed the MTU of the corresponding physical interface. ' type: integer format: int32 netmask: description: 'Netmask of the specified network interface that, when combined with the address of the interface, determines the network address of the interface. ' type: string remove_subinterfaces: description: 'Child devices to be removed from the specified bond interface. ' type: array items: $ref: '#/components/schemas/_referenceNoId' subinterfaces: description: 'Child devices to be added to the specified bond interface. ' type: array items: $ref: '#/components/schemas/_referenceNoId' subnet: description: 'Subnet that is associated with the specified network interface. ' title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' NetworkInterfacesConnectorsSettingRocePfc: description: 'Default PFC(Priority Flow Control) configuration for network connectors. ' allOf: - type: object properties: port_buffer: description: 'The buffer size in bytes reserved to absorb in-flight packets after XOFF threshold is reached. ' type: integer format: int32 readOnly: true xoff_threshold: description: 'The PFC XOFF threshold value in bytes. When the buffer for a particular traffic class reaches this threshold, the pause frame(XOFF) will be transimitted to the sender, requesting it to stop sending packets for that class. ' type: integer format: int32 readOnly: true xon_threshold: description: 'The PFC XON threshold value in bytes. When the buffer for a particular traffic class drops below this threshold, the un-pause frame(XON) will be transmitted to the sender, requesting it to resume sending packets for that class. ' type: integer format: int32 readOnly: true NetworkConnectionStatisticsResponse: type: object properties: items: description: 'A list of network connection statistics ' type: array items: $ref: '#/components/schemas/NetworkConnectionStatistics' _networkInterfaceNeighborNeighborPort: description: 'The neighboring port connected to the FlashArray local port. ' type: object properties: description: description: A description of the neighbor port. type: string example: eth7 id: $ref: '#/components/schemas/_networkInterfaceNeighborNeighborPortId' _fixedReferenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true _resourceNoId: description: 'An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the environment, like a host or a server. ' type: object properties: name: description: 'A user-specified name. The name must be locally unique and can be changed. ' type: string NetworkInterfacePingGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/NetworkInterfacePingResponse' NetworkConnectionStatistics: description: 'Returns the status of the network connections on the array at the time of the operation. ' type: object properties: current_state: description: 'Valid values include `CLOSE_WAIT`, `CLOSED`, `ESTABLISHED`, `FIN_WAIT_1`, `FIN_WAIT_2`, `LAST_ACK`, `LISTEN`, `SYN_RECEIVED`, `SYN_SEND`, and `TIME_WAIT` ' type: string readOnly: true example: TIME_WAIT local: description: 'The information of the array''s network interface to which the remote connection is bound. ' title: NetworkInterfaceInfo allOf: - $ref: '#/components/schemas/_networkInterfaceInfo' remote: description: 'Network information of the remote peer that has connected to the array''s network interface. ' title: NetworkInterfaceInfo allOf: - $ref: '#/components/schemas/_networkInterfaceInfo' time: description: The time the operation was run. type: integer format: int64 readOnly: true example: 1735596861 NetworkInterfacesConnectorsPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - type: object properties: items: description: A list of network connector performance objects. type: array items: $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformance' total: description: 'Total of all records after filtering. If `total_only` query param is `true`, then no individual items will be returned. ' type: array items: $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformance' _networkInterfacePortDetailsStaticVoltageThresholds: description: 'The alarm low, warn low, warn high, alarm high thresholds for supply voltage (in volts). ' type: object properties: alarm_high: description: The alarm high threshold for supply voltage in volts. type: number format: double alarm_low: description: The alarm low threshold for supply voltage in volts. type: number format: double warn_high: description: The warn high threshold for supply voltage in volts. type: number format: double warn_low: description: The warn low threshold for supply voltage in volts. type: number format: double NetworkInterfaceTraceResponse: type: object properties: items: description: A list of network trace run result. type: array items: $ref: '#/components/schemas/NetworkInterfaceTrace' _networkInterfacePortDetailsRx_power: type: object properties: channel: description: 'The channel number if the transceiver is a multilane transceiver. If not specified, defaults to `null`. ' type: integer example: 0 measurement: description: 'Rx input power in mW. ' type: number format: double status: description: 'Indicates whether the measurement is outside the high alarm, low alarm, high warning, or low warning thresholds for Rx input power. Valid values are `alarm low`, `alarm high`, `warn low`, `warn high`, and `ok`. ' type: string example: ok _networkinterfacepostEth: description: Ethernet network interface properties. type: object properties: address: description: 'The IPv4 or IPv6 address to be associated with the specified network interface. ' type: string subinterfaces: description: 'List of network interfaces configured to be a subinterface of the specified network interface. ' type: array items: $ref: '#/components/schemas/_referenceNoId' subnet: description: 'Subnet that is associated with the specified network interface. ' title: ReferenceNoId allOf: - $ref: '#/components/schemas/_referenceNoId' subtype: description: 'The subtype of the specified network interface. Only interfaces of subtype `vif` and `lacp_bond` can be created. Configurable on POST only. Valid values are `failover_bond`, `lacp_bond`, `physical`, and `vif`. If the subtype is `vif`, the services parameter must not be set. ' type: string NetworkInterfaceGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/NetworkInterfaceResponse_2' _realmsReference: type: object properties: realms: description: 'Reference to the realms this resource belongs to. The value is set to empty array when the resource lives outside of a realm. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReference_2' _networkInterfacePortDetailsStaticTxBiasThresholds: description: 'The alarm low, warn low, warn high, alarm high thresholds for Tx bias current in mA. ' type: object properties: alarm_high: description: The alarm high threshold for Tx bias current in mA. type: number format: double alarm_low: description: The alarm low threshold for Tx bias current in mA. type: number format: double warn_high: description: The warn high threshold for Tx bias current in mA. type: number format: double warn_low: description: The warn low threshold for Tx bias current in mA. type: number format: double _fixedReference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true x-aliases: - _fixedReferenceWithoutType parameters: Packet_size: name: packet_size in: query description: 'Used by ping to specify the number of data bytes to be sent per packet. If not specified, defaults to 56. ' schema: type: integer format: int32 example: 56 Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 example: 10 History_start_time: name: start_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 Authorization_2: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`) ' schema: type: string Ids: name: ids in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `ids`, then an error is returned. This cannot be provided together with the `name` or `names` query parameters. ' style: form explode: false schema: type: array items: type: string Filter_2: name: filter in: query description: 'Exclude resources that don''t match the specified criteria. Single quotes are required around all strings inside the filters. ' schema: type: string Print_latency: name: print_latency in: query description: 'Used by ping to specify whether or not to print the full user-to-user latency. If not specified, defaults to false. ' schema: type: boolean Sort: name: sort in: query description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Mtu: name: discover_mtu in: query description: 'Used by trace to specify whether or not to discover the MTU along the path being traced. If not specified, defaults to false. ' schema: type: boolean Allow_errors: name: allow_errors in: query description: 'If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors. ' schema: type: boolean default: false Ping_count: name: count in: query description: 'Used by ping to specify the number of packets to send. If not specified, defaults to 1. ' schema: type: integer format: int32 Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Limit_2: name: limit in: query description: 'Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client''s page size request. If not specified, defaults to 1000. ' schema: type: integer format: int32 Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Sort_2: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). NOTE: If you provide a sort you will not get a `continuation_token` in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Ids_2: name: ids in: query description: 'A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Names_required: name: names in: query description: 'A comma-separated list of resource names. ' required: true style: form explode: false schema: type: array items: type: string Sort_3: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). If you provide a sort you will not get a continuation token in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Port: name: port in: query description: 'Used by trace to specify a destination port. ' schema: type: string NetworkConnectionStatisticsLocal_host: name: local_host in: query description: 'The local IP address to filter the results by. If specified, the results will only include connections that are either to or from the specified local host. ' style: form explode: false schema: type: array items: type: string Resolution: name: resolution in: query description: 'The desired ms between samples. Available resolutions may depend on data type, `start_time` and `end_time`. In general `1000`, `30000`, `300000`, `1800000`, `7200000`, and `86400000` are possible values. ' schema: type: integer format: int64 minimum: 0 example: 30000 Total_only: name: total_only in: query description: 'If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. ' schema: type: boolean Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Start_time: name: start_time in: query description: 'When the time window starts (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 Local_port_names: name: local_port_names in: query description: 'Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, `ct0.eth0,ct1.eth0`. ' style: form explode: false schema: type: array items: type: string History_end_time: name: end_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 Resolve_hostname: name: resolve_hostname in: query description: 'Used by ping and trace to specify whether or not to map IP addresses to host names. If not specified, defaults to true. ' schema: type: boolean Local_port_names_2: name: local_port_names in: query description: 'Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, `CH1.FM2.ETH1,CH1.FM1.ETH2`. ' style: form explode: false schema: type: array items: type: string Context_names: name: context_names in: query description: 'Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' style: form explode: false schema: type: array items: type: string Continuation_token_2: name: continuation_token in: query description: 'An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings. ' schema: type: string x-quoted: true x-quoted: true NetworkConnectionStatisticsCurrent_state: name: current_state in: query description: 'The state to filter the results by. If specified, the results will only include connections which current state matches the specified states. ' style: form explode: false schema: type: array items: type: string Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string NetworkConnectionStatisticsRemote_host: name: remote_host in: query description: 'The remote IP address to filter the results by. If specified, the results will only include connections that are either to or from the specified remote host. ' style: form explode: false schema: type: array items: type: string Total_item_count: name: total_item_count in: query description: 'If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. ' schema: type: boolean NetworkConnectionStatisticsLocal_port: name: local_port in: query description: 'The local port to filter the results by. If specified, the results will only include connections that are either to or from the specified local port. ' style: form explode: false schema: type: array items: type: integer Method: name: method in: query description: 'Used by trace to specify which method to use for trace operations. Valid values are `icmp`, `tcp`, and `udp`. If not specified, defaults to ''udp''. ' schema: type: string History_resolution: name: resolution in: query description: 'The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution. ' schema: type: integer format: int64 minimum: 0 example: 30000 Offset_3: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 NetworkConnectionStatisticsRemote_port: name: remote_port in: query description: 'The remote port to filter the results by. If specified, the results will only include connections that are either to or from the specified remote port. ' style: form explode: false schema: type: array items: type: integer Names_2: name: names in: query description: 'A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Ping_trace_source: name: source in: query description: 'Used by ping and trace to specify the property where to start to run the specified operation. The property can be subnet or IP. ' schema: type: string Ping_trace_component: name: component_name in: query description: 'Used by ping and trace to specify where to run the operation. Valid values are controllers and blades from hardware list. If not specified, defaults to all available controllers and selected blades. ' schema: type: string Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string Ping_trace_destination: name: destination in: query description: 'A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. ' required: true schema: type: string example: www.test.com Fragment_packet: name: fragment_packet in: query description: 'Used by trace to specify whether or not to fragment packets. If not specified, defaults to true. ' schema: type: boolean End_time: name: end_time in: query description: 'When the time window ends (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 responses: Error403: description: FORBIDDEN headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' Error400: description: BAD REQUEST headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error429: description: TOO MANY REQUESTS headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' Error500: description: INTERNAL SERVER ERROR headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error404: description: NOT FOUND headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error'