All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| NetworkInterfacesDelete | Delete /api/2.56/network-interfaces | Delete network interface |
| NetworkInterfacesGet | Get /api/2.56/network-interfaces | List network interfaces |
| NetworkInterfacesNeighborsGet | Get /api/2.56/network-interfaces/neighbors | List network interface neighbors |
| NetworkInterfacesPatch | Patch /api/2.56/network-interfaces | Modify network interface |
| NetworkInterfacesPerformanceGet | Get /api/2.56/network-interfaces/performance | List network performance statistics |
| NetworkInterfacesPortDetailsGet | Get /api/2.56/network-interfaces/port-details | List SFP port details |
| NetworkInterfacesPost | Post /api/2.56/network-interfaces | Create network interface |
NetworkInterfacesDelete(ctx).Authorization(authorization).XRequestID(xRequestID).ContextNames(contextNames).Names(names).Execute()
Delete network interface
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.NetworkInterfacesAPI.NetworkInterfacesDelete(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NetworkInterfacesAPI.NetworkInterfacesDelete``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiNetworkInterfacesDeleteRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| contextNames | []string | 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`. | |
| names | []string | 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. |
(empty response body)
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkInterfaceGetResponse NetworkInterfacesGet(ctx).Authorization(authorization).XRequestID(xRequestID).AllowErrors(allowErrors).ContextNames(contextNames).ContinuationToken(continuationToken).Filter(filter).Limit(limit).Names(names).Offset(offset).Sort(sort).TotalItemCount(totalItemCount).Execute()
List network interfaces
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.NetworkInterfacesAPI.NetworkInterfacesGet(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NetworkInterfacesAPI.NetworkInterfacesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `NetworkInterfacesGet`: NetworkInterfaceGetResponse
fmt.Fprintf(os.Stdout, "Response from `NetworkInterfacesAPI.NetworkInterfacesGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiNetworkInterfacesGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| allowErrors | bool | 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. | [default to false] |
| contextNames | []string | 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`. | |
| continuationToken | string | 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. | |
| filter | string | Narrows down the results to only the response objects that satisfy the filter criteria. | |
| limit | int32 | 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. | |
| names | []string | 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. | |
| offset | int32 | The starting position based on the results of the query in relation to the full set of response objects returned. | |
| sort | []string | Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token. | |
| totalItemCount | bool | 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`. |
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkInterfaceNeighborGetResponse NetworkInterfacesNeighborsGet(ctx).Authorization(authorization).XRequestID(xRequestID).Filter(filter).Limit(limit).LocalPortNames(localPortNames).Sort(sort).TotalItemCount(totalItemCount).Execute()
List network interface neighbors
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.NetworkInterfacesAPI.NetworkInterfacesNeighborsGet(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NetworkInterfacesAPI.NetworkInterfacesNeighborsGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `NetworkInterfacesNeighborsGet`: NetworkInterfaceNeighborGetResponse
fmt.Fprintf(os.Stdout, "Response from `NetworkInterfacesAPI.NetworkInterfacesNeighborsGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiNetworkInterfacesNeighborsGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| filter | string | Narrows down the results to only the response objects that satisfy the filter criteria. | |
| limit | int32 | 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. | |
| localPortNames | []string | Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, `ct0.eth0,ct1.eth0`. | |
| sort | []string | Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token. | |
| totalItemCount | bool | 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`. |
NetworkInterfaceNeighborGetResponse
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkInterfaceResponse NetworkInterfacesPatch(ctx).Network(network).Authorization(authorization).XRequestID(xRequestID).ContextNames(contextNames).Names(names).Remediate(remediate).Execute()
Modify network interface
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.NetworkInterfacesAPI.NetworkInterfacesPatch(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NetworkInterfacesAPI.NetworkInterfacesPatch``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `NetworkInterfacesPatch`: NetworkInterfaceResponse
fmt.Fprintf(os.Stdout, "Response from `NetworkInterfacesAPI.NetworkInterfacesPatch`: %v\n", resp)
}Other parameters are passed through a pointer to a apiNetworkInterfacesPatchRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| network | NetworkInterfacePatch | ||
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| contextNames | []string | 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`. | |
| names | []string | 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. | |
| remediate | bool | The boolean value that, if `true`, indicates that `network interfaces` with a `remediation_mode` of `manual` will migrate to their `preferred_arrays`, if configured. |
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkInterfacePerformanceGetResponse NetworkInterfacesPerformanceGet(ctx).Authorization(authorization).XRequestID(xRequestID).EndTime(endTime).Filter(filter).Limit(limit).Names(names).Offset(offset).Resolution(resolution).Sort(sort).StartTime(startTime).TotalItemCount(totalItemCount).TotalOnly(totalOnly).Execute()
List network performance statistics
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.NetworkInterfacesAPI.NetworkInterfacesPerformanceGet(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NetworkInterfacesAPI.NetworkInterfacesPerformanceGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `NetworkInterfacesPerformanceGet`: NetworkInterfacePerformanceGetResponse
fmt.Fprintf(os.Stdout, "Response from `NetworkInterfacesAPI.NetworkInterfacesPerformanceGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiNetworkInterfacesPerformanceGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| endTime | int64 | 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. | |
| filter | string | Narrows down the results to only the response objects that satisfy the filter criteria. | |
| limit | int32 | 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. | |
| names | []string | 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. | |
| offset | int32 | The starting position based on the results of the query in relation to the full set of response objects returned. | |
| resolution | int64 | 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 (`<object name>/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, (`<object name>/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. | |
| sort | []string | Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token. | |
| startTime | int64 | 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. | |
| totalItemCount | bool | 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`. | |
| totalOnly | bool | 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. |
NetworkInterfacePerformanceGetResponse
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkInterfacesPortDetailsGetResponse NetworkInterfacesPortDetailsGet(ctx).Authorization(authorization).XRequestID(xRequestID).Filter(filter).Limit(limit).Names(names).Offset(offset).Sort(sort).TotalItemCount(totalItemCount).Execute()
List SFP port details
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.NetworkInterfacesAPI.NetworkInterfacesPortDetailsGet(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NetworkInterfacesAPI.NetworkInterfacesPortDetailsGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `NetworkInterfacesPortDetailsGet`: NetworkInterfacesPortDetailsGetResponse
fmt.Fprintf(os.Stdout, "Response from `NetworkInterfacesAPI.NetworkInterfacesPortDetailsGet`: %v\n", resp)
}Other parameters are passed through a pointer to a apiNetworkInterfacesPortDetailsGetRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| filter | string | Narrows down the results to only the response objects that satisfy the filter criteria. | |
| limit | int32 | 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. | |
| names | []string | 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. | |
| offset | int32 | The starting position based on the results of the query in relation to the full set of response objects returned. | |
| sort | []string | Sorts the response objects by the specified fields. Sorting can be applied to any field name in the response, in ascending order by default, or in descending order by prefixing the field name with a minus sign (-). Multiple fields can be specified as a comma-separated list (e.g., sort volumes by size descending, then by name ascending). If sort is provided, the response will not include a continuation_token. | |
| totalItemCount | bool | 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`. |
NetworkInterfacesPortDetailsGetResponse
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NetworkInterfaceResponse NetworkInterfacesPost(ctx).Network(network).Authorization(authorization).XRequestID(xRequestID).ContextNames(contextNames).Names(names).Execute()
Create network interface
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/PureStorage-OpenConnect/go-pure-client/flasharray/FA_2_56"
)
func main() {
configuration, err := openapiclient.NewConfigurationBuilder(server.URL).
APIToken(apiToken).
Build()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client configuration: %v\n", err)
}
apiClient, err := openapiclient.NewClient(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when creating api client: %v\n", err)
}
req := apiClient.NetworkInterfacesAPI.NetworkInterfacesPost(context.Background())
// Set request parameters ...
resp, r, err := req.Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NetworkInterfacesAPI.NetworkInterfacesPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `NetworkInterfacesPost`: NetworkInterfaceResponse
fmt.Fprintf(os.Stdout, "Response from `NetworkInterfacesAPI.NetworkInterfacesPost`: %v\n", resp)
}Other parameters are passed through a pointer to a apiNetworkInterfacesPostRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| network | NetworkInterfacePost | ||
| authorization | string | Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) | |
| xRequestID | string | Supplied by client during request or generated by server. | |
| contextNames | []string | 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`. | |
| names | []string | 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. |
Authorization is handled by the Authenticator specified in the configuration and data are filled automatically. Use param authorization only when you need to override this behaviour.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]