diff --git a/.github/workflows/terraform-ci.yml b/.github/workflows/terraform-ci.yml index d42f8913..462ddf72 100644 --- a/.github/workflows/terraform-ci.yml +++ b/.github/workflows/terraform-ci.yml @@ -53,7 +53,7 @@ jobs: - name: Run the forbidden words scan uses: dell/common-github-actions/code-sanitizer@main with: - args: /github/workspace + args: /github/workspace/powerscale build: name: Build diff --git a/.gitignore b/.gitignore index 7884608a..51f48b1f 100644 --- a/.gitignore +++ b/.gitignore @@ -33,6 +33,6 @@ website/vendor # Keep windows files with windows line endings *.winfile eol=crlf - +*coverage.out* *powerscale-go-client terraform-provider-powerscale \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index b76e247f..40f0c6de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,20 @@ +--- +# Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. +# +# Licensed under the Mozilla Public License Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://mozilla.org/MPL/2.0/ +# +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +--- + ## 0.1.0 (Unreleased) FEATURES: diff --git a/README.md b/README.md index fb553c26..df4ed2e0 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ - # Terraform Provider for Dell Technologies PowerScale [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](about/CODE_OF_CONDUCT.md) [![License](https://img.shields.io/badge/License-MPL_2.0-blue.svg)](LICENSE) diff --git a/client/client.go b/client/client.go index 88d94f0d..4e4ec626 100644 --- a/client/client.go +++ b/client/client.go @@ -21,7 +21,7 @@ import ( "context" "crypto/tls" "crypto/x509" - "dell/powerscale-go-client" + powerscale "dell/powerscale-go-client" "encoding/base64" "errors" "fmt" @@ -92,7 +92,7 @@ func NewOpenAPIClient(ctx context.Context, endpoint string, insecure bool, verbo } httpclient := &http.Client{ - Timeout: (2000 * time.Second), + Timeout: 2000 * time.Second, Jar: jar, } if insecure { diff --git a/docs/data-sources/cluster.md b/docs/data-sources/cluster.md new file mode 100644 index 00000000..72e36fee --- /dev/null +++ b/docs/data-sources/cluster.md @@ -0,0 +1,483 @@ +--- +# Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. +# +# Licensed under the Mozilla Public License Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://mozilla.org/MPL/2.0/ +# +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +title: "powerscale_cluster data source" +linkTitle: "powerscale_cluster" +page_title: "powerscale_cluster Data Source - terraform-provider-powerscale" +subcategory: "" +description: |- + The cluster attributes and cluster node information. +--- + +# powerscale_cluster (Data Source) + +The cluster attributes and cluster node information. + + + + +## Schema + +### Read-Only + +- `config` (Attributes) The configuration information of cluster. (see [below for nested schema](#nestedatt--config)) +- `id` (String) Unique identifier of the cluster. +- `identity` (Attributes) Unprivileged cluster information for display when logging in. (see [below for nested schema](#nestedatt--identity)) +- `internal_networks` (Attributes) V7ClusterInternalNetworks Configuration fields for internal networks. (see [below for nested schema](#nestedatt--internal_networks)) +- `nodes` (Attributes) IsiClusterNodes struct for IsiClusterNodes (see [below for nested schema](#nestedatt--nodes)) + + +### Nested Schema for `config` + +Read-Only: + +- `description` (String) Customer configurable description. +- `devices` (Attributes List) device (see [below for nested schema](#nestedatt--config--devices)) +- `guid` (String) Cluster GUID. +- `join_mode` (String) Node join mode: 'manual' or 'secure'. +- `local_devid` (Number) Device ID of the queried node. +- `local_lnn` (Number) Device logical node number of the queried node. +- `local_serial` (String) Device serial number of the queried node. +- `name` (String) Cluster name. +- `onefs_version` (Attributes) version (see [below for nested schema](#nestedatt--config--onefs_version)) +- `timezone` (Attributes) version (see [below for nested schema](#nestedatt--config--timezone)) + + +### Nested Schema for `config.devices` + +Read-Only: + +- `devid` (Number) Device ID. +- `guid` (String) Device GUID. +- `is_up` (Boolean) If true, this node is online and communicating with the local node and every other node with the is_up property normally +- `lnn` (Number) Device logical node number. + + + +### Nested Schema for `config.onefs_version` + +Read-Only: + +- `build` (String) OneFS build string. +- `release` (String) Kernel release number. +- `revision` (String) OneFS build number. +- `type` (String) Kernel release type. +- `version` (String) Kernel full version information. + + + +### Nested Schema for `config.timezone` + +Read-Only: + +- `abbreviation` (String) Timezone abbreviation. +- `custom` (String) Customer timezone information. +- `name` (String) Timezone full name. +- `path` (String) Timezone hierarchical name. + + + + +### Nested Schema for `identity` + +Read-Only: + +- `description` (String) A description of the cluster. +- `logon` (Attributes) // (see [below for nested schema](#nestedatt--identity--logon)) +- `name` (String) The name of the cluster. + + +### Nested Schema for `identity.logon` + +Read-Only: + +- `motd` (String) The message of the day. +- `motd_header` (String) The header to the message of the day. + + + + +### Nested Schema for `internal_networks` + +Read-Only: + +- `failover_ip_addresses` (Attributes List) Array of IP address ranges to be used to configure the internal failover network of the OneFS cluster. (see [below for nested schema](#nestedatt--internal_networks--failover_ip_addresses)) +- `failover_status` (String) Status of failover network. +- `int_a_fabric` (String) Network fabric used for the primary network int-a. +- `int_a_ip_addresses` (Attributes List) Array of IP address ranges to be used to configure the internal int-a network of the OneFS cluster. (see [below for nested schema](#nestedatt--internal_networks--int_a_ip_addresses)) +- `int_a_mtu` (Number) Maximum Transfer Unit (MTU) of the primary network int-a. +- `int_a_prefix_length` (Number) Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask. +- `int_a_status` (String) Status of the primary network int-a. +- `int_b_fabric` (String) Network fabric used for the failover network. +- `int_b_ip_addresses` (Attributes List) Array of IP address ranges to be used to configure the internal int-b network of the OneFS cluster. (see [below for nested schema](#nestedatt--internal_networks--int_b_ip_addresses)) +- `int_b_mtu` (Number) Maximum Transfer Unit (MTU) of the failover network int-b. +- `int_b_prefix_length` (Number) Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask. + + +### Nested Schema for `internal_networks.failover_ip_addresses` + +Read-Only: + +- `high` (String) IPv4 address in the format: xxx.xxx.xxx.xxx +- `low` (String) IPv4 address in the format: xxx.xxx.xxx.xxx + + + +### Nested Schema for `internal_networks.int_a_ip_addresses` + +Read-Only: + +- `high` (String) IPv4 address in the format: xxx.xxx.xxx.xxx +- `low` (String) IPv4 address in the format: xxx.xxx.xxx.xxx + + + +### Nested Schema for `internal_networks.int_b_ip_addresses` + +Read-Only: + +- `high` (String) IPv4 address in the format: xxx.xxx.xxx.xxx +- `low` (String) IPv4 address in the format: xxx.xxx.xxx.xxx + + + + +### Nested Schema for `nodes` + +Read-Only: + +- `errors` (Attributes List) A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors. (see [below for nested schema](#nestedatt--nodes--errors)) +- `nodes` (Attributes List) The responses from the individual nodes involved in this request. (see [below for nested schema](#nestedatt--nodes--nodes)) +- `total` (Number) The total number of nodes responding. + + +### Nested Schema for `nodes.errors` + +Read-Only: + +- `code` (String) The error code. +- `field` (String) The field with the error if applicable. +- `id` (Number) Node ID (Device Number) of a node. +- `lnn` (Number) Logical Node Number (LNN) of a node. +- `message` (String) The error message. +- `status` (Number) HTTP Status code returned by this node. + + + +### Nested Schema for `nodes.nodes` + +Read-Only: + +- `drives` (Attributes List) List of the drives in this node. (see [below for nested schema](#nestedatt--nodes--nodes--drives)) +- `error` (String) Error message, if the HTTP status returned from this node was not 200. +- `hardware` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--hardware)) +- `id` (Number) Node ID (Device Number) of a node. +- `lnn` (Number) Logical Node Number (LNN) of a node. +- `partitions` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--partitions)) +- `sensors` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--sensors)) +- `state` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--state)) +- `status` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--status)) + + +### Nested Schema for `nodes.nodes.drives` + +Read-Only: + +- `baynum` (Number) Numerical representation of this drive's bay. +- `blocks` (Number) Number of blocks on this drive. +- `chassis` (Number) The chassis number which contains this drive. +- `devname` (String) This drive's device name. +- `firmware` (Attributes) Drive firmware information (see [below for nested schema](#nestedatt--nodes--nodes--drives--firmware)) +- `handle` (Number) Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1 +- `interface_type` (String) String representation of this drive's interface type. +- `lnum` (Number) This drive's logical drive number in IFS. +- `locnstr` (String) String representation of this drive's physical location. +- `logical_block_length` (Number) Size of a logical block on this drive. +- `media_type` (String) String representation of this drive's media type. +- `model` (String) This drive's manufacturer and model. +- `physical_block_length` (Number) Size of a physical block on this drive. +- `present` (Boolean) Indicates whether this drive is physically present in the node. +- `purpose` (String) This drive's purpose in the DRV state machine. +- `purpose_description` (String) Description of this drive's purpose. +- `serial` (String) Serial number for this drive. +- `ui_state` (String) This drive's state as presented to the UI. +- `wwn` (String) The drive's 'worldwide name' from its NAA identifiers. +- `x_loc` (Number) This drive's x-axis grid location. +- `y_loc` (Number) This drive's y-axis grid location. + + +### Nested Schema for `nodes.nodes.drives.y_loc` + +Read-Only: + +- `current_firmware` (String) This drive's current firmware revision +- `desired_firmware` (String) This drive's desired firmware revision. + + + + +### Nested Schema for `nodes.nodes.hardware` + +Read-Only: + +- `chassis` (String) Name of this node's chassis. +- `chassis_code` (String) Chassis code of this node (1U, 2U, etc.). +- `chassis_count` (String) Number of chassis making up this node. +- `class` (String) Class of this node (storage, accelerator, etc.). +- `configuration_id` (String) Node configuration ID. +- `cpu` (String) Manufacturer and model of this node's CPU. +- `disk_controller` (String) Manufacturer and model of this node's disk controller. +- `disk_expander` (String) Manufacturer and model of this node's disk expander. +- `family_code` (String) Family code of this node (X, S, NL, etc.). +- `flash_drive` (String) Manufacturer, model, and device id of this node's flash drive. +- `generation_code` (String) Generation code of this node. +- `hwgen` (String) PowerScale hardware generation name. +- `imb_version` (String) Version of this node's PowerScale Management Board. +- `infiniband` (String) Infiniband card type. +- `lcd_version` (String) Version of the LCD panel. +- `motherboard` (String) Manufacturer and model of this node's motherboard. +- `net_interfaces` (String) Description of all this node's network interfaces. +- `nvram` (String) Manufacturer and model of this node's NVRAM board. +- `powersupplies` (List of String) Description strings for each power supply on this node. +- `processor` (String) Number of processors and cores on this node. +- `product` (String) PowerScale product name. +- `ram` (Number) Size of RAM in bytes. +- `serial_number` (String) Serial number of this node. +- `series` (String) Series of this node (X, I, NL, etc.). +- `storage_class` (String) Storage class of this node (storage or diskless). + + + +### Nested Schema for `nodes.nodes.partitions` + +Read-Only: + +- `count` (Number) Count of how many partitions are included. +- `partitions` (Attributes List) Partition information. (see [below for nested schema](#nestedatt--nodes--nodes--partitions--partitions)) + + +### Nested Schema for `nodes.nodes.partitions.partitions` + +Read-Only: + +- `block_size` (Number) The block size used for the reported partition information. +- `capacity` (Number) Total blocks on this file system partition. +- `component_devices` (String) Comma separated list of devices used for this file system partition. +- `mount_point` (String) Directory on which this partition is mounted. +- `percent_used` (String) Used blocks on this file system partition, expressed as a percentage. +- `statfs` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--partitions--partitions--statfs)) +- `used` (Number) Used blocks on this file system partition. + + +### Nested Schema for `nodes.nodes.partitions.partitions.statfs` + +Read-Only: + +- `f_bavail` (Number) Free blocks available to non-superuser on this partition. +- `f_bfree` (Number) Free blocks on this partition. +- `f_blocks` (Number) Total data blocks on this partition. +- `f_bsize` (Number) Filesystem fragment size; block size in OneFS. +- `f_ffree` (Number) Free file nodes avail to non-superuser. +- `f_files` (Number) Total file nodes in filesystem. +- `f_flags` (Number) Mount exported flags. +- `f_fstypename` (String) File system type name. +- `f_iosize` (Number) Optimal transfer block size. +- `f_mntfromname` (String) Names of devices this partition is mounted from. +- `f_mntonname` (String) Directory this partition is mounted to. +- `f_namemax` (Number) Maximum filename length. +- `f_owner` (Number) UID of user that mounted the filesystem. +- `f_type` (Number) Type of filesystem. +- `f_version` (Number) statfs() structure version number. + + + + + +### Nested Schema for `nodes.nodes.sensors` + +Read-Only: + +- `sensors` (Attributes List) This node's sensor information. (see [below for nested schema](#nestedatt--nodes--nodes--sensors--sensors)) + + +### Nested Schema for `nodes.nodes.sensors.sensors` + +Read-Only: + +- `count` (Number) The count of values in this sensor group. +- `name` (String) The name of this sensor group. +- `values` (Attributes List) The list of specific sensor value info in this sensor group. (see [below for nested schema](#nestedatt--nodes--nodes--sensors--sensors--values)) + + +### Nested Schema for `nodes.nodes.sensors.sensors.values` + +Read-Only: + +- `desc` (String) The descriptive name of this sensor. +- `name` (String) The identifier name of this sensor. +- `units` (String) The units of this sensor. +- `value` (String) The value of this sensor. + + + + + +### Nested Schema for `nodes.nodes.state` + +Read-Only: + +- `readonly` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--state--readonly)) +- `servicelight` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--state--servicelight)) +- `smartfail` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--state--smartfail)) + + +### Nested Schema for `nodes.nodes.state.smartfail` + +Read-Only: + +- `allowed` (Boolean) The current read-only mode allowed status for the node. +- `enabled` (Boolean) The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared. +- `mode` (Boolean) The current read-only mode status for the node. +- `status` (String) The current read-only mode status description for the node. +- `valid` (Boolean) The read-only state values are valid (False = Error). +- `value` (Number) The current read-only value (enumerated bitfield) for the node. + + + +### Nested Schema for `nodes.nodes.state.smartfail` + +Read-Only: + +- `enabled` (Boolean) The node service light state (True = on). + + + +### Nested Schema for `nodes.nodes.state.smartfail` + +Read-Only: + +- `smartfailed` (Boolean) This node is smartfailed (soft_devs). + + + + +### Nested Schema for `nodes.nodes.status` + +Read-Only: + +- `batterystatus` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--status--batterystatus)) +- `capacity` (Attributes List) Storage capacity of this node. (see [below for nested schema](#nestedatt--nodes--nodes--status--capacity)) +- `cpu` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--status--cpu)) +- `nvram` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--status--nvram)) +- `powersupplies` (Attributes) // (see [below for nested schema](#nestedatt--nodes--nodes--status--powersupplies)) +- `release` (String) OneFS release. +- `uptime` (Number) Seconds this node has been online. +- `version` (String) OneFS version. + + +### Nested Schema for `nodes.nodes.status.version` + +Read-Only: + +- `last_test_time1` (String) The last battery test time for battery 1. +- `last_test_time2` (String) The last battery test time for battery 2. +- `next_test_time1` (String) The next checkup for battery 1. +- `next_test_time2` (String) The next checkup for battery 2. +- `present` (Boolean) Node has battery status. +- `result1` (String) The result of the last battery test for battery 1. +- `result2` (String) The result of the last battery test for battery 2. +- `status1` (String) The status of battery 1. +- `status2` (String) The status of battery 2. +- `supported` (Boolean) Node supports battery status. + + + +### Nested Schema for `nodes.nodes.status.version` + +Read-Only: + +- `bytes` (Number) Total device storage bytes. +- `count` (Number) Total device count. +- `type` (String) Device type. + + + +### Nested Schema for `nodes.nodes.status.version` + +Read-Only: + +- `model` (String) Manufacturer model description of this CPU. +- `overtemp` (String) CPU overtemp state. +- `proc` (String) Type of processor and core of this CPU. +- `speed_limit` (String) CPU throttling (expressed as a percentage). + + + +### Nested Schema for `nodes.nodes.status.version` + +Read-Only: + +- `batteries` (Attributes List) This node's NVRAM battery status information. (see [below for nested schema](#nestedatt--nodes--nodes--status--version--batteries)) +- `battery_count` (Number) This node's NVRAM battery count. On failure: -1, otherwise 1 or 2. +- `charge_status` (String) This node's NVRAM battery charge status, as a color. +- `charge_status_number` (Number) This node's NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3. +- `device` (String) This node's NVRAM device name with path. +- `present` (Boolean) This node has NVRAM. +- `present_flash` (Boolean) This node has NVRAM with flash storage. +- `present_size` (Number) The size of the NVRAM, in bytes. +- `present_type` (String) This node's NVRAM type. +- `ship_mode` (Number) This node's current ship mode state for NVRAM batteries. If not supported or on failure: -1. Disabled: 0. Enabled: 1. +- `supported` (Boolean) This node supports NVRAM. +- `supported_flash` (Boolean) This node supports NVRAM with flash storage. +- `supported_size` (Number) The maximum size of the NVRAM, in bytes. +- `supported_type` (String) This node's supported NVRAM type. + + +### Nested Schema for `nodes.nodes.status.version.batteries` + +Read-Only: + +- `color` (String) The current status color of the NVRAM battery. +- `id` (Number) Identifying index for the NVRAM battery. +- `status` (String) The current status message of the NVRAM battery. +- `voltage` (String) The current voltage of the NVRAM battery. + + + + +### Nested Schema for `nodes.nodes.status.version` + +Read-Only: + +- `count` (Number) Count of how many power supplies are supported. +- `failures` (Number) Count of how many power supplies have failed. +- `has_cff` (Boolean) Does this node have a CFF power supply. +- `status` (String) A descriptive status string for this node's power supplies. +- `supplies` (Attributes List) List of this node's power supplies. (see [below for nested schema](#nestedatt--nodes--nodes--status--version--supplies)) +- `supports_cff` (Boolean) Does this node support CFF power supplies. + + +### Nested Schema for `nodes.nodes.status.version.supplies` + +Read-Only: + +- `chassis` (Number) Which node chassis is this power supply in. +- `firmware` (String) The current firmware revision of this power supply. +- `good` (String) Is this power supply in a failure state. +- `id` (Number) Identifying index for this power supply. +- `name` (String) Complete identifying string for this power supply. +- `status` (String) A descriptive status string for this power supply. +- `type` (String) The type of this power supply. \ No newline at end of file diff --git a/docs/data-sources/example.md b/docs/data-sources/example.md deleted file mode 100644 index 3a2135c5..00000000 --- a/docs/data-sources/example.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -# Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. -# -# Licensed under the Mozilla Public License Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://mozilla.org/MPL/2.0/ -# -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -title: "powerscale_example data source" -linkTitle: "powerscale_example" -page_title: "powerscale_example Data Source - terraform-provider-powerscale" -subcategory: "" -description: |- - Example data source ---- - -# powerscale_example (Data Source) - -Example data source - - - - -## Schema - -### Optional - -- `configurable_attribute` (String) Example configurable attribute - -### Read-Only - -- `id` (String) Example identifier \ No newline at end of file diff --git a/docs/resources/accesszone.md b/docs/resources/accesszone.md new file mode 100644 index 00000000..9f84b015 --- /dev/null +++ b/docs/resources/accesszone.md @@ -0,0 +1,71 @@ +--- +# Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. +# +# Licensed under the Mozilla Public License Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://mozilla.org/MPL/2.0/ +# +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +title: "powerscale_accesszone resource" +linkTitle: "powerscale_accesszone" +page_title: "powerscale_accesszone Resource - terraform-provider-powerscale" +subcategory: "" +description: |- + Access Zone resource +--- + +# powerscale_accesszone (Resource) + +Access Zone resource + + + + + +## Schema + +### Required + +- `groupnet` (String) Groupnet identifier +- `name` (String) Specifies the access zone name. +- `path` (String) Specifies the access zone base directory path. + +### Optional + +- `custom_auth_providers` (List of String) An optional parameter which adds new auth_providers to the access zone + +### Read-Only + +- `alternate_system_provider` (String) Specifies an alternate system provider. +- `auth_providers` (List of String) Specifies the list of authentication providers available on this access zone. +- `cache_entry_expiry` (Number) Specifies amount of time in seconds to cache a user/group. +- `create_path` (Boolean) Determines if a path is created when a path does not exist. +- `home_directory_umask` (Number) Specifies the permissions set on automatically created user home directories. +- `id` (String) Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method +- `ifs_restricted` (Attributes List) Specifies a list of users and groups that have read and write access to /ifs. (see [below for nested schema](#nestedatt--ifs_restricted)) +- `map_untrusted` (String) Maps untrusted domains to this NetBIOS domain during authentication. +- `negative_cache_entry_expiry` (Number) Specifies number of seconds the negative cache entry is valid. +- `netbios_name` (String) Specifies the NetBIOS name. +- `skeleton_directory` (String) Specifies the skeleton directory that is used for user home directories. +- `system` (Boolean) True if the access zone is built-in. +- `system_provider` (String) Specifies the system provider for the access zone. +- `user_mapping_rules` (List of String) Specifies the current ID mapping rules. +- `zone_id` (Number) Specifies the access zone ID on the system. + + +### Nested Schema for `ifs_restricted` + +Read-Only: + +- `id` (String) Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'. +- `name` (String) Specifies the persona name, which must be combined with a type. +- `type` (String) Specifies the type of persona, which must be combined with a name. + diff --git a/docs/resources/example.md b/docs/resources/example.md deleted file mode 100644 index 8ddad6c8..00000000 --- a/docs/resources/example.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -# Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. -# -# Licensed under the Mozilla Public License Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://mozilla.org/MPL/2.0/ -# -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -title: "powerscale_example resource" -linkTitle: "powerscale_example" -page_title: "powerscale_example Resource - terraform-provider-powerscale" -subcategory: "" -description: |- - Example resource ---- - -# powerscale_example (Resource) - -Example resource - - - - - -## Schema - -### Optional - -- `configurable_attribute` (String) Example configurable attribute -- `defaulted` (String) Example configurable attribute with default value - -### Read-Only - -- `id` (String) Example identifier - diff --git a/examples/resources/powescale_access_zone/provider.tf b/examples/resources/powescale_access_zone/provider.tf new file mode 100644 index 00000000..0232b112 --- /dev/null +++ b/examples/resources/powescale_access_zone/provider.tf @@ -0,0 +1,36 @@ +/* +Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. + +Licensed under the Mozilla Public License Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ +terraform { + required_providers { + powerscale = { + source = "registry.terraform.io/dell/powerscale" + } + } +} + +provider "powerscale" { + username = var.username + password = var.password + endpoint = var.endpoint + insecure = var.insecure + group = var.group + volume_path = var.volumes_path + volume_path_permissions = var.volumes_path_permissions + ignore_unresolvable_hosts = var.ignore_unresolvable_hosts + auth_type = var.auth_type + verbose_logging = var.verbose_logging +} diff --git a/examples/resources/powescale_access_zone/resource.tf b/examples/resources/powescale_access_zone/resource.tf new file mode 100644 index 00000000..1263e80d --- /dev/null +++ b/examples/resources/powescale_access_zone/resource.tf @@ -0,0 +1,26 @@ +/* +Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. + +Licensed under the Mozilla Public License Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +resource "powerscale_accesszone" "zone" { + # Required fields + name = "testAccessZone3" + groupnet = "groupnet0" + path = "/ifs" + + # Optional to apply Auth Providers + custom_auth_providers = ["System"] +} \ No newline at end of file diff --git a/go.mod b/go.mod index 062ab97d..f500abe4 100644 --- a/go.mod +++ b/go.mod @@ -1,9 +1,10 @@ module terraform-provider-powerscale -go 1.19 +go 1.20 require ( dell/powerscale-go-client v0.0.0 + github.com/bytedance/mockey v1.2.4 github.com/dell/goisilon v1.12.0 github.com/hashicorp/terraform-plugin-docs v0.15.0 github.com/hashicorp/terraform-plugin-framework v1.3.1 @@ -39,6 +40,7 @@ require ( github.com/golang/protobuf v1.5.3 // indirect github.com/google/go-cmp v0.5.9 // indirect github.com/google/uuid v1.3.0 // indirect + github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 // indirect github.com/hashicorp/errwrap v1.1.0 // indirect github.com/hashicorp/go-checkpoint v0.5.0 // indirect github.com/hashicorp/go-cleanhttp v0.5.2 // indirect @@ -59,6 +61,7 @@ require ( github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect github.com/huandu/xstrings v1.3.2 // indirect github.com/imdario/mergo v0.3.13 // indirect + github.com/jtolds/gls v4.20.0+incompatible // indirect github.com/mattn/go-colorable v0.1.13 // indirect github.com/mattn/go-isatty v0.0.16 // indirect github.com/mitchellh/cli v1.1.5 // indirect @@ -72,11 +75,14 @@ require ( github.com/russross/blackfriday v1.6.0 // indirect github.com/shopspring/decimal v1.3.1 // indirect github.com/sirupsen/logrus v1.9.0 // indirect + github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d // indirect + github.com/smartystreets/goconvey v1.6.4 // indirect github.com/spf13/cast v1.5.0 // indirect github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect github.com/zclconf/go-cty v1.13.2 // indirect + golang.org/x/arch v0.0.0-20201008161808-52c3e6f60cff // indirect golang.org/x/crypto v0.10.0 // indirect golang.org/x/mod v0.10.0 // indirect golang.org/x/net v0.11.0 // indirect diff --git a/goClientZip/PowerScale_API_9.4.0.0.json b/goClientZip/PowerScale_API_9.4.0.0.json new file mode 100644 index 00000000..101d7c59 --- /dev/null +++ b/goClientZip/PowerScale_API_9.4.0.0.json @@ -0,0 +1,164258 @@ +{ + "consumes": [ + "application/json" + ], + "definitions": { + "AccessPointCreateParams": { + "properties": { + "path": { + "description": "Absolute file system path of access point.", + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object" + }, + "AclObject": { + "properties": { + "accessrights": { + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "accesstype": { + "type": "string" + }, + "inherit_flags": { + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array" + }, + "op": { + "type": "string" + }, + "trustee": { + "$ref": "#/definitions/MemberObject" + } + }, + "type": "object" + }, + "CopyErrors": { + "properties": { + "copy_errors": { + "items": { + "properties": { + "error_src": { + "type": "string" + }, + "message": { + "type": "string" + }, + "source": { + "type": "string" + }, + "target": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "CreateResponse": { + "properties": { + "id": { + "description": "ID of created item that can be used to refer to item in the collection-item resource path.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv10DatasetFilterResponse": { + "additionalProperties": false, + "description": "The newly applied performance filter.", + "properties": { + "id": { + "description": "The filter ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv10DatasetWorkloadResponse": { + "additionalProperties": false, + "description": "The newly pinned performance workload.", + "properties": { + "id": { + "description": "The workload ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv10PerformanceDatasetResponse": { + "additionalProperties": false, + "description": "The newly created performance dataset.", + "properties": { + "id": { + "description": "Unique identifier for the configured dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the performance dataset. If a name is not specified then a default name is assigned. The default name will be an underscore separated list of the performance metrics and filters used to configure the dataset.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "note": { + "description": "Additional information about this dataset", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "statkey": { + "description": "Key for use in viewing associated raw statistics under the endpoints /statistics/history and /statistics/current.", + "maxLength": 29, + "minLength": 29, + "type": "string" + }, + "stats_summary_uri": { + "description": "URI used to view associated summary statistics.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "stats_summary_uri", + "statkey", + "id", + "name" + ], + "type": "object" + }, + "Createv10S3KeyResponse": { + "additionalProperties": false, + "properties": { + "keys": { + "$ref": "#/definitions/Createv10S3KeyResponseKeys" + } + }, + "required": [ + "keys" + ], + "type": "object" + }, + "Createv10S3KeyResponseKeys": { + "properties": { + "access_id": { + "description": "S3 Access ID", + "maxLength": 272, + "minLength": 9, + "type": "string" + }, + "old_key_expiry": { + "description": "Time that previous secret key will expire, in format YYYY-MM-DD HH:MM:SS", + "type": "integer" + }, + "old_key_timestamp": { + "description": "Time that previous secret key was created, in format YYYY-MM-DD HH:MM:SS", + "type": "integer" + }, + "old_secret_key": { + "description": "Previous secret key", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "secret_key": { + "description": "Secret key", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "secret_key_timestamp": { + "description": "Time that secret key was created, in format YYYY-MM-DD HH:MM:SS", + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_S3_MYKEYS" + }, + "Createv11AntivirusScanItemResponse": { + "additionalProperties": false, + "description": "The result of a manual antivirus scan.", + "properties": { + "report_id": { + "description": "The ID for the report for this scan. A report ID will be generated if one is not provided. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "result": { + "description": "The result of the scan.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Createv12AdsProviderSearchItemResponse": { + "additionalProperties": false, + "properties": { + "objects": { + "items": { + "$ref": "#/definitions/Createv12AdsProviderSearchItemResponseObject" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "Createv12AdsProviderSearchItemResponseObject": { + "properties": { + "description": { + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "display_name": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + "type": "object" + }, + "Createv12ConfigExportResponse": { + "properties": { + "task_id": { + "description": "The id of the new export task", + "maxLength": 255, + "minLength": 14, + "type": "string" + } + }, + "type": "object" + }, + "Createv12ConfigImportResponse": { + "properties": { + "task_id": { + "description": "The id of the new import task", + "maxLength": 255, + "minLength": 14, + "type": "string" + } + }, + "type": "object" + }, + "Createv12KmipServerVerifyItemResponse": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/Createv12KmipServerVerifyItemResponseNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "Createv12KmipServerVerifyItemResponseNode": { + "properties": { + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "message": { + "description": "Response message.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "True if the KMIP configuration was verified, otherwise false.", + "type": "boolean" + } + }, + "required": [ + "status", + "message", + "lnn", + "id" + ], + "type": "object" + }, + "Createv12LfnItemResponse": { + "properties": { + "id": { + "description": "Specifies the system-assigned ID for the long filename domain.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "inherited": { + "description": "Specifies if the file name length properties are inherited from a different path or not compared to the original query location.", + "type": "boolean" + }, + "max_bytes": { + "description": "Specifies the maximum number of bytes the UTF-8 encoded filename can have. This may be more than the character limit as a single character could require up to 4 bytes to be encoded.", + "maximum": 1024, + "minimum": 255, + "type": "integer" + }, + "max_chars": { + "description": "Specifies the maximum number of characters a filename can have. Each character will require between 1 and 4 bytes to encode.", + "maximum": 1024, + "minimum": 255, + "type": "integer" + }, + "path": { + "description": "Specifies the root path that the file name length properties apply to. Files in this directory and all sub-directories will inherit these settings unless overriden.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "policy": { + "description": "Specifies the name length policy for bytes and chars.", + "enum": [ + "restricted", + "full", + "custom" + ], + "type": "string" + } + }, + "type": "object" + }, + "Createv12SedMigrateItemResponse": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/Createv12SedMigrateItemResponseSettings" + } + }, + "type": "object" + }, + "Createv12SedMigrateItemResponseSettings": { + "properties": { + "migration_msg": { + "description": "Non-error message reported to user about the migration process.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "migration_msg" + ], + "type": "object" + }, + "Createv12SmbShareResponse": { + "additionalProperties": false, + "description": "An array of ids to refer SMB shares.", + "properties": { + "id": { + "description": "ID of created item that can be used to refer to item in the collection-item resource path.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv14SnapshotWritableItemResponse": { + "properties": { + "created": { + "description": "The Unix Epoch time the writable snapshot was created.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dst_path": { + "description": "The user supplied /ifs path of writable snapshot.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "id": { + "description": "The system ID given to the writable snapshot. This is useful for debugging.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_size": { + "description": "The sum in bytes of logical size of files in this writable snapshot.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size": { + "description": "The amount of storage in bytes used to store this writable snapshot.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "src_id": { + "description": "The system ID of the user supplied source snapshot. This is useful for debugging.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "src_path": { + "description": "The /ifs path of user supplied source snapshot. This will be null for writable snapshots pending delete.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "src_snap": { + "description": "The user supplied source snapshot name or ID. This will be null for writable snapshots pending delete.", + "minLength": 0, + "type": "string" + }, + "state": { + "description": "Writable Snapshot state.", + "enum": [ + "active", + "deleting" + ], + "minLength": 0, + "type": "string" + } + }, + "required": [ + "dst_path", + "log_size", + "src_id", + "created", + "src_path", + "state", + "phys_size", + "src_snap", + "id" + ], + "type": "object" + }, + "Createv15DatamoverAccountResponse": { + "additionalProperties": false, + "properties": { + "id": { + "description": "Unique account ID", + "maxLength": 48, + "minLength": 2, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv15DatamoverBasePolicyResponse": { + "additionalProperties": false, + "properties": { + "id": { + "description": "The unique policy identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv15NfsAliasResponse": { + "description": "Specifies the return value when an alias is successfully created or modified.", + "properties": { + "health": { + "description": "Specifies whether the alias is usable.", + "enum": [ + "good", + "illegal file type", + "illegal path", + "name conflict", + "not exported", + "path not found", + "unknown" + ], + "type": "string" + }, + "id": { + "description": "Specifies a string which represents the unique location of the alias.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "health", + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_NFS_ALIASES" + }, + "Createv15ThrottlingBwRuleResponse": { + "description": "Statistics for this job", + "properties": { + "id": { + "description": "Unique ID of the Bandwidth throttling rule.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv1FilepoolPolicyResponse": { + "properties": { + "id": { + "description": "The name of the new policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_POLICIES" + }, + "Createv1JobJobResponse": { + "properties": { + "id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv1SnapshotAliasResponse": { + "properties": { + "id": { + "description": "The ID of the newly created snapshot alias.", + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_ALIAS" + }, + "Createv1SnapshotLockResponse": { + "properties": { + "id": { + "description": "The ID of the newly created snapshot lock.", + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_LOCKS" + }, + "Createv1SnapshotScheduleResponse": { + "properties": { + "id": { + "description": "The ID of the newly created snapshot schedule.", + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_SCHEDULES" + }, + "Createv1SnapshotSnapshotResponse": { + "properties": { + "alias": { + "description": "Alias name to create for this snapshot. If null, remove any alias.", + "minLength": 0, + "type": "string" + }, + "created": { + "description": "The Unix Epoch time the snapshot was created.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "expires": { + "description": "The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.", + "maximum": 2147483646, + "type": "integer" + }, + "has_locks": { + "description": "True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of locks.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.", + "maximum": 2147483646, + "type": "integer" + }, + "name": { + "description": "The user or system supplied snapshot name. This will be null for snapshots pending delete.", + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The /ifs path snapshotted.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "pct_filesystem": { + "description": "Percentage of /ifs used for storing this snapshot.", + "type": "number" + }, + "pct_reserve": { + "description": "Percentage of configured snapshot reserved used for storing this snapshot.", + "type": "number" + }, + "schedule": { + "description": "The name of the schedule used to create this snapshot, if applicable.", + "minLength": 0, + "type": "string" + }, + "shadow_bytes": { + "description": "The amount of shadow bytes referred to by this snapshot.", + "maximum": 2147483646, + "type": "integer" + }, + "size": { + "description": "The amount of storage in bytes used to store this snapshot.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "Snapshot state.", + "enum": [ + "active", + "deleting" + ], + "minLength": 0, + "type": "string" + }, + "target_id": { + "description": "The ID of the snapshot pointed to if this is an alias. 18446744073709551615 (max uint64) is returned for an alias to the live filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_name": { + "description": "The name of the snapshot pointed to if this is an alias.", + "minLength": 0, + "type": "string" + } + }, + "required": [ + "pct_reserve", + "shadow_bytes", + "name", + "created", + "target_name", + "expires", + "target_id", + "schedule", + "state", + "has_locks", + "path", + "pct_filesystem", + "id", + "size" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_SNAPSHOTMANAGEMENT" + }, + "Createv1StoragepoolNodepoolResponse": { + "properties": { + "id": { + "description": "The system ID of the new object.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "Createv1SyncReportsRotateItemResponse": { + "description": "Force rotation of reports.", + "properties": { + "message": { + "description": "A message about the status of the task.", + "type": "string" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "Createv1WormDomainResponse": { + "properties": { + "autocommit_offset": { + "description": "Specifies the autocommit time period for the domain in seconds. After a file is in the domain without being modified for the specified time period, the file is automatically committed. If this parameter is set to null, there is no autocommit time, and files must be committed manually.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_retention": { + "description": "Specifies the default amount of time, in seconds, that a file in this domain will be protected for. The default retention period is applied if no retention date is manually set on the file. This parameter can also be set to 'forever', 'use_min' (which applies the 'min_retention' option), or 'use_max' (which applies the 'max_retention' option).", + "enum": [ + "use_min", + "use_max", + "forever" + ], + "type": "string" + }, + "id": { + "description": "Specifies the system-assigned ID for the protection domain.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "incomplete": { + "description": "True if OneFS is still in the process of creating this domain and is unable to prevent files from being modified or deleted. If false, indicates that the domain is fully created and is able to prevent files from being modified or deleted.", + "type": "boolean" + }, + "lin": { + "description": "Specifies the logical inode number (LIN) for the root of this domain.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_modifies": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_retention": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "enum": [ + "forever" + ], + "type": "string" + }, + "min_retention": { + "description": "Specifies the minimum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a shorter retention period. If this parameter is set to null, this minimum value is not enforced. This parameter can also be set to 'forever'.", + "enum": [ + "forever" + ], + "type": "string" + }, + "override_date": { + "description": "Specifies the override retention date for the domain. If this date is later than the retention date for any committed file, the file will remain protected until the override retention date.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "Specifies the root path of this domain. Files in this directory and all sub-directories will be protected.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "privileged_delete": { + "description": "When this value is set to 'on', files in this domain can be deleted through the privileged delete feature. If this value is set to 'disabled', privileged file deletes are permanently disabled and cannot be turned on again.", + "enum": [ + "on", + "off", + "disabled" + ], + "type": "string" + }, + "total_modifies": { + "description": "Specifies the number of times this domain has been modified and the number of times the attributes for the domain have changed. A SmartLock domain can be modified a fixed number of times as defined by the 'max_modifies' parameter.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "Specifies whether the domain is an enterprise domain or a compliance domain. Compliance domains can not be created on enterprise clusters. Enterprise and compliance domains can be created on compliance clusters.", + "enum": [ + "enterprise", + "compliance", + "compliance (legacy)" + ], + "type": "string" + } + }, + "required": [ + "override_date", + "lin", + "max_modifies", + "total_modifies", + "autocommit_offset", + "privileged_delete", + "max_retention", + "default_retention", + "min_retention", + "path", + "type", + "id", + "incomplete" + ], + "type": "object" + }, + "Createv3CloudJobResponse": { + "properties": { + "id": { + "description": "The id of the new job", + "type": "integer" + } + }, + "type": "object" + }, + "Createv3EventEventResponse": { + "properties": { + "id": { + "description": "ID of created item that can be used to refer to item in the collection-item resource path.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "Createv3HardeningApplyItemResponse": { + "properties": { + "message": { + "description": "Message text indicating if hardening apply operation started successfully or failed to start.", + "type": "string" + } + }, + "type": "object" + }, + "Createv3HardeningResolveItemResponse": { + "properties": { + "message": { + "description": "Message text indicating if operation to resolve issues started successfully or failed to start.", + "type": "string" + } + }, + "type": "object" + }, + "Createv3HardeningRevertItemResponse": { + "properties": { + "message": { + "description": "Message text indicating if hardening revert operation started successfully or failed or start.", + "type": "string" + } + }, + "type": "object" + }, + "Createv3HardwareTapeNameResponse": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/Createv3HardwareTapeNameResponseNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "Createv3HardwareTapeNameResponseNode": { + "description": "Rescan status output", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "rescan_report": { + "description": "A list of device rescan status", + "items": { + "$ref": "#/definitions/Createv3HardwareTapeNameResponseNodeRescanReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "Createv3HardwareTapeNameResponseNodeRescanReportItem": { + "description": "per device rescan change status", + "properties": { + "devicename": { + "description": "device name", + "type": "string" + }, + "path": { + "description": "device driver path", + "type": "string" + }, + "product": { + "description": "device product name", + "type": "string" + }, + "serial": { + "description": "device serial:L number", + "type": "string" + }, + "status_report": { + "description": "device change status", + "type": "string" + }, + "wwnn": { + "description": "device node world wide name", + "type": "string" + } + }, + "type": "object" + }, + "Createv3NfsNlmSessionsCheckItemResponse": { + "properties": { + "count": { + "description": "Number of lock-loss events detected", + "type": "integer" + } + }, + "required": [ + "count" + ], + "type": "object" + }, + "Createv3SmbLogLevelFilterResponse": { + "properties": { + "id": { + "description": "Unique ID of the log filter.", + "type": "integer" + } + }, + "type": "object" + }, + "Createv4CloudProxyResponse": { + "properties": { + "id": { + "description": "The globally unique ID (guid) of the new proxy", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_PROXIES" + }, + "Createv7CloudAccountResponse": { + "properties": { + "id": { + "description": "The name of the new account", + "maxLength": 768, + "minLength": 0, + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_ACCOUNTS" + }, + "Createv7CloudPoolResponse": { + "properties": { + "id": { + "description": "The name of the new pool", + "maxLength": 768, + "minLength": 0, + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_POOLS" + }, + "Createv7PerformanceDatasetResponse": { + "additionalProperties": false, + "description": "The newly created performance dataset.", + "properties": { + "id": { + "description": "Unique identifier for the configured dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the performance dataset. If a name is not specified then a default name is assigned. The default name will be an underscore separated list of the performance metrics and filters used to configure the dataset.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "statkey": { + "description": "Key for use in viewing associated raw statistics under the endpoints /statistics/history and /statistics/current.", + "maxLength": 29, + "minLength": 29, + "type": "string" + }, + "stats_summary_uri": { + "description": "URI used to view associated summary statistics.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "stats_summary_uri", + "statkey", + "id", + "name" + ], + "type": "object" + }, + "Createv7WormDomainResponse": { + "properties": { + "autocommit_offset": { + "description": "Specifies the autocommit time period for the domain in seconds. After a file is in the domain without being modified for the specified time period, the file is automatically committed. If this parameter is set to null, there is no autocommit time, and files must be committed manually.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_retention": { + "description": "Specifies the default amount of time, in seconds, that a file in this domain will be protected for. The default retention period is applied if no retention date is manually set on the file. This parameter can also be set to 'forever', 'use_min' (which applies the 'min_retention' option), or 'use_max' (which applies the 'max_retention' option).", + "enum": [ + "use_min", + "use_max", + "forever" + ], + "type": "string" + }, + "exclusions": { + "description": "A list of directories excluded from WORM protection. In a POST/PUT request this collection specifies the directories that the user wishes to create SmartLock exclusion directories on underneath this SmartLock directory. In a GET request this collection specifies all of the exclusion directories that exist underneath this SmartLock directory.", + "items": { + "$ref": "#/definitions/v7WormDomainExclusion" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Specifies the system-assigned ID for the protection domain.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "incomplete": { + "description": "True if OneFS is still in the process of creating this domain and is unable to prevent files from being modified or deleted. If false, indicates that the domain is fully created and is able to prevent files from being modified or deleted.", + "type": "boolean" + }, + "lin": { + "description": "Specifies the logical inode number (LIN) for the root of this domain.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_modifies": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_retention": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "enum": [ + "forever" + ], + "type": "string" + }, + "min_retention": { + "description": "Specifies the minimum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a shorter retention period. If this parameter is set to null, this minimum value is not enforced. This parameter can also be set to 'forever'.", + "enum": [ + "forever" + ], + "type": "string" + }, + "override_date": { + "description": "Specifies the override retention date for the domain. If this date is later than the retention date for any committed file, the file will remain protected until the override retention date.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "Specifies the root path of this domain. Files in this directory and all sub-directories will be protected.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "privileged_delete": { + "description": "When this value is set to 'on', files in this domain can be deleted through the privileged delete feature. If this value is set to 'disabled', privileged file deletes are permanently disabled and cannot be turned on again.", + "enum": [ + "on", + "off", + "disabled" + ], + "type": "string" + }, + "set_pending_delete": { + "description": "If true, the domain is irreversibly marked for deletion. This is used for compliance domains and allows compliance store directories to be deleted, while disallowing the creation or committing of new/existing files.", + "type": "boolean" + }, + "total_modifies": { + "description": "Specifies the number of times this domain has been modified and the number of times the attributes for the domain have changed. A SmartLock domain can be modified a fixed number of times as defined by the 'max_modifies' parameter.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "Specifies whether the domain is an enterprise domain or a compliance domain. Compliance domains can not be created on enterprise clusters. Enterprise and compliance domains can be created on compliance clusters.", + "enum": [ + "enterprise", + "compliance", + "compliance (legacy)" + ], + "type": "string" + } + }, + "required": [ + "set_pending_delete", + "override_date", + "lin", + "max_modifies", + "total_modifies", + "exclusions", + "autocommit_offset", + "privileged_delete", + "max_retention", + "default_retention", + "min_retention", + "path", + "type", + "id", + "incomplete" + ], + "type": "object" + }, + "DirectoryQuery": { + "properties": { + "result": { + "items": { + "type": "string" + }, + "type": "array" + }, + "scope": { + "properties": { + "conditions": { + "items": { + "properties": { + "attr": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "logic": { + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "Empty": { + "properties": {}, + "type": "object" + }, + "Error": { + "properties": { + "code": { + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string" + } + }, + "required": [ + "code", + "message" + ], + "type": "object" + }, + "MemberObject": { + "description": "Provides the JSON object for the group persona of the owner.", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "type": "object" + }, + "NamespaceAccessPoints": { + "properties": { + "namespaces": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + } + }, + "type": "object" + }, + "minItems": 0, + "type": "array" + }, + "versions": { + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "NamespaceAcl": { + "properties": { + "acl": { + "description": "Provides the JSON array of access rights.", + "items": { + "$ref": "#/definitions/AclObject" + }, + "minItems": 0, + "type": "array" + }, + "action": { + "default": "replace", + "description": "Action tells if we want to update the existing acl or delete and replace it with new acl defined. Default action is replace.", + "type": "string" + }, + "authoritative": { + "description": "If the directory has access rights set, then this field is returned as acl. If the directory has POSIX permissions set, then this field is returned as mode.", + "type": "string" + }, + "group": { + "$ref": "#/definitions/MemberObject" + }, + "mode": { + "description": "Provides the POSIX mode.", + "type": "string" + }, + "owner": { + "$ref": "#/definitions/MemberObject" + } + }, + "type": "object" + }, + "NamespaceMetadata": { + "properties": { + "action": { + "type": "string" + }, + "attrs": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "op": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "NamespaceMetadataList": { + "properties": { + "attrs": { + "items": { + "properties": { + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "NamespaceObject": { + "properties": { + "access_time": { + "description": "Specifies the date when the object was last accessed in HTTP date/time format.", + "type": "string" + }, + "atime_val": { + "description": "Specifies the time when the object was last accessed in UNIX Epoch format.", + "type": "integer" + }, + "block_size": { + "description": "Specifies the block size of the object.", + "type": "integer" + }, + "blocks": { + "description": "Specifies the number of blocks that compose the object.", + "type": "integer" + }, + "btime_val": { + "description": "Specifies the time when the object data was created in UNIX Epoch format.", + "type": "integer" + }, + "change_time": { + "description": "Specifies the date when the object was last changed (including data and metadata changes) in HTTP date/time format.", + "type": "string" + }, + "container": { + "description": "Specifies the name of the queried container.", + "type": "string" + }, + "container_path": { + "description": "Specifies the container path on the file system.", + "type": "string" + }, + "create_time": { + "description": "Specifies the date when the object data was created in HTTP date/time format.", + "type": "string" + }, + "ctime_val": { + "description": "Specifies the time when the object was last changed (including data and metadata changes) in UNIX Epoch format.", + "type": "integer" + }, + "gid": { + "description": "Specifies the GID for the owner.", + "type": "integer" + }, + "group": { + "description": "Specifies the group name for the owner of the object.", + "type": "string" + }, + "id": { + "description": "Specifies the object ID, which is also the INODE number.", + "type": "integer" + }, + "is_hidden": { + "description": "Specifies whether the file is hidden or not.", + "type": "boolean" + }, + "last_modified": { + "description": "Specifies the time when the object data was last modified in HTTP date/time format.", + "type": "string" + }, + "mode": { + "description": "Specifies the UNIX mode octal number.", + "type": "string" + }, + "mtime_val": { + "description": "Specifies the time when the object data was last modified in UNIX Epoch format.", + "type": "integer" + }, + "name": { + "description": "Specifies the name of the object.", + "type": "string" + }, + "nlink": { + "description": "Specifies the number of hard links to the object.", + "type": "integer" + }, + "owner": { + "description": "Specifies the user name for the owner of the object.", + "type": "string" + }, + "size": { + "description": "Specifies the size of the object in bytes.", + "type": "integer" + }, + "stub": { + "description": "Specifies whether the file is a stub or not.", + "type": "boolean" + }, + "type": { + "description": "Specifies the object type, which can be one of the following values: container, object, pipe, character_device, block_device, symbolic_link, socket, or whiteout_file.", + "type": "string" + }, + "uid": { + "description": "Specifies the UID for the owner.", + "type": "integer" + } + }, + "type": "object" + }, + "NamespaceObjects": { + "properties": { + "children": { + "items": { + "$ref": "#/definitions/NamespaceObject" + }, + "minItems": 0, + "type": "array" + }, + "resume": { + "type": "string" + } + }, + "type": "object" + }, + "WormCreateParams": { + "properties": { + "commit_to_worm": { + "default": false, + "description": "Specifies whether to commit the file to a WORM state after the retention date is set.", + "type": "boolean" + }, + "worm_retention_date": { + "description": "Specifies the retention expiration date string in Coordinated Universal Time (UTC/GMT).", + "type": "string" + } + }, + "type": "object" + }, + "WormProperties": { + "properties": { + "autocommit_delay": { + "description": "Autocommit delay.", + "type": "integer" + }, + "domain_id": { + "description": "WORM domain ID.", + "type": "integer" + }, + "domain_path": { + "description": "WORM domain path.", + "type": "string" + }, + "worm_committed": { + "description": "Indicates whether the file was committed to the WORM state.", + "type": "boolean" + }, + "worm_ctime": { + "description": "WORM change time.", + "type": "integer" + }, + "worm_override_retention_date": { + "description": "Provides the override retention date that is set on the SmartLock directory where the file resides.", + "type": "string" + }, + "worm_override_retention_date_val": { + "description": "Provides the override retention date in seconds from UNIX Epoch or UTC.", + "type": "integer" + }, + "worm_retention_date": { + "description": "Provides the retention expiration date in Coordinated Universal Time (such as UTC/GMT).", + "type": "string" + }, + "worm_retention_date_val": { + "description": "Provides the retention expiration date in seconds from UNIX Epoch or UTC.", + "type": "integer" + } + }, + "type": "object" + }, + "v10ChangelistEntries": { + "additionalProperties": false, + "properties": { + "entries": { + "items": { + "$ref": "#/definitions/v10ChangelistEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ChangelistEntry": { + "properties": { + "atime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "btime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "change_types": { + "description": "The types of change for this entry.", + "items": { + "enum": [ + "ENTRY_MODIFIED", + "ENTRY_ADDED", + "ENTRY_REMOVED", + "ENTRY_PATH_CHANGED", + "ENTRY_HAS_ADS", + "ENTRY_ADS", + "ENTRY_HAS_HARDLINKS", + "ENTRY_PARENT_REMOVED", + "ENTRY_PATH_LOOKUP_REQ", + "ENTRY_WORM_COMMITTED" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 1, + "type": "array" + }, + "ctime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "data_pool": { + "description": "The data disk pool ID of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "diff_regions": { + "description": "Changed regions of the file", + "items": { + "$ref": "#/definitions/v10ChangelistsChangelistDiffRegionsDiffRegion" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "file_type": { + "description": "Type of file.", + "enum": [ + "(REMOVED)", + "regular", + "directory", + "symlink", + "fifo", + "socket", + "char device", + "block device", + "unknown" + ], + "type": "string" + }, + "gid": { + "description": "The Group ID defined flags of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "The ID of the changelist entry.", + "maxLength": 20, + "minLength": 1, + "type": "string" + }, + "lin": { + "description": "The LIN number of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metadata_pool": { + "description": "The metadata disk pool ID of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "mtime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "num_diff_regions": { + "description": "Number of changed regions stored in the diff_regions array. A value of 2147483646 indicates that diff_regions contains a truncated list of changed regions, and a full list must be obtained from another handler.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "parent_lin": { + "description": "The Parent LIN number of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "The relative path to the file associated with the entry.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "physical_size": { + "description": "The physical size of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "size": { + "description": "The size of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid": { + "description": "The User ID flags of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_flags": { + "description": "The user defined flags of the file associated with the entry.", + "items": { + "enum": [ + "sappnd", + "arch", + "schg", + "sunlnk", + "snapshot", + "uappnd", + "uarch", + "hidden", + "uchg", + "nodump", + "uunlnk", + "offline", + "opaque", + "rdonly", + "reparse", + "sparse", + "system", + "inherit", + "writecache", + "wcinherit", + "noindex", + "ssmartlinked", + "noscow", + "scachedsmartlink", + "shasntfsacl", + "shasntfsog", + "sparentsupgraded", + "sbackupsparse", + "ads", + "hasads", + "wcendurant" + ], + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "parent_lin", + "uid", + "file_type", + "lin", + "physical_size", + "metadata_pool", + "data_pool", + "gid", + "path", + "id", + "size" + ], + "type": "object" + }, + "v10ChangelistEntryCtime": { + "properties": { + "nsec": { + "description": "Nanoseconds component of timespec.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sec": { + "description": "Seconds component of timespec.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "sec" + ], + "type": "object" + }, + "v10ChangelistsChangelistDiffRegions": { + "additionalProperties": false, + "properties": { + "diff_regions": { + "items": { + "$ref": "#/definitions/v10ChangelistsChangelistDiffRegionsDiffRegion" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ChangelistsChangelistDiffRegionsDiffRegion": { + "properties": { + "byte_count": { + "description": "Byte count of change region.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "region_type": { + "description": "Type of change region.", + "enum": [ + "sparse", + "data", + "unchanged" + ], + "maxLength": 9, + "minLength": 4, + "type": "string" + }, + "start_offset": { + "description": "Starting byte offset of change region.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "byte_count", + "region_type", + "start_offset" + ], + "type": "object" + }, + "v10ChangelistsChangelistEntries": { + "additionalProperties": false, + "properties": { + "entries": { + "items": { + "$ref": "#/definitions/v10ChangelistEntry" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v10ClusterFirmwareAssessItem": { + "description": "Start firmware upgrade assessment on cluster.", + "properties": { + "exclude_device": { + "description": "Exclude the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "exclude_type": { + "description": "Exclude the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "fw_pkg": { + "description": "The location (path) of the firmware package which must be within /ifs.", + "maxLength": 4096, + "minLength": 3, + "type": "string" + }, + "fw_pkg_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "include_device": { + "description": "Include the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "include_type": { + "description": "Include the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterFirmwareDevice": { + "description": "The firmware status for the cluster.", + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareDeviceNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterFirmwareDeviceNode": { + "description": "The firmware status for the node.", + "properties": { + "devices": { + "description": "List of the firmware status for hardware components on the node.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareDeviceNodeDevice" + }, + "maxItems": 64, + "minItems": 0, + "type": "array" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "node_unavailable": { + "description": "Node is unavailable.", + "type": "boolean" + }, + "package": { + "description": "List of the firmware binary information for the installed firmware package.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareDeviceNodePackageItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterFirmwareDeviceNodeDevice": { + "description": "The firmware status for a hardware component on the node.", + "properties": { + "device": { + "description": "The name of the device.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "mismatch": { + "description": "Is the firmware up-to-date for this component.", + "type": "boolean" + }, + "target_version": { + "description": "The target firmware version.", + "type": "string" + }, + "type": { + "description": "The device type.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "upgrade_status": { + "description": "The current state of the firmware upgrade for this component. One of the following values: 'queued', 'upgrading', 'upgraded', 'error' or 'null'.'null' indicates that the upgrade status is unknown.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "version": { + "description": "The current firmware version.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterFirmwareDeviceNodePackageItem": { + "description": "The firmware binary information.", + "properties": { + "checksum": { + "description": "Valid checksum string for binary. One of the following: 'ok', 'bad', 'file_missing', or 'na'", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "firmware": { + "description": "The name of the firmware binary.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "version": { + "description": "The version string for the binary.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterFirmwareStatus": { + "description": "The firmware status for the cluster.", + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareStatusNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterFirmwareStatusNode": { + "description": "The firmware status for the node.", + "properties": { + "devices": { + "description": "List of the firmware status for hardware components on the node.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareDeviceNodeDevice" + }, + "maxItems": 64, + "minItems": 0, + "type": "array" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "node_unavailable": { + "description": "Node is unavailable.", + "type": "boolean" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterFirmwareUpgradeItem": { + "description": "The settings necessary to start a firmware upgrade.", + "properties": { + "exclude_device": { + "description": "Exclude the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "exclude_type": { + "description": "Exclude the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "fw_pkg": { + "description": "The location (path) of the firmware package which must be within /ifs.", + "maxLength": 4096, + "minLength": 3, + "type": "string" + }, + "include_device": { + "description": "Include the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "include_type": { + "description": "Include the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "no_burn": { + "description": "Do not burn the firmware.", + "type": "boolean" + }, + "no_reboot": { + "description": "Do not reboot the node after an upgrade", + "type": "boolean" + }, + "nodes_to_upgrade": { + "description": "The nodes scheduled for upgrade. Order in array determines queue position number.\n'all' and null option will upgrade firmware on all nodes in order (Note: 'all' and null options do not apply to simultaneous firmware upgrade).", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "type": "array" + }, + "upgrade_type": { + "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous'", + "maxLength": 128, + "minLength": 3, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNode": { + "description": "Node information.", + "properties": { + "drive_d_config": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfig" + }, + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "hardware": { + "$ref": "#/definitions/v10ClusterNodeHardware" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "internal_ip_address": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "$ref": "#/definitions/v10ClusterNodePartitions" + }, + "sensors": { + "$ref": "#/definitions/v10ClusterNodeSensors" + }, + "sleds": { + "description": "List of the sleds in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSled" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "state": { + "$ref": "#/definitions/v10ClusterNodeState" + }, + "status": { + "$ref": "#/definitions/v10ClusterNodeStatus" + } + }, + "required": [ + "internal_ip_address" + ], + "type": "object" + }, + "v10ClusterNodeDrive": { + "description": "Drive information.", + "properties": { + "bay_group": { + "description": "The name of the bay group this drive belongs to.", + "maxLength": 2147483646, + "minLength": 0, + "type": "string" + }, + "baynum": { + "description": "Numerical representation of this drive's bay.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "blocks": { + "description": "Number of blocks on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "chassis": { + "description": "The chassis number which contains this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "devname": { + "description": "This drive's device name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "firmware": { + "$ref": "#/definitions/v10ClusterNodeDriveFirmware" + }, + "format_progress": { + "description": "Drive format progress percentage.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "handle": { + "description": "Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "interface_type": { + "description": "String representation of this drive's interface type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnum": { + "description": "This drive's logical drive number in IFS.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "locnstr": { + "description": "String representation of this drive's physical location.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logical_block_length": { + "description": "Size of a logical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "media_type": { + "description": "String representation of this drive's media type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "This drive's manufacturer and model.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "pending_actions": { + "description": "This drive's current outstanding actions. For example, \"add\" or \"firmware_update\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "physical_block_length": { + "description": "Size of a physical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "present": { + "description": "Indicates whether this drive is physically present in the node.", + "type": "boolean" + }, + "purpose": { + "description": "This drive's purpose in the DRV state machine.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "purpose_description": { + "description": "Description of this drive's purpose.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "serial": { + "description": "Serial number for this drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ui_state": { + "description": "This drive's state as presented to the UI.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "wwn": { + "description": "The drive's 'worldwide name' from its NAA identifiers.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "x_loc": { + "description": "This drive's x-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "y_loc": { + "description": "This drive's y-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfig": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "alert": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAlert" + }, + "allow": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAllow" + }, + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "instant_secure_erase": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigInstantSecureErase" + }, + "log": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigLog" + }, + "reboot": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigReboot" + }, + "spin_wait": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigSpinWait" + }, + "stall": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigStall" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigAlert": { + "description": "Configuration setting for drive alerts.", + "properties": { + "unknown_firmware": { + "default": true, + "description": "Send alerts for unknown drive firmware.", + "type": "boolean" + }, + "unknown_model": { + "default": true, + "description": "Send alerts for unknown drive model.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigAllow": { + "description": "Configuration settings for drive formatting.", + "properties": { + "format_unknown_firmware": { + "default": true, + "description": "Allow formatting a drive model with unknown firmware.", + "type": "boolean" + }, + "format_unknown_model": { + "default": true, + "description": "Allow formatting an unknown drive model.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigAutomaticReplacementRecognition": { + "description": "Configuration settings for Automatic Replacement Recognition (ARR).", + "properties": { + "enabled": { + "default": true, + "description": "Enable Automatic Replacement Recognition (ARR).", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigInstantSecureErase": { + "description": "Configuration settings for instant secure erase (ISE).", + "properties": { + "enabled": { + "default": "true", + "description": "Instant Secure Erase (ISE).", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigLog": { + "description": "Configuration settings for drive statistics logs.", + "properties": { + "drive_stats": { + "default": true, + "description": "Indicates whether or not to log the drive statistics.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigReboot": { + "description": "Configuration settings for a node reboot due to a drive error.", + "properties": { + "chassis_loss": { + "default": true, + "description": "Indicates whether or not to reboot the node due to a lost chassis.", + "type": "boolean" + }, + "none_present": { + "default": true, + "description": "Indicates whether or not to reboot the node if no drives are present.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigSpinWait": { + "description": "Configuration settings for sleeping the drive daemon before node is rescanned.", + "properties": { + "check_drive": { + "default": 45, + "description": "Seconds to wait between enabling a bay and checking for an inserted drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "stagger": { + "default": 5, + "description": "Seconds to wait between enabling a bay and enabling another bay.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveDConfigStall": { + "description": "Configuration settings to evaluate a drive stall.", + "properties": { + "clear_time": { + "default": 2592000, + "description": "The amount of time in seconds with no stalls before ignoring previous stalls.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "diskscrub_stripes": { + "default": 128, + "description": "Number of stripes to read during a diskscrub.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_error_frequency": { + "default": 0, + "description": "The number of errors during stalled drive disk exercises to cause the drive to be softfailed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_slow_access": { + "default": 0, + "description": "The number of slow accesses during stalled drive disk exercises to cause the drive to be softfailed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_slow_frequency": { + "default": 0, + "description": "The number of slow frequency triggers during stalled drive disk exercises to cause the drive to be softfailed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_total_stall_time": { + "default": 10800, + "description": "The maximum amount of time, in seconds, to remain stalled before softfailing the drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "scan_max_ecc_delay": { + "default": 60, + "description": "Maximum delay in seconds after an ECC correction during a scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "scan_size": { + "default": 16777216, + "description": "Total bytes of error-free reads to complete a scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sleep": { + "default": 30, + "description": "Delay in seconds between evaluations.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterNodeDriveFirmware": { + "description": "Drive firmware information.", + "properties": { + "current_firmware": { + "description": "This drive's current firmware revision", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "desired_firmware": { + "description": "This drive's desired firmware revision.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNodeHardware": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_count": { + "description": "Number of chassis making up this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_depth": { + "description": "Chassis depth for this node if applicable (e.g., Normal, Deep, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "code_name": { + "description": "Code name of this node if applicable If not supported or error: Unknown.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "compute_type": { + "description": "Type of compute node if applicable (e.g., Low, Medium, High, Turbo, Ultra, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "flash_drive": { + "description": "Manufacturer, model, and device id of this node's flash drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "imb_version": { + "description": "Version of this node's PowerScale Management Board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "PowerScale node model identifier string (S200, X410, Infinity-H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model_code": { + "description": "PowerScale node model code string (S200, X410, H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_slot_id": { + "description": "Position of node within chassis. -1 for error or not supported.", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "peer_serial_number": { + "description": "Serial number of this node's peer/buddy node.(Infinity Only)", + "type": "string" + }, + "performance_code": { + "description": "Performance code of this node, if applicable (2, 4, 5, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sled_drive_count": { + "description": "Size of drive sleds in node, if applicable. Expected values: 3, 4, 6. 0 if unable to determine sled size. -1 for error or not supported. If PSI_Get fails: -1. PSI_Get can fail if PSI not initialized, or key does not exist.", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "tier": { + "description": "Platform tier level of this node if applicable(positive for a defined tier, 0 for unknown or not supported, -1 for error).", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "top_level_assembly_serial_number": { + "description": "Serial number of the top level assembly of this node.(Infinity Only)", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "top_level_assembly_serial_number", + "peer_serial_number" + ], + "type": "object" + }, + "v10ClusterNodePartition": { + "description": "Node partition information.", + "properties": { + "block_size": { + "description": "The block size used for the reported partition information.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "capacity": { + "description": "Total blocks on this file system partition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "component_devices": { + "description": "Comma separated list of devices used for this file system partition.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "mount_point": { + "description": "Directory on which this partition is mounted.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "percent_used": { + "description": "Used blocks on this file system partition, expressed as a percentage.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "statfs": { + "$ref": "#/definitions/v10ClusterNodePartitionStatfs" + }, + "used": { + "description": "Used blocks on this file system partition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterNodePartitionStatfs": { + "description": "System partition details as provided by statfs(2).", + "properties": { + "f_bavail": { + "description": "Free blocks available to non-superuser on this partition.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "f_bfree": { + "description": "Free blocks on this partition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_blocks": { + "description": "Total data blocks on this partition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_bsize": { + "description": "Filesystem fragment size; block size in OneFS.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_ffree": { + "description": "Free file nodes avail to non-superuser.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_files": { + "description": "Total file nodes in filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_flags": { + "description": "Mount exported flags.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_fstypename": { + "description": "File system type name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "f_iosize": { + "description": "Optimal transfer block size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_mntfromname": { + "description": "Names of devices this partition is mounted from.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "f_mntonname": { + "description": "Directory this partition is mounted to.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "f_namemax": { + "description": "Maximum filename length.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_owner": { + "description": "UID of user that mounted the filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_type": { + "description": "Type of filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "f_version": { + "description": "statfs() structure version number.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterNodePartitions": { + "description": "Node partition information.", + "properties": { + "count": { + "description": "Count of how many partitions are included.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "partitions": { + "description": "Partition information.", + "items": { + "$ref": "#/definitions/v10ClusterNodePartition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10ClusterNodeSensor": { + "description": "Node sensor information.", + "properties": { + "count": { + "description": "The count of values in this sensor group.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of this sensor group.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "values": { + "description": "The list of specific sensor value info in this sensor group.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSensorValue" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10ClusterNodeSensorValue": { + "description": "Specific sensor value info.", + "properties": { + "desc": { + "description": "The descriptive name of this sensor.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The identifier name of this sensor.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "units": { + "description": "The units of this sensor.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "value": { + "description": "The value of this sensor.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNodeSensors": { + "description": "Node sensor information (hardware reported).", + "properties": { + "sensors": { + "description": "This node's sensor information.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSensor" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10ClusterNodeSled": { + "description": "Information about a sled in node.", + "properties": { + "is_removeable": { + "description": "Boolean to indicate whether or not the sled is safe to remove.", + "type": "boolean" + }, + "sled_letter": { + "description": "The sled letter which OneFS uses to refer to this sled in the node.", + "maxLength": 1, + "minLength": 1, + "pattern": "^[a-eA-E]$", + "type": "string" + }, + "sled_state": { + "description": "The state of physical presence of a sled.", + "enum": [ + "Present", + "Absent", + "Unknown" + ], + "maxLength": 7, + "minLength": 6, + "pattern": "^[a-zA-Z]+$", + "type": "string" + } + }, + "required": [ + "is_removeable", + "sled_state", + "sled_letter" + ], + "type": "object" + }, + "v10ClusterNodeState": { + "description": "Node state information (reported and modifiable).", + "properties": { + "readonly": { + "$ref": "#/definitions/v10ClusterNodeStateReadonly" + }, + "servicelight": { + "$ref": "#/definitions/v10ClusterNodeStateServicelight" + }, + "smartfail": { + "$ref": "#/definitions/v10ClusterNodeStateSmartfail" + } + }, + "type": "object" + }, + "v10ClusterNodeStateReadonly": { + "description": "Node readonly state.", + "properties": { + "allowed": { + "description": "The current read-only mode allowed status for the node.", + "type": "boolean" + }, + "enabled": { + "description": "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared.", + "type": "boolean" + }, + "mode": { + "description": "The current read-only mode status for the node.", + "type": "boolean" + }, + "status": { + "description": "The current read-only mode status description for the node.", + "type": "string" + }, + "valid": { + "description": "The read-only state values are valid (False = Error).", + "type": "boolean" + }, + "value": { + "description": "The current read-only value (enumerated bitfield) for the node.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ClusterNodeStateServicelight": { + "description": "Node service light state.", + "properties": { + "enabled": { + "description": "The node service light state (True = on).", + "type": "boolean" + }, + "present": { + "description": "This node has a service light.", + "type": "boolean" + }, + "supported": { + "description": "This node supports a service light.", + "type": "boolean" + }, + "valid": { + "description": "The node service light state is valid (False = Error).", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "type": "object" + }, + "v10ClusterNodeStateSmartfail": { + "description": "Node smartfail state.", + "properties": { + "dead": { + "description": "This node is dead (dead_devs).", + "type": "boolean" + }, + "down": { + "description": "This node is down (down_devs).", + "type": "boolean" + }, + "in_cluster": { + "description": "This node is in the cluster (all_devs).", + "type": "boolean" + }, + "readonly": { + "description": "This node is readonly (ro_devs).", + "type": "boolean" + }, + "shutdown_readonly": { + "description": "This node is shutdown readonly (down_devs).", + "type": "boolean" + }, + "smartfailed": { + "description": "This node is smartfailed (soft_devs).", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeStatus": { + "description": "Node status information (hardware reported).", + "properties": { + "batterystatus": { + "$ref": "#/definitions/v10ClusterNodeStatusBatterystatus" + }, + "capacity": { + "description": "Storage capacity of this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusCapacityItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "cpu": { + "$ref": "#/definitions/v10ClusterNodeStatusCpu" + }, + "nvram": { + "$ref": "#/definitions/v10ClusterNodeStatusNvram" + }, + "powersupplies": { + "$ref": "#/definitions/v10ClusterNodeStatusPowersupplies" + }, + "release": { + "description": "OneFS release.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uptime": { + "description": "Seconds this node has been online.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "version": { + "description": "OneFS version.", + "maxLength": 511, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNodeStatusBatterystatus": { + "description": "Battery status information.", + "properties": { + "last_test_time1": { + "description": "The last battery test time for battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_test_time2": { + "description": "The last battery test time for battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "next_test_time1": { + "description": "The next checkup for battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "next_test_time2": { + "description": "The next checkup for battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "present": { + "description": "Node has battery status.", + "type": "boolean" + }, + "result1": { + "description": "The result of the last battery test for battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "result2": { + "description": "The result of the last battery test for battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status1": { + "description": "The status of battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status2": { + "description": "The status of battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "supported": { + "description": "Node supports battery status.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeStatusCapacityItem": { + "description": "Node capacity information.", + "properties": { + "bytes": { + "description": "Total device storage bytes.", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "format": "int64" + }, + "count": { + "description": "Total device count.", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Device type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNodeStatusCpu": { + "description": "CPU status information for this node.", + "properties": { + "model": { + "description": "Manufacturer model description of this CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "overtemp": { + "description": "CPU overtemp state.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "proc": { + "description": "Type of processor and core of this CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "speed_limit": { + "description": "CPU throttling (expressed as a percentage).", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNodeStatusNvram": { + "description": "Node NVRAM information.", + "properties": { + "batteries": { + "description": "This node's NVRAM battery status information.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusNvramBattery" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "battery_count": { + "description": "This node's NVRAM battery count. On failure: -1, otherwise 1 or 2.", + "maximum": 2, + "minimum": -1, + "type": "integer" + }, + "charge_status": { + "description": "This node's NVRAM battery charge status, as a color.", + "enum": [ + "BLACK", + "GREEN", + "YELLOW", + "RED", + "UNKNOWN", + "Not supported" + ], + "maxLength": 13, + "minLength": 3, + "type": "string" + }, + "charge_status_number": { + "description": "This node's NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3.", + "maximum": 3, + "minimum": -1, + "type": "integer" + }, + "device": { + "description": "This node's NVRAM device name with path.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "present": { + "description": "This node has NVRAM.", + "type": "boolean" + }, + "present_flash": { + "description": "This node has NVRAM with flash storage.", + "type": "boolean" + }, + "present_size": { + "description": "The size of the NVRAM, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "present_type": { + "description": "This node's NVRAM type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ship_mode": { + "description": "This node's current ship mode state for NVRAM batteries. If not supported or on failure: -1. Disabled: 0. Enabled: 1.", + "enum": [ + -1, + 0, + 1 + ], + "type": "integer" + }, + "supported": { + "description": "This node supports NVRAM.", + "type": "boolean" + }, + "supported_flash": { + "description": "This node supports NVRAM with flash storage.", + "type": "boolean" + }, + "supported_size": { + "description": "The maximum size of the NVRAM, in bytes.", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "format": "int64" + }, + "supported_type": { + "description": "This node's supported NVRAM type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNodeStatusNvramBattery": { + "description": "NVRAM battery status information.", + "properties": { + "color": { + "description": "The current status color of the NVRAM battery.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Identifying index for the NVRAM battery.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "The current status message of the NVRAM battery.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "voltage": { + "description": "The current voltage of the NVRAM battery.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10ClusterNodeStatusPowersupplies": { + "description": "Information about this node's power supplies.", + "properties": { + "count": { + "description": "Count of how many power supplies are supported.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "failures": { + "description": "Count of how many power supplies have failed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "has_cff": { + "description": "Does this node have a CFF power supply.", + "type": "boolean" + }, + "status": { + "description": "A descriptive status string for this node's power supplies.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "supplies": { + "description": "List of this node's power supplies.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusPowersuppliesSupply" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "supports_cff": { + "description": "Does this node support CFF power supplies.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ClusterNodeStatusPowersuppliesSupply": { + "description": "Power supply information.", + "properties": { + "chassis": { + "description": "Which node chassis is this power supply in.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "firmware": { + "description": "The current firmware revision of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "good": { + "description": "Is this power supply in a failure state.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Identifying index for this power supply.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Complete identifying string for this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "A descriptive status string for this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "The type of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v10ClusterNodes": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v10ClusterNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ConfigFeature": { + "properties": { + "enabled": { + "description": "A True value indicates the BMC LAN feature is currently enabled on the cluster.", + "type": "boolean" + }, + "feature_description": { + "description": "A longer more formal description of the feature.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "A string used to identify the feature, such as sol for Serial-Over-LAN or power-control for Power Control.", + "maxLength": 16, + "minLength": 3, + "type": "string" + } + }, + "type": "object" + }, + "v10ConfigFeatureExtended": { + "properties": { + "enabled": { + "description": "A True value indicates the BMC LAN feature is currently enabled on the cluster.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ConfigFeatures": { + "additionalProperties": false, + "properties": { + "features": { + "items": { + "$ref": "#/definitions/v10ConfigFeature" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ConfigFeaturesExtended": { + "additionalProperties": false, + "properties": { + "features": { + "items": { + "$ref": "#/definitions/v10ConfigFeature" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v10ConfigNetwork": { + "properties": { + "network": { + "$ref": "#/definitions/v10ConfigNetworkNetwork" + } + }, + "type": "object" + }, + "v10ConfigNetworkExtended": { + "properties": { + "gateway": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "prefixlen": { + "description": "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + "maximum": 32, + "minimum": 0, + "type": "integer" + }, + "ranges": { + "description": "List of IP address ranges.", + "items": { + "$ref": "#/definitions/v10ConfigNetworkRange" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10ConfigNetworkNetwork": { + "properties": { + "gateway": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "prefixlen": { + "description": "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + "maximum": 32, + "minimum": 0, + "type": "integer" + }, + "ranges": { + "description": "List of IP address ranges.", + "items": { + "$ref": "#/definitions/v7ClusterInternalNetworksFailoverIpAddresse" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "gateway" + ], + "type": "object" + }, + "v10ConfigNetworkRange": { + "description": "Specifies range of IP addresses where 'low' is starting address and 'high' is the end address.' Both 'low' and 'high' addresses are inclusive to the range.", + "properties": { + "high": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "low": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + } + }, + "type": "object" + }, + "v10ConfigNode": { + "properties": { + "devid": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "ip_addr": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "remote_ipmi_capable": { + "description": "True if the node supports the Remote IPMI Management feature", + "type": "boolean" + }, + "status": { + "description": "This field indicates if BMC version is good and if the feature is supported.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "ip_addr" + ], + "type": "object" + }, + "v10ConfigNodes": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v10ConfigNode" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10ConfigNodesExtended": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v10ConfigNode" + }, + "maxItems": 1024, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v10ConfigSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v10ConfigSettingsSettings" + } + }, + "type": "object" + }, + "v10ConfigSettingsSettings": { + "properties": { + "allocation_type": { + "description": "Identifies the current network type (dhcp or static) being used for this BMC LAN interface.", + "enum": [ + "static", + "dhcp" + ], + "type": "string" + }, + "enabled": { + "description": "A True value indicates the Remote IPMI Management feature is currently enabled on the cluster.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10ConfigUser": { + "properties": { + "user": { + "$ref": "#/definitions/v10ConfigUserUser" + } + }, + "type": "object" + }, + "v10ConfigUserUser": { + "properties": { + "id": { + "description": "The numeric User ID associated with the username.", + "maximum": 16, + "minimum": 3, + "type": "integer" + }, + "password": { + "description": "Represents the password that customers will use with the IPMI username when authenticating remote IPMI requests.", + "maxLength": 20, + "minLength": 16, + "type": "string" + }, + "username": { + "description": "Represents the username that customers will use when authenticating remote IPMI requests.", + "maxLength": 16, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10DatasetFilter": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v10DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v10DatasetFilterExtended": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "creation_time": { + "description": "Timestamp of when the filter was applied.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the filter configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The filter ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v10DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v10DatasetFilterMetricValues": { + "additionalProperties": false, + "description": "Configurable metrics.", + "properties": { + "export_id": { + "description": "NFS export ID", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "groupname": { + "description": "groupname", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "local_address": { + "description": "Local IPv4, IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "path": { + "description": "Path of tracked directory", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "protocol": { + "description": "The protocol used for the request", + "enum": [ + "smb1", + "smb2", + "nfs3", + "nfs4", + "s3" + ], + "type": "string" + }, + "remote_address": { + "description": "Client IPv4 or IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "share_name": { + "description": "SMB share name", + "maxLength": 320, + "minLength": 1, + "type": "string" + }, + "username": { + "description": "username", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "zone_name": { + "description": "The zone name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10DatasetFilterMetricValuesExtended": { + "allOf": [ + { + "$ref": "#/definitions/v10DatasetFilterMetricValues" + }, + { + "description": "Performance metric values that can be used to pin workloads and apply filters, and performance metric values that are used to display information about the system performance dataset.", + "properties": { + "job_type": { + "description": "The job type.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "system_name": { + "description": "The system name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "v10DatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v10DatasetFilterExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v10DatasetWorkload": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v10DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v10DatasetWorkloadExtended": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "creation_time": { + "description": "Timestamp of when the workload was pinned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the workload configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The workload ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v10DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v10DatasetWorkloads": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "workloads": { + "items": { + "$ref": "#/definitions/v10DatasetWorkloadExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v10DatasetsDatasetFilter": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10DatasetsDatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v10DatasetFilterExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v10DatasetsDatasetWorkload": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10DatasetsDatasetWorkloads": { + "additionalProperties": false, + "properties": { + "workloads": { + "items": { + "$ref": "#/definitions/v10DatasetWorkloadExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v10HealthcheckChecklist": { + "description": "Checklist definition", + "properties": { + "delivery": { + "description": "List of delivery addresses/methods for results", + "items": { + "$ref": "#/definitions/v10HealthcheckChecklistDeliveryItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "description": { + "description": "Description covering intended use", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "history": { + "description": "Number of evaluation results to keep", + "maximum": 1000, + "minimum": 1, + "type": "integer" + }, + "id": { + "description": "Unique identifier", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "items": { + "description": "Items to be evaluated", + "items": { + "$ref": "#/definitions/v10HealthcheckChecklistItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10HealthcheckChecklistDeliveryItem": { + "description": "Evaluation Request/Result", + "properties": { + "address": { + "description": "Email addresses to send to.", + "items": { + "maxLength": 320, + "minLength": 5, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "email_host": { + "description": "SMTP relay host.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_pass": { + "description": "Password for SMTP authentication.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_port": { + "description": "SMTP relay port - optional defaults to 25.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "email_security": { + "description": "Encryption protocol to use for SMTP.", + "enum": [ + "NONE", + "STARTTLS" + ], + "type": "string" + }, + "email_user": { + "description": "Username for SMTP authentication.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "failonly": { + "description": "Only send failures", + "type": "boolean" + }, + "method": { + "description": "Delivery method", + "enum": [ + "EMAIL" + ], + "type": "string" + } + }, + "required": [ + "failonly", + "method" + ], + "type": "object" + }, + "v10HealthcheckChecklistExtended": { + "description": "Delivery update", + "properties": { + "delivery": { + "description": "List of delivery addresses/methods for results", + "items": { + "$ref": "#/definitions/v10HealthcheckChecklistDeliveryItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "history": { + "description": "Number of evaluation results to keep", + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v10HealthcheckChecklistItem": { + "description": "Item to be evaluated as part of a checklist", + "properties": { + "freshness": { + "description": "Optional freshness override", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Name of item", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/Empty" + }, + "pass_status": { + "description": "Optional pass status override", + "enum": [ + "OK", + "WARNING", + "CRITICAL", + "EMERGENCY" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "thresholds": { + "$ref": "#/definitions/v10HealthcheckChecklistItemThresholds" + } + }, + "type": "object" + }, + "v10HealthcheckChecklistItemThresholds": { + "description": "Overrides for status thresholds", + "properties": { + "critical": { + "description": "Minimum value for CRITICAL - below this EMERGENCY", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "ok": { + "description": "Minimum value for OK - must be > warning", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "warning": { + "description": "Minimum value for WARNING - must be > critical", + "maximum": 100, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10HealthcheckChecklists": { + "additionalProperties": false, + "properties": { + "checklists": { + "items": { + "$ref": "#/definitions/v10HealthcheckChecklist" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10HealthcheckChecklistsExtended": { + "additionalProperties": false, + "properties": { + "checklists": { + "items": { + "$ref": "#/definitions/v10HealthcheckChecklist" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10HealthcheckEvaluation": { + "description": "Evaluation Request/Result", + "properties": { + "checklist_id": { + "description": "Checklist to be run", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "delivery": { + "description": "List of delivery addresses/methods for results", + "items": { + "$ref": "#/definitions/v10HealthcheckChecklistDeliveryItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "overrides": { + "description": "Optional overrides for thresholds etc.", + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationOverride" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "parameters": { + "$ref": "#/definitions/Empty" + } + }, + "required": [ + "checklist_id" + ], + "type": "object" + }, + "v10HealthcheckEvaluationDetail": { + "description": "The result of an item evaluation", + "properties": { + "details": { + "description": "Optional details of the evaluation - raw data", + "items": { + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "properties": {}, + "type": "array" + }, + "hash": { + "description": "Unique identifier", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Unique identifier of item", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node": { + "description": "Either 'cluster' or an lnn", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/Empty" + }, + "status": { + "description": "Health status based on default thresholds", + "enum": [ + "OK", + "WARNING", + "CRITICAL", + "EMERGENCY", + "UNSUPPORTED", + "ERROR", + "INFO", + "ERROR Check script failed", + "ERROR Check script timed out" + ], + "type": "string" + }, + "value": { + "description": "Normalized measured value 0 (bad) to 100 (perfect)", + "maximum": 100, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10HealthcheckEvaluationExtended": { + "description": "Evaluation Request/Result", + "properties": { + "checklist_id": { + "description": "Checklist to be run", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "delivery": { + "description": "List of delivery addresses/methods for results", + "items": { + "$ref": "#/definitions/v10HealthcheckChecklistDeliveryItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "details": { + "description": "Evaluation results by item - only if COMPLETED", + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationDetail" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "overrides": { + "description": "Optional overrides for thresholds etc.", + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationOverride" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "parameters": { + "$ref": "#/definitions/Empty" + }, + "result": { + "description": "Overall result of evaluation - only if COMPLETED", + "enum": [ + "PASS", + "FAIL" + ], + "type": "string" + }, + "run_status": { + "description": "Execution status", + "enum": [ + "QUEUED", + "RUNNING", + "PAUSED", + "FAILED", + "COMPLETED" + ], + "type": "string" + }, + "start_time": { + "description": "Specifies the start time for a checklist or item.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "v10HealthcheckEvaluationExtendedExtended": { + "description": "Pause/Resume control", + "properties": { + "action": { + "description": "Pause or Resume", + "enum": [ + "pause", + "resume" + ], + "type": "string" + } + }, + "type": "object" + }, + "v10HealthcheckEvaluationOverride": { + "description": "Overrides for item pass_status, freshness and thresholds", + "properties": { + "freshness": { + "description": "Optional freshness override", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "Id of Item to which override applies", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "pass_status": { + "description": "Optional pass status override", + "enum": [ + "OK", + "WARNING", + "CRITICAL", + "EMERGENCY" + ], + "type": "string" + }, + "thresholds": { + "$ref": "#/definitions/v10HealthcheckChecklistItemThresholds" + } + }, + "type": "object" + }, + "v10HealthcheckEvaluations": { + "additionalProperties": false, + "properties": { + "evaluations": { + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10HealthcheckEvaluationsExtended": { + "additionalProperties": false, + "properties": { + "evaluations": { + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10HealthcheckSchedule": { + "description": "Evaluation schedule", + "properties": { + "checklist": { + "description": "Checklists or Items for scheduling.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "id": { + "description": "The ID of the newly created schedule.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The schedule name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "schedule": { + "description": "The isi-schedule compatible natural language description of the schedule.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "checklist", + "schedule", + "name" + ], + "type": "object" + }, + "v10HealthcheckScheduleExtended": { + "description": "Evaluation schedule", + "properties": { + "base": { + "description": "Seconds from Epoc when schedule was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "checklist": { + "description": "Checklists or Items for scheduling.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "id": { + "description": "The ID of the newly created schedule.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The schedule name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "next_run": { + "description": "Seconds from Epoc when next evaluation will run.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "schedule": { + "description": "The isi-schedule compatible natural language description of the schedule.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10HealthcheckScheduleExtendedExtended": { + "description": "Evaluation schedule", + "properties": { + "checklist": { + "description": "Checklists or Items for scheduling.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "The ID of the newly created schedule.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The schedule name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "schedule": { + "description": "The isi-schedule compatible natural language description of the schedule.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v10HealthcheckSchedules": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "schedules": { + "items": { + "$ref": "#/definitions/v10HealthcheckScheduleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10HealthcheckSchedulesExtended": { + "additionalProperties": false, + "properties": { + "schedules": { + "items": { + "$ref": "#/definitions/v10HealthcheckScheduleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10JobJob": { + "properties": { + "allow_dup": { + "description": "Whether or not to queue the job if one of the same type is already running or queued.", + "type": "boolean" + }, + "avscan_params": { + "$ref": "#/definitions/v10JobJobAvscanParams" + }, + "changelistcreate_params": { + "$ref": "#/definitions/v10JobJobChangelistcreateParams" + }, + "domainmark_params": { + "$ref": "#/definitions/v1JobJobDomainmarkParams" + }, + "esrsmftdownload_params": { + "$ref": "#/definitions/v1JobJobEsrsmftdownloadParams" + }, + "filepolicy_params": { + "$ref": "#/definitions/v10JobJobFilepolicyParams" + }, + "paths": { + "description": "For jobs which take paths, the IFS paths to pass to the job.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "policy": { + "description": "Impact policy of this job instance.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "prepair_params": { + "$ref": "#/definitions/v1JobJobPrepairParams" + }, + "priority": { + "description": "Priority of this job instance; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "smartpoolstree_params": { + "$ref": "#/definitions/v1JobJobSmartpoolstreeParams" + }, + "snaprevert_params": { + "$ref": "#/definitions/v1JobJobSnaprevertParams" + }, + "treedelete_params": { + "$ref": "#/definitions/v10JobJobTreedeleteParams" + }, + "type": { + "description": "Job type to queue.", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v10JobJobAvscanParams": { + "description": "Parameters required for the AVScan job.", + "properties": { + "force_run": { + "description": "Force files to be scanned, even if excluded by the policy.", + "type": "boolean" + }, + "policy": { + "description": "The antivirus scan policy to run.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "report_id": { + "description": "An optional report id for the scan.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "update": { + "description": "Update the last run time for the policy.", + "type": "boolean" + } + }, + "required": [ + "policy" + ], + "type": "object" + }, + "v10JobJobChangelistcreateParams": { + "description": "Parameters required for the ChangelistCreate job.", + "properties": { + "create_diffs": { + "description": "Whether to store snapshot differential region information for files with data changes.", + "type": "boolean" + }, + "newer_snapid": { + "description": "Newer snapshot ID.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "older_snapid": { + "description": "Older snapshot ID.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "retain_repstate": { + "description": "Whether to retain the replication record after a changelist is created. Retaining a replication record allows a changelist to be recreated later.", + "type": "boolean" + } + }, + "required": [ + "newer_snapid", + "older_snapid" + ], + "type": "object" + }, + "v10JobJobExtended": { + "properties": { + "control_state": { + "description": "State to which the job is transitioning; if control_state is identical to state, the job's state is stable.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority", + "cancelled_user", + "cancelled_system", + "failed", + "succeeded", + "failed_not_retried", + "unknown" + ], + "type": "string" + }, + "create_time": { + "description": "The time the job was queued, in seconds since the epoch.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "current_phase": { + "description": "The current phase of the job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "description": { + "description": "A text representation of the job.", + "maxLength": 2147483646, + "minLength": 0, + "type": "string" + }, + "end_time": { + "description": "The time the job ended, in seconds since the Epoch.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "human_desc": { + "description": "A helpful human-readable description of the job", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "impact": { + "description": "The current impact of the job.", + "enum": [ + "Low", + "Medium", + "High", + "Paused" + ], + "type": "string" + }, + "participants": { + "description": "The set of devids working on the job.", + "items": { + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "paths": { + "description": "Paths for which the job was queued.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "policy": { + "description": "Current impact policy of the job.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Current priority of the job; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "progress": { + "description": "A text representation of the job's progress.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "retries_remaining": { + "description": "The number of retries remaining if the job fails.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "running_time": { + "description": "The number of seconds the job has executed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started, in seconds since the Epoch.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "Current state of the job.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority", + "cancelled_user", + "cancelled_system", + "failed", + "succeeded", + "failed_not_retried", + "unknown" + ], + "type": "string" + }, + "total_phases": { + "description": "The total number of phases of the job type.", + "maximum": 15, + "minimum": 1, + "type": "integer" + }, + "type": { + "description": "The job type.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "waiting_on": { + "description": "The ID of a job for which this job is waiting.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "waiting_reason": { + "description": "The reason the job is waiting.", + "enum": [ + "blocked_by_priority" + ], + "type": "string" + } + }, + "required": [ + "impact", + "type", + "state", + "priority", + "create_time", + "total_phases", + "policy", + "retries_remaining", + "human_desc", + "id" + ], + "type": "object" + }, + "v10JobJobFilepolicyParams": { + "description": "Optional parameters for the FilePolicy job.", + "properties": { + "directory_only": { + "description": "Skip processing of regular files.", + "type": "boolean" + }, + "nop": { + "description": "Calculate what would be done (dry run).", + "type": "boolean" + }, + "policy_only": { + "description": "Apply policies but skip restriping.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10JobJobTreedeleteParams": { + "description": "Optional parameters for the Treedelete job.", + "properties": { + "delete_quotas": { + "default": false, + "description": "Delete quotas encountered during TreeDelete. When set to false, the job will fail if a quota is encountered.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10JobJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v10JobJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NetworkGroupnet": { + "properties": { + "allow_wildcard_subdomains": { + "description": "If enabled, SmartConnect treats subdomains of known dns zones as the known dns zone. This is required for S3 Virtual Host domains. Defaults to True.", + "type": "boolean" + }, + "description": { + "description": "A description of the groupnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dns_cache_enabled": { + "description": "DNS caching is enabled or disabled.", + "type": "boolean" + }, + "dns_options": { + "description": "List of DNS resolver options.", + "items": { + "enum": [ + "rotate" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "dns_search": { + "description": "List of DNS search suffixes.", + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "dns_servers": { + "description": "List of Domain Name Server IP addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the groupnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "server_side_dns_search": { + "description": "Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP.", + "type": "boolean" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v10NetworkGroupnetExtended": { + "properties": { + "allow_wildcard_subdomains": { + "description": "If enabled, SmartConnect treats subdomains of known dns zones as the known dns zone. This is required for S3 Virtual Host domains. Defaults to True.", + "type": "boolean" + }, + "description": { + "description": "A description of the groupnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dns_cache_enabled": { + "description": "DNS caching is enabled or disabled.", + "type": "boolean" + }, + "dns_options": { + "description": "List of DNS resolver options.", + "items": { + "enum": [ + "rotate" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "dns_search": { + "description": "List of DNS search suffixes.", + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "dns_servers": { + "description": "List of Domain Name Server IP addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique Interface ID.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The name of the groupnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "server_side_dns_search": { + "description": "Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP.", + "type": "boolean" + }, + "subnets": { + "description": "Name of the subnets in the groupnet.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10NetworkGroupnetExtendedExtended": { + "properties": { + "allow_wildcard_subdomains": { + "description": "If enabled, SmartConnect treats subdomains of known dns zones as the known dns zone. This is required for S3 Virtual Host domains. Defaults to True.", + "type": "boolean" + }, + "description": { + "description": "A description of the groupnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dns_cache_enabled": { + "description": "DNS caching is enabled or disabled.", + "type": "boolean" + }, + "dns_options": { + "description": "List of DNS resolver options.", + "items": { + "enum": [ + "rotate" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "dns_search": { + "description": "List of DNS search suffixes.", + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "dns_servers": { + "description": "List of Domain Name Server IP addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the groupnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "server_side_dns_search": { + "description": "Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10NetworkGroupnets": { + "additionalProperties": false, + "properties": { + "groupnets": { + "items": { + "$ref": "#/definitions/v10NetworkGroupnetExtended" + }, + "maxItems": 1024, + "minItems": 1, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NetworkGroupnetsExtended": { + "additionalProperties": false, + "properties": { + "groupnets": { + "items": { + "$ref": "#/definitions/v10NetworkGroupnetExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v10NodeHardware": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v10NodeHardwareNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NodeHardwareNode": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_count": { + "description": "Number of chassis making up this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_depth": { + "description": "Chassis depth for this node if applicable (e.g., Normal, Deep, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "code_name": { + "description": "Code name of this node if applicable If not supported or error: Unknown.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "compute_type": { + "description": "Type of compute node if applicable (e.g., Low, Medium, High, Turbo, Ultra, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "flash_drive": { + "description": "Manufacturer, model, and device id of this node's flash drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "imb_version": { + "description": "Version of this node's PowerScale Management Board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "model": { + "description": "PowerScale node model identifier string (S200, X410, Infinity-H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model_code": { + "description": "PowerScale node model code string (S200, X410, H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_slot_id": { + "description": "Position of node within chassis. -1 for error or not supported.", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "peer_serial_number": { + "description": "Serial number of this node's peer/buddy node.(Infinity Only)", + "type": "string" + }, + "performance_code": { + "description": "Performance code of this node, if applicable (2, 4, 5, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sled_drive_count": { + "description": "Size of drive sleds in node, if applicable. Expected values: 3, 4, 6. 0 if unable to determine sled size. -1 for error or not supported. If PSI_Get fails: -1. PSI_Get can fail if PSI not initialized, or key does not exist.", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "tier": { + "description": "Platform tier level of this node if applicable(positive for a defined tier, 0 for unknown or not supported, -1 for error).", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "top_level_assembly_serial_number": { + "description": "Serial number of the top level assembly of this node.(Infinity Only)", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "top_level_assembly_serial_number", + "peer_serial_number" + ], + "type": "object" + }, + "v10NodeStatusCpu": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v10NodeStatusCpuNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NodeStatusCpuNode": { + "description": "CPU status information for this node.", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "model": { + "description": "Manufacturer model description of this CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "overtemp": { + "description": "CPU overtemp state.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "proc": { + "description": "Type of processor and core of this CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "speed_limit": { + "description": "CPU throttling (expressed as a percentage).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NodeStatusNvram": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v10NodeStatusNvramNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NodeStatusNvramNode": { + "description": "Node NVRAM information.", + "properties": { + "batteries": { + "description": "This node's NVRAM battery status information.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusNvramBattery" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "battery_count": { + "description": "This node's NVRAM battery count. On failure: -1, otherwise 1 or 2.", + "maximum": 2, + "minimum": -1, + "type": "integer" + }, + "charge_status": { + "description": "This node's NVRAM battery charge status, as a color.", + "enum": [ + "BLACK", + "GREEN", + "YELLOW", + "RED", + "UNKNOWN", + "Not supported" + ], + "maxLength": 13, + "minLength": 3, + "type": "string" + }, + "charge_status_number": { + "description": "This node's NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3.", + "maximum": 3, + "minimum": -1, + "type": "integer" + }, + "device": { + "description": "This node's NVRAM device name with path.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "present": { + "description": "This node has NVRAM.", + "type": "boolean" + }, + "present_flash": { + "description": "This node has NVRAM with flash storage.", + "type": "boolean" + }, + "present_size": { + "description": "The size of the NVRAM, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "present_type": { + "description": "This node's NVRAM type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ship_mode": { + "description": "This node's current ship mode state for NVRAM batteries. If not supported or on failure: -1. Disabled: 0. Enabled: 1.", + "enum": [ + -1, + 0, + 1 + ], + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "supported": { + "description": "This node supports NVRAM.", + "type": "boolean" + }, + "supported_flash": { + "description": "This node supports NVRAM with flash storage.", + "type": "boolean" + }, + "supported_size": { + "description": "The maximum size of the NVRAM, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "supported_type": { + "description": "This node's supported NVRAM type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v10NodeStatusPowersupplies": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v10NodeStatusPowersuppliesNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NodeStatusPowersuppliesNode": { + "description": "Information about this node's power supplies.", + "properties": { + "count": { + "description": "Count of how many power supplies are supported.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "failures": { + "description": "Count of how many power supplies have failed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "has_cff": { + "description": "Does this node have a CFF power supply.", + "type": "boolean" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "A descriptive status string for this node's power supplies.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "supplies": { + "description": "List of this node's power supplies.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusPowersuppliesSupply" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "supports_cff": { + "description": "Does this node support CFF power supplies.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10NodesNodeFirmwareDevice": { + "description": "The firmware status for the node.", + "properties": { + "devices": { + "description": "List of the firmware status for hardware components on the node.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareDeviceNodeDevice" + }, + "maxItems": 64, + "minItems": 0, + "type": "array" + }, + "node_unavailable": { + "description": "Node is unavailable.", + "type": "boolean" + } + }, + "type": "object" + }, + "v10NodetypeAssess": { + "additionalProperties": false, + "properties": { + "nodetypes": { + "items": { + "$ref": "#/definitions/v10NodetypeAssessNodetype" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10NodetypeAssessNodetype": { + "properties": { + "from_nodepool": { + "description": "Pools assessed for removing nodetype.", + "items": { + "$ref": "#/definitions/v10NodetypeAssessNodetypeFromNodepoolItem" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "to_nodepool": { + "description": "Pools assessed for adding nodetype.", + "items": { + "$ref": "#/definitions/v10NodetypeAssessNodetypeFromNodepoolItem" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "from_nodepool", + "to_nodepool" + ], + "type": "object" + }, + "v10NodetypeAssessNodetypeFromNodepoolItem": { + "properties": { + "hard_restrictions": { + "description": "Hard restriction messages for joining the nodetype to the pool.", + "items": { + "description": "Restriction message resulting from changes to pool configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "The system ID given to the pool.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "soft_restrictions": { + "description": "Soft restriction messages for joining the nodetype to the pool.", + "items": { + "description": "Restriction message resulting from changes to pool configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "hard_restrictions", + "soft_restrictions", + "id", + "name" + ], + "type": "object" + }, + "v10PerformanceDataset": { + "additionalProperties": false, + "description": "A performance dataset configured to track different sets of performance workloads.", + "properties": { + "filters": { + "description": "Filtered metrics for configuring this dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "export_id" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 0, + "type": "array" + }, + "metrics": { + "description": "Performance metrics defining the dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "export_id" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 1, + "type": "array" + }, + "name": { + "description": "The name of the performance dataset. If a name is not specified then a default name is assigned. The default name will be an underscore separated list of the performance metrics and filters used to configure the dataset.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metrics" + ], + "type": "object" + }, + "v10PerformanceDatasetExtended": { + "additionalProperties": false, + "description": "A performance dataset configured to track different sets of performance workloads.", + "properties": { + "creation_time": { + "description": "Timestamp of when the dataset was created.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "filter_count": { + "description": "Number of filters applied to this dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "filters": { + "description": "Filtered metrics for configuring this dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset, and performance metrics used by the default system performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "job_type", + "system_name", + "export_id" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier for the configured dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metrics": { + "description": "Performance metrics defining the dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset, and performance metrics used by the default system performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "job_type", + "system_name", + "export_id" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 1, + "type": "array" + }, + "name": { + "description": "The name of the performance dataset. If a name is not specified then a default name is assigned. The default name will be an underscore separated list of the performance metrics and filters used to configure the dataset.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "note": { + "description": "Additional information about this dataset", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "statkey": { + "description": "Key for use in viewing associated raw statistics under the endpoints /statistics/history and /statistics/current.", + "maxLength": 29, + "minLength": 29, + "type": "string" + }, + "workload_count": { + "description": "Number of workloads pinned to this dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "name", + "filter_count", + "creation_time", + "metrics", + "statkey", + "workload_count", + "filters", + "id" + ], + "type": "object" + }, + "v10PerformanceDatasetExtendedExtended": { + "additionalProperties": false, + "description": "A performance dataset configured to track different sets of performance workloads.", + "properties": { + "name": { + "description": "The name of the performance dataset. If a name is not specified then a default name is assigned. The default name will be an underscore separated list of the performance metrics and filters used to configure the dataset.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v10PerformanceDatasets": { + "additionalProperties": false, + "properties": { + "datasets": { + "items": { + "$ref": "#/definitions/v10PerformanceDatasetExtended" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10PerformanceDatasetsExtended": { + "additionalProperties": false, + "properties": { + "datasets": { + "items": { + "$ref": "#/definitions/v10PerformanceDatasetExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v10PerformanceMetric": { + "additionalProperties": false, + "description": "A performance metric.", + "properties": { + "datatype": { + "description": "The data type of the performance metric.", + "enum": [ + "integer", + "string" + ], + "type": "string" + }, + "description": { + "description": "Text description of the performance metric.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Performance metrics that can be used to configure a performance dataset, and performance metrics used by the default system performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "job_type", + "system_name", + "export_id" + ], + "type": "string" + }, + "system_only": { + "description": "A 'system_only' metric is reserved for use by the system. This metric cannot be used to configure a new dataset.", + "type": "boolean" + }, + "value_set": { + "description": "The set of applicable values for the metric.", + "type": "string" + } + }, + "type": "object" + }, + "v10PerformanceMetrics": { + "additionalProperties": false, + "properties": { + "metrics": { + "items": { + "$ref": "#/definitions/v10PerformanceMetric" + }, + "maxItems": 11, + "minItems": 11, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10PerformanceMetricsExtended": { + "additionalProperties": false, + "properties": { + "metrics": { + "items": { + "$ref": "#/definitions/v10PerformanceMetric" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v10PerformanceSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v10PerformanceSettingsSettings" + } + }, + "type": "object" + }, + "v10PerformanceSettingsExtended": { + "additionalProperties": false, + "description": "View and modify the configuration for performance statistic collection.", + "properties": { + "max_filter_count": { + "description": "The maximum number of filters that can be applied to a configured performance dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_stat_size": { + "description": "The maximum size in bytes of a single performance dataset sample.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_top_n_collection_count": { + "description": "The maximum valid value for the 'top_n_collection_count' setting.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_workload_count": { + "description": "The maximum number of workloads that can be pinned to a configured performance dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "top_n_collection_count": { + "description": "The number of highest resource-consuming workloads tracked and collected by the system per configured performance dataset. The number of workloads pinned to a configured performance dataset does not count towards this value.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v10PerformanceSettingsSettings": { + "additionalProperties": false, + "description": "View and modify the configuration for performance statistic collection.", + "properties": { + "max_dataset_count": { + "description": "The maximum number of datasets that can be configured on the system.", + "maximum": 4, + "minimum": 4, + "type": "integer" + }, + "max_filter_count": { + "description": "The maximum number of filters that can be applied to a configured performance dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_stat_size": { + "description": "The maximum size in bytes of a single performance dataset sample.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_top_n_collection_count": { + "description": "The maximum valid value for the 'top_n_collection_count' setting.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_workload_count": { + "description": "The maximum number of workloads that can be pinned to a configured performance dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "top_n_collection_count": { + "description": "The number of highest resource-consuming workloads tracked and collected by the system per configured performance dataset. The number of workloads pinned to a configured performance dataset does not count towards this value.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "max_dataset_count", + "max_workload_count", + "max_top_n_collection_count", + "max_filter_count", + "max_stat_size", + "top_n_collection_count" + ], + "type": "object" + }, + "v10S3Bucket": { + "properties": { + "acl": { + "description": "Specifies an ordered list of S3 permissions.", + "items": { + "$ref": "#/definitions/v10S3BucketAclItem" + }, + "maxItems": 100, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "create_path": { + "description": "Create path if it does not exist.", + "type": "boolean" + }, + "description": { + "description": "Description for this S3 bucket.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Bucket name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "object_acl_policy": { + "description": "Set behavior of modifying object acls", + "enum": [ + "replace", + "deny" + ], + "type": "string" + }, + "owner": { + "description": "Specifies the name of the owner.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "Path of bucket within /ifs.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_S3_BUCKETS" + }, + "v10S3BucketAclItem": { + "description": "Specifies properties for an S3 Access Control Entry.", + "properties": { + "grantee": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "permission": { + "description": "Specifies the S3 rights being allowed.", + "enum": [ + "READ", + "WRITE", + "READ_ACP", + "WRITE_ACP", + "FULL_CONTROL" + ], + "type": "string" + } + }, + "required": [ + "grantee", + "permission" + ], + "type": "object" + }, + "v10S3BucketExtended": { + "properties": { + "acl": { + "description": "Specifies an ordered list of S3 permissions.", + "items": { + "$ref": "#/definitions/v10S3BucketAclItem" + }, + "maxItems": 100, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "description": { + "description": "Description for this S3 bucket.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Bucket ID.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Bucket name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "object_acl_policy": { + "description": "Set behavior of modifying object acls", + "enum": [ + "replace", + "deny" + ], + "type": "string" + }, + "owner": { + "description": "Specifies the name of the owner.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "Path of bucket within /ifs.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "zone": { + "description": "Specifies which access zone to use.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "description", + "object_acl_policy", + "owner", + "path", + "id", + "name" + ], + "type": "object" + }, + "v10S3BucketExtendedExtended": { + "properties": { + "acl": { + "description": "Specifies an ordered list of S3 permissions.", + "items": { + "$ref": "#/definitions/v10S3BucketAclItem" + }, + "maxItems": 100, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "description": { + "description": "Description for this S3 bucket.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "object_acl_policy": { + "description": "Set behavior of modifying object acls", + "enum": [ + "replace", + "deny" + ], + "type": "string" + } + }, + "type": "object" + }, + "v10S3Buckets": { + "additionalProperties": false, + "properties": { + "buckets": { + "items": { + "$ref": "#/definitions/v10S3BucketExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_S3_BUCKETS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "buckets" + ], + "type": "object" + }, + "v10S3BucketsExtended": { + "additionalProperties": false, + "properties": { + "buckets": { + "items": { + "$ref": "#/definitions/v10S3BucketExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "buckets" + ], + "type": "object" + }, + "v10S3Key": { + "properties": { + "existing_key_expiry_time": { + "description": "Time from now in minutes that previous secret key will expire.", + "maximum": 1440, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_S3_MYKEYS" + }, + "v10S3Keys": { + "additionalProperties": false, + "properties": { + "keys": { + "$ref": "#/definitions/v10S3KeysKeys" + } + }, + "required": [ + "keys" + ], + "type": "object" + }, + "v10S3KeysKeys": { + "properties": { + "access_id": { + "description": "S3 Access ID", + "maxLength": 272, + "minLength": 9, + "type": "string" + }, + "old_key_expiry": { + "description": "Time that previous secret key will expire, in format YYYY-MM-DD HH:MM:SS", + "type": "integer" + }, + "old_key_timestamp": { + "description": "Time that previous secret key was created, in format YYYY-MM-DD HH:MM:SS", + "type": "integer" + }, + "secret_key_timestamp": { + "description": "Time that secret key was created, in format YYYY-MM-DD HH:MM:SS", + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_S3_MYKEYS" + }, + "v10S3LogLevel": { + "properties": { + "level": { + "description": "Valid S3 logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v10S3SettingsGlobal": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v10S3SettingsGlobalSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v10S3SettingsGlobalSettings": { + "properties": { + "http_port": { + "description": "The port on which to listen for HTTP S3 requests.", + "maximum": 65535, + "minimum": 1024, + "type": "integer" + }, + "https_only": { + "description": "Indicates whether S3 service will accept only HTTPS request, or both HTTPS and HTTP.", + "type": "boolean" + }, + "https_port": { + "description": "The port on which to listen for HTTPS S3 requests.", + "maximum": 65535, + "minimum": 1024, + "type": "integer" + }, + "service": { + "description": "True if the S3 service is enabled. When set to false, the S3 service is disabled.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_S3_SETTINGS_GLOBAL" + }, + "v10S3SettingsZone": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v10S3SettingsZoneSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v10S3SettingsZoneSettings": { + "properties": { + "base_domain": { + "description": "Specifies the S3 base domain name.", + "maxLength": 255, + "minLength": 0, + "pattern": "^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$", + "type": "string" + }, + "bucket_directory_create_mode": { + "description": "Create bucket directory with this permission mode", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "object_acl_policy": { + "description": "Default object ACL policy for S3 Buckets.", + "enum": [ + "replace", + "deny" + ], + "type": "string" + }, + "root_path": { + "description": "Specifies the S3 bucket root path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_S3_SETTINGS_ZONE" + }, + "v10SummaryWorkload": { + "additionalProperties": false, + "properties": { + "workload": { + "items": { + "$ref": "#/definitions/v10SummaryWorkloadWorkloadItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v10SummaryWorkloadWorkloadItem": { + "properties": { + "bytes_in": { + "description": "Count of bytes-in per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "bytes_out": { + "description": "Count of bytes-out per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "cpu": { + "description": "The number (across all cores) of micro-seconds per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "domain_id": { + "description": "The IFS domain of the path which the operation was requested on.", + "type": "string" + }, + "error": { + "description": "Report any errors during id resolution.", + "type": "string" + }, + "export_id": { + "description": "The ID of the NFS export through which the operation was requested.", + "type": "number" + }, + "group_id": { + "description": "Group ID of the group that initiated the operation.", + "type": "number" + }, + "group_sid": { + "description": "Group SID of the group that initiated the operation.", + "type": "string" + }, + "groupname": { + "description": "The resolved text name of the group that initiated the operation.", + "type": "string" + }, + "job_type": { + "description": "The canonical name for the job followed by phase in brackets, ie. 'AVscan[1]', etc...", + "type": "string" + }, + "l2": { + "description": "L2 cache hits per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "l3": { + "description": "L3 cache hits per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "local_address": { + "description": "The IP address of the host receiving the operation request.", + "type": "string" + }, + "local_name": { + "description": "The resolved text name of the LocalAddr, if resolution can be performed.", + "type": "string" + }, + "node": { + "description": "The node on which the operation was performed or 0 for cluster scoped statistics.", + "maximum": 2147483647, + "minimum": 0, + "type": "number" + }, + "ops": { + "description": "Operations per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "path": { + "description": "The path which the operation was requestion on.", + "type": "string" + }, + "protocol": { + "description": "The protocol of the operation.", + "type": "string" + }, + "reads": { + "description": "Disk read operations per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "remote_address": { + "description": "The IP address of the host sending the operation request.", + "type": "string" + }, + "remote_name": { + "description": "The resolved text name of the RemoteAddr, if resolution can be performed.", + "type": "string" + }, + "share_name": { + "description": "The name of the SMB share through which the operation was requested.", + "type": "string" + }, + "system_name": { + "description": "The process name, job ID, etc...", + "type": "string" + }, + "time": { + "description": "Unix Epoch time in seconds that statistic was collected.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_id": { + "description": "User ID of the user who initiated the operation.", + "type": "number" + }, + "user_sid": { + "description": "User SID of the user who initiated the operation.", + "type": "string" + }, + "username": { + "description": "The resolved text name of the user who initiated the operation.", + "type": "string" + }, + "workload_id": { + "description": "ID of the workload (Pinned workloads only).", + "type": "integer" + }, + "workload_type": { + "description": "The type of workload output.", + "type": "string" + }, + "writes": { + "description": "Disk write operations per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "zone_id": { + "description": "Zone ID", + "type": "number" + }, + "zone_name": { + "description": "The resolved text zone name", + "type": "string" + } + }, + "required": [ + "reads", + "bytes_in", + "writes", + "time", + "node", + "ops", + "bytes_out", + "l2", + "l3", + "cpu" + ], + "type": "object" + }, + "v11AntivirusScanItem": { + "additionalProperties": false, + "description": "Parameters for a manual antivirus scan.", + "properties": { + "file": { + "description": "The full path of the file to scan.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "ignore_previous_scan_status": { + "description": "Forces the scan to run regardless of whether the files were recently scanned. The default value is true.", + "type": "boolean" + }, + "policy": { + "description": "The ID of the policy to use for the scan. By default, the scan will use the MANUAL policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "report_id": { + "description": "The ID for the report for this scan. A report ID will be generated if one is not provided.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + }, + "v11AuditLogs": { + "description": "Outputs the manual triggered deletion result.", + "properties": { + "before": { + "description": "The date which the current purging process will delete logs before.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "blocker": { + "description": "The status ot the consumers that blocked the deletion.", + "items": { + "$ref": "#/definitions/v11AuditLogsBlockerItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "deletion": { + "description": "Deleted result on each node.", + "items": { + "$ref": "#/definitions/v11AuditLogsDeletionItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of current manual purging.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11AuditLogsBlockerItem": { + "properties": { + "consumer": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "date": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnn": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "topic": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11AuditLogsDeletionItem": { + "properties": { + "deleted_files": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "space_freed": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11AvscanFilter": { + "additionalProperties": false, + "description": "Antivirus filter settings for zones.", + "properties": { + "filter_enabled": { + "description": "Access zone enabled for AV scanning.", + "type": "boolean" + }, + "id": { + "description": "A unique identifier for the zone.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "open_on_fail": { + "description": "Allow access to files when scanning fails.", + "type": "boolean" + }, + "scan_cloudpool_files": { + "description": "Perform real-time scans of cloudpool files?", + "type": "boolean" + }, + "scan_on_close": { + "description": "Perform real-time scans of files when the file handle is closed.", + "type": "boolean" + }, + "scan_on_read": { + "description": "Perform real-time scans of files on first file read.", + "type": "boolean" + }, + "scan_on_rename": { + "description": "Perform real-time scan of file when the file is renamed.", + "type": "boolean" + }, + "scan_profile": { + "description": "Type of scan profile applicable to the zone.", + "enum": [ + "standard", + "strict" + ], + "type": "string" + }, + "zone_name": { + "description": "Access zone name containing filter settings.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v11AvscanFilterExtended": { + "allOf": [ + { + "$ref": "#/definitions/v11AvscanFilter" + }, + { + "additionalProperties": false, + "description": "Antivirus filter settings for zones.", + "properties": { + "file_extension_action": { + "description": "When a file matches an entry in the list of file extensions, do we include or exclude it?.", + "enum": [ + "include", + "exclude" + ], + "type": "string" + }, + "file_extensions": { + "description": "Array of file extensions to use in scanning decision.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "paths_to_exclude": { + "description": "Array of relative paths under zone root not to scan.", + "items": { + "maxLength": 4096, + "minLength": 1, + "pattern": "^[^/].*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "scan_if_no_extension": { + "description": "Scan files without extensions?", + "type": "boolean" + } + }, + "type": "object" + } + ] + }, + "v11AvscanFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v11AvscanFilter" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11AvscanFiltersExtended": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v11AvscanFilterExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11AvscanJob": { + "additionalProperties": false, + "description": "Per-Job Antivirus Job Engine Settings.", + "properties": { + "description": { + "description": "Free-form customer description of job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the job is enabled.", + "type": "boolean" + }, + "file_extension_action": { + "description": "When a file matches an entry in the list of file extensions, do we include or exclude it?.", + "enum": [ + "include", + "exclude" + ], + "type": "string" + }, + "file_extensions": { + "description": "Array of file extensions to use in scanning decision.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "id": { + "description": "A unique identifier for the job.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ignore_previous_scan_status": { + "description": "If True, force a scan of a previously scanned file.", + "type": "boolean" + }, + "impact": { + "description": "Specifies an impact policy for the antivirus scan jobs.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "job_name": { + "description": "Unique short name for job.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "paths_to_exclude": { + "description": "Array of relative paths under paths_to_include not to scan.", + "items": { + "maxLength": 4096, + "minLength": 1, + "pattern": "^[^/].*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "paths_to_include": { + "description": "Array of absolute paths under /ifs to scan.", + "items": { + "maxLength": 4096, + "minLength": 1, + "pattern": "^/ifs/?$|^/ifs/.*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "scan_cloudpool_files": { + "description": "Perform real-time scans of cloudpool files?", + "type": "boolean" + }, + "scan_if_no_extension": { + "description": "Scan files without extensions?", + "type": "boolean" + }, + "schedule": { + "description": "The ever-unfortunate 'schedule' string type, e.g. 'every Thursday at 01:00'.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "job_name" + ], + "type": "object" + }, + "v11AvscanJobExtended": { + "additionalProperties": false, + "description": "Per-Job Antivirus Job Engine Settings.", + "properties": { + "description": { + "description": "Free-form customer description of job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the job is enabled.", + "type": "boolean" + }, + "file_extension_action": { + "description": "When a file matches an entry in the list of file extensions, do we include or exclude it?.", + "enum": [ + "include", + "exclude" + ], + "type": "string" + }, + "file_extensions": { + "description": "Array of file extensions to use in scanning decision.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "id": { + "description": "A unique identifier for the job.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ignore_previous_scan_status": { + "description": "If True, force a scan of a previously scanned file.", + "type": "boolean" + }, + "impact": { + "description": "Specifies an impact policy for the antivirus scan jobs.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "job_name": { + "description": "Unique short name for job.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "last_scheduled_run": { + "description": "Status field indicating when the job was last run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "paths_to_exclude": { + "description": "Array of relative paths under paths_to_include not to scan.", + "items": { + "maxLength": 4096, + "minLength": 1, + "pattern": "^[^/].*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "paths_to_include": { + "description": "Array of absolute paths under /ifs to scan.", + "items": { + "maxLength": 4096, + "minLength": 1, + "pattern": "^/ifs/?$|^/ifs/.*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "scan_cloudpool_files": { + "description": "Perform real-time scans of cloudpool files?", + "type": "boolean" + }, + "scan_if_no_extension": { + "description": "Scan files without extensions?", + "type": "boolean" + }, + "schedule": { + "description": "The ever-unfortunate 'schedule' string type, e.g. 'every Thursday at 01:00'.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v11AvscanJobExtendedExtended": { + "additionalProperties": false, + "description": "Per-Job Antivirus Job Engine Settings.", + "properties": { + "description": { + "description": "Free-form customer description of job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the job is enabled.", + "type": "boolean" + }, + "file_extension_action": { + "description": "When a file matches an entry in the list of file extensions, do we include or exclude it?.", + "enum": [ + "include", + "exclude" + ], + "type": "string" + }, + "file_extensions": { + "description": "Array of file extensions to use in scanning decision.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "id": { + "description": "A unique identifier for the job.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "ignore_previous_scan_status": { + "description": "If True, force a scan of a previously scanned file.", + "type": "boolean" + }, + "impact": { + "description": "Specifies an impact policy for the antivirus scan jobs.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "new_name": { + "description": "New unique short name for job.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "paths_to_exclude": { + "description": "Array of relative paths under paths_to_include not to scan.", + "items": { + "maxLength": 4096, + "minLength": 1, + "pattern": "^[^/].*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "paths_to_include": { + "description": "Array of absolute paths under /ifs to scan.", + "items": { + "maxLength": 4096, + "minLength": 1, + "pattern": "^/ifs/?$|^/ifs/.*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "scan_cloudpool_files": { + "description": "Perform real-time scans of cloudpool files?", + "type": "boolean" + }, + "scan_if_no_extension": { + "description": "Scan files without extensions?", + "type": "boolean" + }, + "schedule": { + "description": "The ever-unfortunate 'schedule' string type, e.g. 'every Thursday at 01:00'.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v11AvscanJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v11AvscanJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11AvscanJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v11AvscanJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11AvscanServer": { + "additionalProperties": false, + "description": "An anti-virus server.", + "properties": { + "enabled": { + "description": "Whether the server is enabled.", + "type": "boolean" + }, + "id": { + "description": "A unique identifier for the server.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "server_name": { + "description": "Unique short name of the server.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "server_uri": { + "description": "URI of the server. Typical format is: domain:port/path", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "server_uri", + "server_name" + ], + "type": "object" + }, + "v11AvscanServerExtended": { + "additionalProperties": false, + "description": "An anti-virus server.", + "properties": { + "enabled": { + "description": "Whether the server is enabled.", + "type": "boolean" + }, + "id": { + "description": "A unique identifier for the server.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "server_name": { + "description": "Unique short name of the server.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "server_type": { + "description": "The type of server.", + "enum": [ + "ICAP", + "CEE/CAVA" + ], + "type": "string" + }, + "server_uri": { + "description": "URI of the server. Typical format is: domain:port/path", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v11AvscanServerExtendedExtended": { + "additionalProperties": false, + "description": "An anti-virus server.", + "properties": { + "enabled": { + "description": "Whether the server is enabled.", + "type": "boolean" + }, + "id": { + "description": "A unique identifier for the server.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "new_name": { + "description": "New unique short name for the server.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "server_uri": { + "description": "URI of the server. Typical format is: domain:port/path", + "maxLength": 256, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v11AvscanServers": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "servers": { + "items": { + "$ref": "#/definitions/v11AvscanServerExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11AvscanServersExtended": { + "additionalProperties": false, + "properties": { + "servers": { + "items": { + "$ref": "#/definitions/v11AvscanServerExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11AvscanSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v11AvscanSettingsSettings" + } + }, + "type": "object" + }, + "v11AvscanSettingsSettings": { + "additionalProperties": false, + "description": "Antivirus CAVA settings.", + "properties": { + "ip_pool": { + "description": "The IP Pool to be used by the CAVA server.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "report_expiry": { + "description": "How many seconds a scan report will be kept.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "scan_cloudpool_timeout": { + "description": "How many seconds SMB will wait for an AV scan of a cloudpool to complete.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "scan_size_maximum": { + "description": "Maximum size file that will be scanned (in kBs). 0 means no limit.", + "maximum": 17179869184, + "minimum": 0, + "type": "integer" + }, + "scan_timeout": { + "description": "How many seconds SMB will wait for an AV scan to complete.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "scan_zones": { + "description": "Array of access zones that are enabled for antivirus scanning.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "service_enabled": { + "description": "CAVA antivirus service is on/off.", + "type": "boolean" + } + }, + "type": "object" + }, + "v11ClusterPatchPatch": { + "description": "A software patch that can be applied to OneFS.", + "properties": { + "location": { + "description": "The path location of the patch file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "patch": { + "description": "The id or filename of the patch to install.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "process_type": { + "description": "Process type can be 'simultaneous', 'rolling', or 'parallel'", + "maxLength": 255, + "minLength": 6, + "type": "string" + } + }, + "required": [ + "patch" + ], + "type": "object" + }, + "v11ClusterPatchPatches": { + "additionalProperties": false, + "properties": { + "patches": { + "items": { + "$ref": "#/definitions/v11ClusterPatchPatchesPatch" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11ClusterPatchPatchesExtended": { + "additionalProperties": false, + "properties": { + "patches": { + "items": { + "$ref": "#/definitions/v11ClusterPatchPatchesPatch" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11ClusterPatchPatchesPatch": { + "description": "A software patch that can be applied to OneFS.", + "properties": { + "comment": { + "description": "A long comment about the patch.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "conflicts": { + "description": "Other patches that this patch conflicts with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "dependencies": { + "description": "Other patches that this patch depends on.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "description": { + "description": "A short description of the patch.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "files": { + "description": "The files contained in this patch.", + "items": { + "$ref": "#/definitions/v11ClusterPatchPatchesPatchFile" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "A unique identifier for the patch.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The name of the patch.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nodes": { + "description": "The nodes that this patch is installed on.", + "items": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "reboot": { + "description": "Describes the reboot requirements", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "services": { + "description": "The services affected during the patch deployment", + "items": { + "$ref": "#/definitions/v11ClusterPatchPatchesPatchService" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "The installation status of this patch on the cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11ClusterPatchPatchesPatchFile": { + "properties": { + "md5": { + "description": "The md5 checksum of the file.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The path of the file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11ClusterPatchPatchesPatchService": { + "properties": { + "description": { + "description": "Description of the affected service", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Name of the affected service", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11EventThreshold": { + "description": "Configurable thresholds of an event.", + "properties": { + "defaults": { + "$ref": "#/definitions/v11EventThresholdThresholds" + }, + "id": { + "description": "Unique event identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id_name": { + "description": "Name for event.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "threshold_description": { + "description": "Verbose, human-readable description of event.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "thresholds": { + "$ref": "#/definitions/v11EventThresholdThresholds" + } + }, + "type": "object" + }, + "v11EventThresholdExtended": { + "description": "Configurable thresholds of an event.", + "properties": { + "defaults": { + "$ref": "#/definitions/v11EventThresholdThresholds" + }, + "id_name": { + "description": "Name for event.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "threshold_description": { + "description": "Verbose, human-readable description of event.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "thresholds": { + "$ref": "#/definitions/v11EventThresholdThresholds" + } + }, + "type": "object" + }, + "v11EventThresholdThresholds": { + "maxItems": 65535, + "minItems": 0, + "properties": { + "crit": { + "$ref": "#/definitions/v11EventThresholdThresholdsCrit" + }, + "emerg": { + "$ref": "#/definitions/v11EventThresholdThresholdsCrit" + }, + "info": { + "$ref": "#/definitions/v11EventThresholdThresholdsCrit" + }, + "warn": { + "$ref": "#/definitions/v11EventThresholdThresholdsCrit" + } + }, + "type": "object" + }, + "v11EventThresholdThresholdsCrit": { + "properties": { + "level": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "urgent": { + "description": "If True all events are treated as new.", + "type": "boolean" + }, + "value": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11EventThresholds": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "thresholds": { + "items": { + "$ref": "#/definitions/v11EventThreshold" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11HdfsSettingsGlobal": { + "properties": { + "global_settings": { + "$ref": "#/definitions/v11HdfsSettingsGlobalGlobalSettings" + } + }, + "type": "object" + }, + "v11HdfsSettingsGlobalGlobalSettings": { + "description": "This is the schema that contains global HDFS settings.", + "properties": { + "service_enabled": { + "description": "Globally enable or disable HDFS service.", + "type": "boolean" + } + }, + "type": "object" + }, + "v11LicenseActivation": { + "properties": { + "elms_errors": { + "description": "An array of licenses not included in activation file.", + "items": { + "$ref": "#/definitions/v11LicenseActivationElmsError" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "last_action_time": { + "description": "Number of days before a license expires.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "The state of activation. File creating, created, submitted, awaiting license, error, or approved.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "transaction_id": { + "description": "The license activation transaction ID", + "maxLength": 64, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "v11LicenseActivationElmsError": { + "properties": { + "code": { + "description": "An error code corresponding to an error returned from the SRS ELMS rest call.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "error": { + "description": "An error string retured from the SRS ELMS rest call", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v11LicenseActivationItem": { + "properties": { + "lacs": { + "description": "An array of licenses not included in activation file.", + "items": { + "description": "An error string retured from the SRS ELMS rest call", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "licenses_to_exclude": { + "description": "Licenses to omit from activation file.", + "maxLength": 2500, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "licenses_to_include": { + "description": "Licenses to include in activation file.", + "maxLength": 2500, + "minLength": 1, + "pattern": ".*", + "type": "string" + }, + "only_these_licenses": { + "description": "Activate only the defined licenses. This setting overrides all other license activation settings.", + "maxLength": 2500, + "minLength": 1, + "pattern": ".*", + "type": "string" + } + }, + "type": "object" + }, + "v11NfsExport": { + "description": "Specifies configuration values for NFS exports.", + "properties": { + "all_dirs": { + "description": "True if all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "Specifies the block size returned by the NFS statfs procedure.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "can_set_time": { + "description": "True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_insensitive": { + "description": "True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_preserving": { + "description": "True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "chown_restricted": { + "description": "True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "clients": { + "description": "Specifies the clients with root access to the export.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "commit_asynchronous": { + "description": "True if NFS commit requests execute asynchronously.", + "type": "boolean" + }, + "description": { + "description": "Specifies the user-defined string that is used to identify the export.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "directory_transfer_size": { + "description": "Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 131072, + "minimum": 0, + "type": "integer" + }, + "encoding": { + "description": "Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "link_max": { + "description": "Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "map_all": { + "$ref": "#/definitions/v11NfsExportMapAll" + }, + "map_failure": { + "$ref": "#/definitions/v11NfsExportMapAll" + }, + "map_full": { + "description": "True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_non_root": { + "$ref": "#/definitions/v11NfsExportMapAll" + }, + "map_retry": { + "description": "Determines whether searches for users specified in 'map_all', 'map_root' or 'map_nonroot' are retried if the search fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v11NfsExportMapAll" + }, + "max_file_size": { + "description": "Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name_max_size": { + "description": "Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "no_truncate": { + "description": "True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "paths": { + "description": "Specifies the paths under /ifs that are exported.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "read_only": { + "description": "True if the export is set to read-only.", + "type": "boolean" + }, + "read_only_clients": { + "description": "Specifies the clients with read-only access to the export.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "read_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 1048576, + "minimum": 0, + "type": "integer" + }, + "read_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_size": { + "description": "Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 131072, + "minimum": 0, + "type": "integer" + }, + "read_write_clients": { + "description": "Specifies the clients with both read and write access to the export, even when the export is set to read-only.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "readdirplus": { + "description": "True if 'readdirplus' requests are enabled. Enabling this property might improve network performance and is only available for NFSv3.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that are prefetched when a 'readdirplus' request is processed. (Deprecated.)", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "root_clients": { + "description": "Clients that have root access to the export.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "security_flavors": { + "description": "Specifies the authentication types that are supported for this export.", + "items": { + "description": "Specifies the authentication types that are supported for this export.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "setattr_asynchronous": { + "description": "True if set attribute operations execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Specifies the snapshot for all mounts.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "symlinks": { + "description": "True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "type": "boolean" + }, + "time_delta": { + "description": "Specifies the resolution of all time values that are returned to the clients", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "write_datasync_action": { + "description": "Specifies the action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "Specifies the action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 1048576, + "minimum": 0, + "type": "integer" + }, + "write_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_size": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 524288, + "minimum": 0, + "type": "integer" + }, + "write_unstable_action": { + "description": "Specifies the action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + }, + "v11NfsExportExtended": { + "allOf": [ + { + "$ref": "#/definitions/v11NfsExport" + }, + { + "description": "Specifies configuration values for NFS exports.", + "properties": { + "conflicting_paths": { + "description": "Reports the paths that conflict with another export.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Specifies the system-assigned ID for the export. This ID is returned when an export is created through the POST method.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unresolved_clients": { + "description": "Reports clients that cannot be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "zone": { + "description": "Specifies the zone in which the export is valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + } + ] + }, + "v11NfsExportMapAll": { + "description": "Specifies the users and groups to which non-root and root clients are mapped.", + "properties": { + "enabled": { + "description": "True if the user mapping is applied.", + "type": "boolean" + }, + "primary_group": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "secondary_groups": { + "description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID.", + "items": { + "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", + "properties": { + "id": { + "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", + "maxLength": 261, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the persona name, which must be combined with a type.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-nullable": true + }, + "type": { + "description": "Specifies the type of persona, which must be combined with a name.", + "enum": [ + "user", + "group", + "wellknown" + ], + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + "type": "object" + }, + "v11NfsExports": { + "additionalProperties": false, + "properties": { + "exports": { + "items": { + "$ref": "#/definitions/v11NfsExportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11NodeStatus": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v11NodeStatusNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11NodeStatusError": { + "additionalProperties": false, + "description": "An object describing a single error.", + "properties": { + "code": { + "description": "The error code.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "field": { + "description": "The field with the error if applicable.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "message": { + "description": "The error message.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "HTTP Status code returned by this node.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11NodeStatusNode": { + "additionalProperties": false, + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "$ref": "#/definitions/v11NodeStatusNodeStatus" + } + }, + "type": "object" + }, + "v11NodeStatusNodeStatus": { + "additionalProperties": false, + "description": "CAVA Antivirus status.", + "properties": { + "av_vendor": { + "description": "Name of antivirus engine for scanning files.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "blocking_events": { + "description": "List of blocking event strings if CAVA is FAULTED", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "cee_version": { + "description": "Remote CEE software version string.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "dtd_version": { + "description": "Document type definition version for message exchanges.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "server_status": { + "description": "Specifies the list of CAVA servers along with their status.", + "items": { + "$ref": "#/definitions/v11NodeStatusNodeStatusServerStatusItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "signature_timestamp": { + "description": "Timestamp of the last antivirus signature update.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "system_stats": { + "$ref": "#/definitions/v11NodeStatusNodeStatusSystemStats" + }, + "system_status": { + "description": "Status of the CAVA antivirus system.", + "enum": [ + "DISABLED", + "RUNNING", + "FAULTED" + ], + "type": "string" + } + }, + "type": "object" + }, + "v11NodeStatusNodeStatusServerStatusItem": { + "description": "Specifies properties for a CAVA server status object.", + "properties": { + "connections": { + "description": "Total number of connections from the cluster node to CAVA servers.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "good_heartbeats": { + "description": "Number of good heartbeats exchanges between cluster node and CAVA server.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "heartbeat_rtt": { + "description": "Average round trip time (ms) for heartbeat messages between cluster node and CAVA server.", + "maximum": 3600000, + "minimum": 0, + "type": "integer" + }, + "scan_requests": { + "description": "Total number of scan requests received by the CAVA server.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "scan_rtt": { + "description": "Average round trip time (ms) for scan request completion.", + "maximum": 3600000, + "minimum": 0, + "type": "integer" + }, + "server_name": { + "description": "Name of the CAVA server as per the configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "server_state": { + "description": "State of the CAVA server in string format.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v11NodeStatusNodeStatusSystemStats": { + "description": "Specifies properties for CAVA system statistics.", + "properties": { + "all_scan_requests": { + "description": "Total number of scan requests received by the CAVA antivirus system.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "avg_scan_block_time": { + "description": "Average time spent during which the scan requests are blocked.", + "maximum": 3600000, + "minimum": 0, + "type": "integer" + }, + "avg_scan_duration": { + "description": "Average time to scan a file (in milliseconds).", + "maximum": 3600000, + "minimum": 0, + "type": "integer" + }, + "batch_file_queue_max_size": { + "description": "Maximum number of files that can be queued in the batch file queue.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "batch_file_queue_size": { + "description": "Number of scan requests queued for scanning in the batch file queue.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "cee_failure_count": { + "description": "Number of scan failure responses received from CEE server.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "cee_infected_count": { + "description": "Number of scan infected responses received from CEE server.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "cee_success_count": { + "description": "Number of scan success responses received from CEE server.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fast_file_queue_max_size": { + "description": "Maximum number of files that can be queued in the fast file queue.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fast_file_queue_size": { + "description": "Number of scan requests queued for scanning in the fast file queue.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_processed": { + "description": "Total number of files processed by the CAVA antivirus system.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_skipped_per_filter": { + "description": "Total number of files skipped per filter settings.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_skipped_per_size": { + "description": "Total number of files skipped per maximum size setting.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_scan_requests": { + "description": "Total number of scan requests received from the job engine.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "manual_scan_requests": { + "description": "Total number of scan requests initiated through PAPI.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "on_demand_scan_requests": { + "description": "Total number of on-demand (protocol) scan requests received.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "scan_fails": { + "description": "Number of scan failures occurred while scanning.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "scan_timeouts": { + "description": "Number of scan timeouts occurred while scanning.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "slow_file_queue_max_size": { + "description": "Maximum number of files that can be queued in the slow (large/cloudpool) file queue.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "slow_file_queue_size": { + "description": "Number of scan requests queued for scanning in the slow (large/cloudpool) file queue.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11ProvidersLdap": { + "additionalProperties": false, + "properties": { + "ldap": { + "items": { + "$ref": "#/definitions/v11ProvidersLdapLdapItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11ProvidersLdapIdParams": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_lookup_method": { + "description": "Sets the method by which group member lookups are performed. Use caution when changing this option directly.", + "enum": [ + "default", + "rfc2307bis" + ], + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ssh_public_key_attribute": { + "description": "Sets the attribute name that indicates the SSH Public Key for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "template": { + "description": "Specifies template to be used to create the LDAP provider. The list of templates can be found at /auth/ldap-templates. Any fields directly defined in your request will override the template values.", + "enum": [ + "default", + "ldapsam", + "rfc2307", + "rfc2307bis", + "ad-idmu" + ], + "type": "string" + }, + "tls_protocol_min": { + "description": "Specifies the minimum TLS protocol version.", + "maxLength": 255, + "minLength": 0, + "pattern": "^[0-9]+\\.[0-9]+$", + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v11ProvidersLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_lookup_method": { + "description": "Sets the method by which group member lookups are performed. Use caution when changing this option directly.", + "enum": [ + "default", + "rfc2307bis" + ], + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ssh_public_key_attribute": { + "description": "Sets the attribute name that indicates the SSH Public Key for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "template": { + "description": "Specifies template to be used to create the LDAP provider. The list of templates can be found at /auth/ldap-templates. Any fields directly defined in your request will override the template values.", + "enum": [ + "default", + "ldapsam", + "rfc2307", + "rfc2307bis", + "ad-idmu" + ], + "type": "string" + }, + "tls_protocol_min": { + "description": "Specifies the minimum TLS protocol version.", + "maxLength": 255, + "minLength": 0, + "pattern": "^[0-9]+\\.[0-9]+$", + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "required": [ + "base_dn", + "server_uris", + "name" + ], + "type": "object" + }, + "v11ProvidersLdapLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_lookup_method": { + "description": "Sets the method by which group member lookups are performed. Use caution when changing this option directly.", + "enum": [ + "default", + "rfc2307bis" + ], + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ssh_public_key_attribute": { + "description": "Sets the attribute name that indicates the SSH Public Key for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "tls_protocol_min": { + "description": "Specifies the minimum TLS protocol version.", + "maxLength": 255, + "minLength": 0, + "pattern": "^[0-9]+\\.[0-9]+$", + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11ProvidersSummary": { + "additionalProperties": false, + "properties": { + "provider_instances": { + "items": { + "$ref": "#/definitions/v11ProvidersSummaryProviderInstance" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11ProvidersSummaryProviderInstance": { + "description": "Specifies the summary information for an authentication provider.", + "properties": { + "active_server": { + "description": "Specifies the server through which the provider serves authentication requests. Null if no server is set or is not applicable for that provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "client_site": { + "description": "The Nodes Site.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "connections": { + "items": { + "$ref": "#/definitions/v1ProvidersSummaryProviderInstanceConnection" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "dc_site": { + "description": "The DC Site.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "forest": { + "description": "Specifies the Active Directory forest. Null if not applicable.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "The groupnet the provider is in.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Indicates the status of the provider.", + "enum": [ + "offline", + "active", + "online", + "initializing", + "joining", + "disabled" + ], + "type": "string" + }, + "type": { + "description": "Specifies the type of provider.", + "enum": [ + "file", + "ldap", + "local", + "nis", + "ads", + "krb5", + "unknown" + ], + "type": "string" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11ReportsScans": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v11ReportsScansReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11ReportsScansExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v11ReportsScansReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v11ReportsScansReport": { + "additionalProperties": false, + "description": "A report for an antivirus scan.", + "properties": { + "av_service": { + "description": "The actual antivirus service that started the scanning job.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "bytes_sent": { + "description": "The number of bytes sent to the virus definition server to be scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The length of time the job ran for.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end": { + "description": "The time the job ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files": { + "description": "The number of files scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for the report.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infections": { + "description": "The number of infections found.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_id": { + "description": "The ID of the job that ran the policy. If the scan was manually run on a single file, this field will be null.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_cloud_files": { + "description": "The number of cloud pool files scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_cloud_files_rev": { + "description": "The number of cloud pool files reviewed for scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_files_rev": { + "description": "The number of files reviewed for scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "policy_id": { + "description": "The id of the policy that this scan job executed.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "scan_fails": { + "description": "The number of files scanned unsuccessfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "size": { + "description": "The cumulative size of the files scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The time the job started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "The state of the job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11SettingsAcls": { + "properties": { + "acl_policy_settings": { + "$ref": "#/definitions/v11SettingsAclsAclPolicySettings" + } + }, + "type": "object" + }, + "v11SettingsAclsAclPolicySettings": { + "description": "ACL policies settings.", + "properties": { + "access": { + "description": "Access checks (chmod, chown).", + "enum": [ + "unix", + "windows" + ], + "type": "string" + }, + "calcmode": { + "description": "Displayed mode bits.", + "enum": [ + "approx", + "777" + ], + "type": "string" + }, + "calcmode_group": { + "description": "Approximate group mode bits when ACL exists.", + "enum": [ + "group_aces", + "group_only" + ], + "type": "string" + }, + "calcmode_owner": { + "description": "Approximate owner mode bits when ACL exists.", + "enum": [ + "owner_aces", + "owner_only" + ], + "type": "string" + }, + "calcmode_traverse": { + "description": "Require traverse rights in order to traverse directories with existing ACLs.", + "enum": [ + "require", + "ignore" + ], + "type": "string" + }, + "chmod": { + "description": "chmod on files with existing ACLs.", + "enum": [ + "remove", + "replace", + "replace_users_and_groups", + "merge_with_ugo_priority", + "merge", + "deny", + "ignore" + ], + "type": "string" + }, + "chmod_007": { + "description": "chmod (007) on files with existing ACLs.", + "enum": [ + "default", + "remove" + ], + "type": "string" + }, + "chmod_inheritable": { + "description": "ACLs created on directories by UNIX chmod.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "chown": { + "description": "chown/chgrp on files with existing ACLs.", + "enum": [ + "owner_group_and_acl", + "owner_group_only", + "ignore" + ], + "type": "string" + }, + "create_over_smb": { + "description": "ACL creation over SMB.", + "enum": [ + "allow", + "disallow" + ], + "type": "string" + }, + "dos_attr": { + "description": " Read only DOS attribute.", + "enum": [ + "deny_smb", + "deny_smb_and_nfs" + ], + "type": "string" + }, + "group_owner_inheritance": { + "description": "Group owner inheritance.", + "enum": [ + "native", + "parent", + "creator" + ], + "type": "string" + }, + "rwx": { + "description": "Treatment of 'rwx' permissions.", + "enum": [ + "retain", + "full_control" + ], + "type": "string" + }, + "synthetic_denies": { + "description": "Synthetic 'deny' ACEs.", + "enum": [ + "none", + "remove" + ], + "type": "string" + }, + "utimes": { + "description": "Access check (utimes)", + "enum": [ + "only_owner", + "owner_and_write" + ], + "type": "string" + } + }, + "type": "object" + }, + "v11SettingsGlobal": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v11SettingsGlobalSettings" + } + }, + "type": "object" + }, + "v11SettingsGlobalSettings": { + "description": "Settings for Audit.", + "properties": { + "audited_zones": { + "description": "Specifies zones that are audited when the protocol_auditing_enabled property is enabled.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "auto_purging_enabled": { + "description": "whether auto purging of audit log files is enabled.", + "type": "boolean" + }, + "cee_log_time": { + "description": "Specifies that events past a certain date are forwarded by the audit CEE forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS'.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cee_server_uris": { + "description": "Specifies a list of Common Event Enabler (CEE) server URIs. Protocol audit logs are sent to these URIs for external processing.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "config_auditing_enabled": { + "description": "Specifies whether logging for API configuration changes are enabled.", + "type": "boolean" + }, + "config_syslog_enabled": { + "description": "Specifies whether configuration audit syslog messages are forwarded.", + "type": "boolean" + }, + "config_syslog_servers": { + "description": "Specifies a list of remote servers for audit logging of configuration changes. Audit logs are sent to syslog of these remote servers.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "hostname": { + "description": "Specifies the hostname that is reported in protocol events from this cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "protocol_auditing_enabled": { + "description": "Specifies if logging for the I/O stream is enabled.", + "type": "boolean" + }, + "protocol_syslog_servers": { + "description": "Specifies a list of remote servers for protocol audit logging. Protocol audit logs are sent to syslog of these remote servers.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "retention_period": { + "description": "Specifies the number of days for which audit log files will be retained before being purged.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "syslog_log_time": { + "description": "Specifies that events past a specified date are forwarded by the audit syslog forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS' format", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v11SmbSessions": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v11SmbSessionsNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMB_SESSIONS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v11SmbSessionsNode": { + "properties": { + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "sessions": { + "description": "A list of open SMB sessions on node.", + "items": { + "$ref": "#/definitions/v1SmbSession" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "The number of sessions returned.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12AdsProviderSearchItem": { + "description": "Retrieve search results.", + "properties": { + "description": { + "description": "The user or group description to search for.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain": { + "description": "The Active Directory provider name to search for.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "filter": { + "description": "The LDAP filter to apply to the search.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "limit": { + "description": "Return no more than this many results at once (see resume).", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "password": { + "description": "The password for the domain if untrusted.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "resume": { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "search_groups": { + "description": "If true, search for groups.", + "type": "boolean" + }, + "search_users": { + "description": "If true, search for users.", + "type": "boolean" + }, + "user": { + "description": "The user name for the domain if untrusted.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v12AuthLogLevel": { + "properties": { + "level": { + "$ref": "#/definitions/v12AuthLogLevelLevel" + } + }, + "type": "object" + }, + "v12AuthLogLevelExtended": { + "properties": { + "level": { + "description": "Valid auth logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12AuthLogLevelLevel": { + "properties": { + "lsass-level": { + "description": "Valid auth logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "unknown" + ], + "type": "string" + }, + "netlogon-level": { + "description": "Valid auth logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12ClusterDrain": { + "description": "Alter drain action.", + "properties": { + "action": { + "description": "The desired drain action, ex. delay or skip.", + "enum": [ + "delay", + "skip" + ], + "type": "string" + }, + "drain_nodes": { + "description": "The nodes to alter drain action in the existing upgrade.For skip action only, 'all' is valid.\n", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maximum": 65535, + "minimum": 1, + "type": "array" + }, + "task": { + "description": "The desired drain task, ex. add or remove nodes.", + "enum": [ + "add", + "remove" + ], + "type": "string" + } + }, + "required": [ + "action", + "task", + "drain_nodes" + ], + "type": "object" + }, + "v12ClusterDrainList": { + "description": "View Drain delay/skip lists.", + "properties": { + "lnns": { + "description": "List of nodes in the delay or skip list.", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12ClusterDrainTimeout": { + "description": "View or modify drain timeouts.", + "properties": { + "alert_timeout": { + "description": "The duration in seconds after drain begins that an alert will be raised. An alert timeout must be set to a smaller value than the drain timeout to be used. If not specified, an alert will not be raised (legacy behavior).", + "maximum": 2147483646, + "minimum": -1, + "type": "integer" + }, + "drain_timeout": { + "description": "The duration in seconds that upgrade waits for all SMB clients to disconnect from a node before rebooting it. A value of 0 means wait indefinitely. If not specified, upgrade proceeds with reboots regardless of SMB client connections (legacy behavior).", + "maximum": 2147483646, + "minimum": -1, + "type": "integer" + } + }, + "type": "object" + }, + "v12ClusterDrainTimeoutExtended": { + "description": "View or modify drain timeouts.", + "properties": { + "alert_timeout": { + "description": "The duration in seconds after drain begins that an alert will be raised. An alert timeout must be set to a smaller value than the drain timeout to be used. If not specified, an alert will not be raised (legacy behavior).", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "drain_timeout": { + "description": "The duration in seconds that upgrade waits for all SMB clients to disconnect from a node before rebooting it. A value of 0 means wait indefinitely. If not specified, upgrade proceeds with reboots regardless of SMB client connections (legacy behavior).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12ClusterFirmwareUpgradeItem": { + "description": "The settings necessary to start a firmware upgrade.", + "properties": { + "alert_timeout": { + "description": "The duration in seconds after drain begins that an alert will be raised. An alert timeout must be set to a smaller value than the drain timeout to be used. If not specified, an alert will not be raised (legacy behavior).", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "drain_timeout": { + "description": "The duration in seconds that upgrade waits for all SMB clients to disconnect from a node before rebooting it. A value of 0 means wait indefinitely. If not specified, upgrade proceeds with reboots regardless of SMB client connections (legacy behavior).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "exclude_device": { + "description": "Exclude the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "exclude_type": { + "description": "Exclude the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "fw_pkg": { + "description": "The location (path) of the firmware package which must be within /ifs.", + "maxLength": 4096, + "minLength": 3, + "type": "string" + }, + "fw_pkg_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "include_device": { + "description": "Include the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "include_type": { + "description": "Include the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "no_burn": { + "description": "Do not burn the firmware.", + "type": "boolean" + }, + "no_reboot": { + "description": "Do not reboot the node after an upgrade", + "type": "boolean" + }, + "nodes_to_upgrade": { + "description": "The nodes scheduled for upgrade. Order in array determines queue position number.\n'all' and null option will upgrade firmware on all nodes in order (Note: 'all' and null options do not apply to simultaneous firmware upgrade).", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "type": "array" + }, + "upgrade_type": { + "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous, parallel'", + "enum": [ + "rolling", + "parallel", + "simultaneous" + ], + "type": "string" + } + }, + "required": [ + "upgrade_type" + ], + "type": "object" + }, + "v12ClusterNode": { + "description": "Node information.", + "properties": { + "drive_d_config": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfig" + }, + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "hardware": { + "$ref": "#/definitions/v12ClusterNodeHardware" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "internal_ip_address": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "$ref": "#/definitions/v10ClusterNodePartitions" + }, + "sensors": { + "$ref": "#/definitions/v10ClusterNodeSensors" + }, + "sleds": { + "description": "List of the sleds in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSled" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "state": { + "$ref": "#/definitions/v12ClusterNodeState" + }, + "status": { + "$ref": "#/definitions/v12ClusterNodeStatus" + } + }, + "required": [ + "internal_ip_address" + ], + "type": "object" + }, + "v12ClusterNodeError": { + "description": "The current OneFS version before upgrade.", + "properties": { + "failed_upgrade_action": { + "description": "Last upgrade step which failed on node.", + "type": "string" + }, + "log": { + "description": "Upgrade error log.", + "type": "string" + } + }, + "type": "object" + }, + "v12ClusterNodeExtended": { + "description": "The node details useful during an upgrade or assessment.", + "properties": { + "domain": { + "description": "Unique identifier for the failure domain that thisnode resides in. Within a given domain, nodes are rebooted 1 at a time. The actual value is meaningless, it is merely used to group nodes by failure domain.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "down_peer": { + "description": "Peer node is down.", + "type": "boolean" + }, + "error": { + "$ref": "#/definitions/v12ClusterNodeError" + }, + "last_action": { + "description": "The last action performed to completion/failure on this node. Null if the node_state is 'committed' or 'assessing.' One of the following values: 'upgrade', 'rollback'.", + "type": "string" + }, + "last_action_result": { + "description": "Did the node pass upgrade or rollback without failing? Null if the node_state is 'committed.' One of the following values: 'pass', 'fail', null", + "type": "string" + }, + "lnn": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "node_state": { + "description": "\\e\nThe state of the node during the upgrade, rollback, or assessment. One of the following values: 'committed', 'upgraded', 'upgrading', 'rolling back', 'assessing', 'error'", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "onefs_version": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "progress": { + "description": "What step is the upgrade, assessment, or rollback in? To show via progress indicator. NOTE: the value is an integer between 0 and 100 (percent)", + "maximum": 100, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12ClusterNodeHardware": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_depth": { + "description": "Chassis depth for this node if applicable (e.g., Normal, Deep, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "compute_type": { + "description": "Type of compute node if applicable (e.g., Low, Medium, High, Turbo, Ultra, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "PowerScale node model identifier string (S200, X410, Infinity-H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model_code": { + "description": "PowerScale node model code string (S200, X410, H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_slot_id": { + "description": "Position of node within chassis. -1 for error or not supported.", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "peer_serial_number": { + "description": "Serial number of this node's peer/buddy node.(Infinity Only)", + "type": "string" + }, + "performance_code": { + "description": "Performance code of this node, if applicable (2, 4, 5, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sled_drive_count": { + "description": "Size of drive sleds in node, if applicable. Expected values: 3, 4, 6. 0 if unable to determine sled size. -1 for error or not supported. If PSI_Get fails: -1. PSI_Get can fail if PSI not initialized, or key does not exist.", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "tier": { + "description": "Platform tier level of this node if applicable(positive for a defined tier, 0 for unknown or not supported, -1 for error).", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "top_level_assembly_serial_number": { + "description": "Serial number of the top level assembly of this node.(Infinity Only)", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "top_level_assembly_serial_number", + "peer_serial_number" + ], + "type": "object" + }, + "v12ClusterNodeState": { + "description": "Node state information (reported and modifiable).", + "properties": { + "readonly": { + "$ref": "#/definitions/v10ClusterNodeStateReadonly" + }, + "servicelight": { + "$ref": "#/definitions/v12ClusterNodeStateServicelight" + }, + "smartfail": { + "$ref": "#/definitions/v10ClusterNodeStateSmartfail" + } + }, + "type": "object" + }, + "v12ClusterNodeStateServicelight": { + "description": "Node service light state.", + "properties": { + "enabled": { + "description": "The node service light state (True = on).", + "type": "boolean" + }, + "supported": { + "description": "This node supports a service light.", + "type": "boolean" + }, + "valid": { + "description": "The node service light state is valid (False = Error).", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "type": "object" + }, + "v12ClusterNodeStatus": { + "description": "Node status information (hardware reported).", + "properties": { + "batterystatus": { + "$ref": "#/definitions/v10ClusterNodeStatusBatterystatus" + }, + "capacity": { + "description": "Storage capacity of this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusCapacityItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "cpu": { + "$ref": "#/definitions/v10ClusterNodeStatusCpu" + }, + "nvram": { + "$ref": "#/definitions/v10ClusterNodeStatusNvram" + }, + "powersupplies": { + "$ref": "#/definitions/v12ClusterNodeStatusPowersupplies" + }, + "release": { + "description": "OneFS release.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uptime": { + "description": "Seconds this node has been online.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "version": { + "description": "OneFS version.", + "maxLength": 511, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v12ClusterNodeStatusPowersupplies": { + "description": "Information about this node's power supplies.", + "properties": { + "count": { + "description": "Count of how many power supplies are supported.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "failures": { + "description": "Count of how many power supplies have failed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "A descriptive status string for this node's power supplies.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "supplies": { + "description": "List of this node's power supplies.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusPowersuppliesSupply" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12ClusterNodes": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v12ClusterNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12ClusterNodesExtended": { + "description": "View information about nodes during an upgrade, rollback, or pre-upgrade assessment.", + "properties": { + "nodes": { + "description": "List of detailed info of nodes which are part of the current upgrade", + "items": { + "$ref": "#/definitions/v12ClusterNodeExtended" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of nodes the upgrade framework is aware of and was able to collect info for at this point.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12ClusterUpgrade": { + "description": "Add nodes to a running upgrade.", + "properties": { + "nodes_to_rolling_upgrade": { + "description": "The nodes (to be) scheduled for an existing upgrade ordered by queue position number: [, , ... ]", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12ClusterUpgradeItem": { + "description": "The settings necessary to start an upgrade.", + "properties": { + "alert_timeout": { + "description": "The duration in seconds after drain begins that an alert will be raised. An alert timeout must be set to a smaller value than the drain timeout to be used. If not specified, an alert will not be raised (legacy behavior).", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "drain_timeout": { + "description": "The duration in seconds that upgrade waits for all SMB clients to disconnect from a node before rebooting it. A value of 0 means wait indefinitely. If not specified, upgrade proceeds with reboots regardless of SMB client connections (legacy behavior).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "exclude_device": { + "description": "Exclude the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "exclude_type": { + "description": "Exclude the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "fw_pkg": { + "description": "The location (path) of the firmware package which must be within /ifs.", + "maxLength": 4096, + "minLength": 3, + "type": "string" + }, + "fw_pkg_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "include_device": { + "description": "Include the specified devices in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "include_type": { + "description": "Include the specified device type in the firmware upgrade.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "install_image_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "no_burn": { + "description": "Do not burn the firmware.", + "type": "boolean" + }, + "nodes_to_rolling_upgrade": { + "description": "The nodes (to be) scheduled for upgrade ordered by queue position number. Null if the cluster_state is 'partially upgraded' or upgrade_type is 'simultaneous'. One of the following values: [, , ... ], 'all', null", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + }, + "patch_paths": { + "description": "List of additional patches to install during the upgrade.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "skip_optional": { + "description": "Used to indicate that the pre-upgrade check should be skipped.", + "type": "boolean" + }, + "upgrade_type": { + "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous, parallel'", + "enum": [ + "rolling", + "parallel", + "simultaneous" + ], + "type": "string" + } + }, + "required": [ + "upgrade_type" + ], + "type": "object" + }, + "v12ConfigExport": { + "properties": { + "components": { + "description": "Specifies the components which will be exported.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12ConfigExportExtended": { + "properties": { + "done": { + "description": "All finished components.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "failed": { + "description": "All failed components.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The export ID given to the task.", + "maxLength": 255, + "minLength": 14, + "type": "string" + }, + "message": { + "description": "Message of job.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The path where export job's result is stored.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "pending": { + "description": "All components to be exported.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "The status of the job.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12ConfigExports": { + "additionalProperties": false, + "properties": { + "exports": { + "items": { + "$ref": "#/definitions/v12ConfigExportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12ConfigImport": { + "properties": { + "components": { + "description": "Specifies the components which will be imported.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "export_id": { + "description": "The export ID given to the task.", + "maxLength": 255, + "minLength": 14, + "type": "string" + } + }, + "required": [ + "export_id" + ], + "type": "object" + }, + "v12ConfigImportExtended": { + "properties": { + "done": { + "description": "All finished components.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "export_id": { + "description": "The export ID given to the task.", + "maxLength": 255, + "minLength": 14, + "type": "string" + }, + "failed": { + "description": "All failed components.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The import ID given to the task.", + "maxLength": 255, + "minLength": 14, + "type": "string" + }, + "message": { + "description": "Message of job.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The path where import job's result is stored.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "pending": { + "description": "All components to be imported.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "The status of the job.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12ConfigImports": { + "additionalProperties": false, + "properties": { + "imports": { + "items": { + "$ref": "#/definitions/v12ConfigImportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12DatasetFilter": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v12DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v12DatasetFilterExtended": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "creation_time": { + "description": "Timestamp of when the filter was applied.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the filter configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The filter ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v12DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v12DatasetFilterMetricValues": { + "additionalProperties": false, + "description": "Configurable metrics.", + "properties": { + "export_id": { + "description": "NFS export ID", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "groupname": { + "description": "groupname", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "local_address": { + "description": "Local IPv4, IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "path": { + "description": "Path of tracked directory", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "protocol": { + "description": "The protocol used for the request", + "enum": [ + "smb1", + "smb2", + "nfs3", + "nfs4", + "s3", + "nfsrdma" + ], + "type": "string" + }, + "remote_address": { + "description": "Client IPv4 or IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "share_name": { + "description": "SMB share name", + "maxLength": 320, + "minLength": 1, + "type": "string" + }, + "username": { + "description": "username", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "zone_name": { + "description": "The zone name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12DatasetFilterMetricValuesExtended": { + "allOf": [ + { + "$ref": "#/definitions/v12DatasetFilterMetricValues" + }, + { + "description": "Performance metric values that can be used to pin workloads and apply filters, and performance metric values that are used to display information about the system performance dataset.", + "properties": { + "job_type": { + "description": "The job type.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "system_name": { + "description": "The system name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "v12DatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v12DatasetFilterExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v12DatasetWorkload": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v12DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v12DatasetWorkloadExtended": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "creation_time": { + "description": "Timestamp of when the workload was pinned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the workload configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The workload ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v12DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v12DatasetWorkloads": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "workloads": { + "items": { + "$ref": "#/definitions/v12DatasetWorkloadExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v12DatasetsDatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v12DatasetFilterExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v12DatasetsDatasetWorkloads": { + "additionalProperties": false, + "properties": { + "workloads": { + "items": { + "$ref": "#/definitions/v12DatasetWorkloadExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v12EventChannel": { + "description": "Named channel through which alerts can be delivered.", + "properties": { + "allowed_nodes": { + "description": "Nodes (LNNs) that can be masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "enabled": { + "description": "Channel is to be used or not.", + "type": "boolean" + }, + "excluded_nodes": { + "description": "Nodes (LNNs) that can NOT be the masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Channel name, may not contain /.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/v12EventChannelsParameters" + }, + "rules": { + "description": "Alert rules involving this eventgroup type.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "system": { + "description": "Channel is a pre-defined system channel.", + "type": "boolean" + }, + "type": { + "description": "The mechanism used by the channel.", + "enum": [ + "connectemc", + "smtp", + "snmp", + "heartbeat" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12EventChannelExtended": { + "description": "Named channel through which alerts can be delivered.", + "properties": { + "allowed_nodes": { + "description": "Nodes (LNNs) that can be masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "enabled": { + "description": "Channel is to be used or not.", + "type": "boolean" + }, + "excluded_nodes": { + "description": "Nodes (LNNs) that can NOT be the masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "parameters": { + "$ref": "#/definitions/v12EventChannelsParameters" + }, + "system": { + "description": "Channel is a pre-defined system channel.", + "type": "boolean" + }, + "type": { + "description": "The mechanism used by the channel.", + "enum": [ + "connectemc", + "smtp", + "snmp", + "heartbeat" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12EventChannels": { + "description": "Named channel through which alerts can be delivered.", + "properties": { + "allowed_nodes": { + "description": "Nodes (LNNs) that can be masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "enabled": { + "description": "Channel is to be used or not.", + "type": "boolean" + }, + "excluded_nodes": { + "description": "Nodes (LNNs) that can NOT be the masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Channel name, may not contain /.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/v12EventChannelsParameters" + }, + "system": { + "description": "Channel is a pre-defined system channel.", + "type": "boolean" + }, + "type": { + "description": "The mechanism used by the channel.", + "enum": [ + "connectemc", + "smtp", + "snmp", + "heartbeat" + ], + "type": "string" + } + }, + "required": [ + "name", + "type" + ], + "type": "object" + }, + "v12EventChannelsExtended": { + "additionalProperties": false, + "properties": { + "channels": { + "items": { + "$ref": "#/definitions/v12EventChannel" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12EventChannelsExtendedExtended": { + "additionalProperties": false, + "properties": { + "channels": { + "items": { + "$ref": "#/definitions/v12EventChannel" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12EventChannelsParameters": { + "description": "A collection of parameters dependent on the channel type.", + "properties": { + "address": { + "description": "Email addresses to send to.", + "items": { + "maxLength": 320, + "minLength": 5, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "batch": { + "description": "Batching criterion.", + "enum": [ + "NONE", + "ALL", + "CATEGORY", + "SEVERITY" + ], + "type": "string" + }, + "batch_period": { + "description": "Period over which batching is to be performed.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "custom_template": { + "description": "Path to custom notification template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "send_as": { + "description": "Email address to use as from.", + "maxLength": 320, + "minLength": 0, + "type": "string" + }, + "smtp_host": { + "description": "SMTP relay host.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "smtp_password": { + "description": "Password for SMTP authentication - only if smtp_use_auth true.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "smtp_port": { + "description": "SMTP relay port - optional defaults to 25.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "smtp_security": { + "description": "Encryption protocol to use for SMTP.", + "enum": [ + "NONE", + "STARTTLS" + ], + "type": "string" + }, + "smtp_use_auth": { + "description": "Use SMTP authentication - optional defaults to false.", + "type": "boolean" + }, + "smtp_username": { + "description": "Username for SMTP authentication - only if smtp_use_auth true.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subject": { + "description": "Subject for emails.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v12EventEventgroupDefinitions": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v12EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12EventEventgroupDefinitionsEventgroup-Definition": { + "description": "Description of an eventgroup that can occur and be detected.", + "properties": { + "category": { + "description": "ID of eventgroup category: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "enum": [ + "all", + "100000000", + "200000000", + "300000000", + "400000000", + "500000000", + "600000000", + "700000000", + "800000000", + "900000000", + "1100000000", + "Unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "channels": { + "description": "Channels by which this eventgroup type can be alerted.", + "items": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "description": { + "description": "Human readable description - may contain value placeholders.", + "type": "string" + }, + "id": { + "description": "Unique Identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Name for eventgroup.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "no_ignore": { + "description": "True if event should not be ignored.", + "type": "boolean" + }, + "node": { + "description": "True if this eventgroup type is node specific, false cluster wide.", + "type": "boolean" + }, + "rules": { + "description": "Alert rules involving this eventgroup type.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "suppressed": { + "description": "True if alerting is suppressed for this eventgroup type.", + "type": "boolean" + } + }, + "type": "object" + }, + "v12EventEventgroupDefinitionsExtended": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v12EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12EventEventgroupOccurrences": { + "additionalProperties": false, + "properties": { + "eventgroups": { + "items": { + "$ref": "#/definitions/v12EventEventgroupOccurrencesEventgroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12EventEventgroupOccurrencesEventgroup": { + "description": "Record of an eventgroup occurrence.", + "properties": { + "causes": { + "description": "List of eventgroup IDs that may be causes of this occurrence.", + "items": { + "description": "Event Group cause as name and description.", + "items": { + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "channels": { + "description": "List of channels to which alerts are configured for this eventgroup.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "event_count": { + "description": "Number of events linked to this eventgroup.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "eventgroup_instance": { + "description": "Unique identifier of eventgroup instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Same as eventgroup_instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore": { + "description": "True if eventgroup is marked as 'ignore'.", + "type": "boolean" + }, + "ignore_time": { + "description": "Time eventgroup was marked as 'ignore'.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_event": { + "description": "Time the most recent event was added to this eventgroup.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resolve_time": { + "description": "When the eventgroup became resolved.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resolved": { + "description": "True if eventgroup is resolved.", + "type": "boolean" + }, + "resolver": { + "description": "'USER' if the eventgroup was marked resolved by the user. '' if eventgroup was marked resolved as a result of an event.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sequence": { + "description": "Unique sequence number assigned to the eventgroup, by order of creation.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "severity": { + "description": "Event Group severity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "specifier": { + "$ref": "#/definitions/Empty" + }, + "time_noticed": { + "description": "Time of first event linked to this eventgroup.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12EventEventgroupOccurrencesExtended": { + "description": "Ignore flag for eventgroup.", + "properties": { + "ignore": { + "description": "True if eventgroup is to be ignored.", + "type": "boolean" + }, + "resolved": { + "description": "True if eventgroup is to be resolved.", + "type": "boolean" + } + }, + "type": "object" + }, + "v12EventEventgroupOccurrencesExtendedExtended": { + "additionalProperties": false, + "properties": { + "eventgroups": { + "items": { + "$ref": "#/definitions/v12EventEventgroupOccurrencesEventgroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12EventMaintenance": { + "properties": { + "history": { + "description": "Start and stop times of maintenance mode, 'end' equals 0 indicates that maintenance mode is enabled.", + "items": { + "description": "Time as UNIX timestamp in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "maintenance": { + "description": "Indicates if maintenance mode is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "v12EventMaintenanceExtended": { + "properties": { + "maintenance": { + "description": "Indicates if maintenance mode is enabled.", + "type": "boolean" + }, + "prune": { + "description": "Removes all maintenance mode history that is greater than set number of days.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12EventSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v12EventSettingsSettings" + } + }, + "type": "object" + }, + "v12EventSettingsSettings": { + "description": "Settings for CELOG system.", + "properties": { + "heartbeat_interval": { + "description": "Interval between heartbeat events. \"daily\", \"weekly\", or \"monthly\".", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "retention_days": { + "description": "Retention period in days.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "storage_limit": { + "description": "Storage limit in megabytes per terabyte of available storage.", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v12EventSuppress": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "suppressions": { + "items": { + "$ref": "#/definitions/v12EventSuppressSuppression" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12EventSuppressIdParams": { + "description": "The suppression state of one event.", + "properties": { + "suppressed": { + "type": "boolean" + } + }, + "type": "object" + }, + "v12EventSuppressSuppression": { + "description": "A suppressed event type ID.", + "properties": { + "id": { + "description": "Unique event identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12FilepoolPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v12FilepoolPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_POLICIES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12FilepoolPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v12FilepoolPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12FilepoolPolicy": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "actions", + "file_matching_pattern" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_POLICIES" + }, + "v12FilepoolPolicyExtended": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "birth_cluster_id": { + "description": "The guid assigned to the cluster on which the policy was created", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "id": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + }, + "state": { + "description": "Indicates whether this policy is in a good state (\"OK\") or disabled (\"disabled\")", + "enum": [ + "OK", + "disabled" + ], + "type": "string" + }, + "state_details": { + "description": "Gives further information to describe the state of this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v12FilepoolPolicyExtendedExtended": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v12GroupnetSubnet": { + "properties": { + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addrs": { + "description": "List of IP addresses that SmartConnect listens for DNS requests.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 32, + "minItems": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "array" + }, + "sc_service_name": { + "description": "Domain Name corresponding to the SmartConnect Service Address.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "addr_family", + "prefixlen", + "name" + ], + "type": "object" + }, + "v12GroupnetSubnetExtended": { + "properties": { + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "base_addr": { + "description": "The base IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "groupnet": { + "description": "Name of the groupnet this subnet belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique Subnet ID.", + "maxLength": 66, + "minLength": 1, + "type": "string" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "pools": { + "description": "Name of the pools in the subnet.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addrs": { + "description": "List of IP addresses that SmartConnect listens for DNS requests.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 32, + "minItems": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "array" + }, + "sc_service_name": { + "description": "Domain Name corresponding to the SmartConnect Service Address.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v12GroupnetSubnetScServiceAddr": { + "properties": { + "high": { + "description": "High IP", + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "low": { + "description": "Low IP", + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + } + }, + "required": [ + "high", + "low" + ], + "type": "object" + }, + "v12GroupnetSubnets": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subnets": { + "items": { + "$ref": "#/definitions/v12GroupnetSubnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12GroupnetsGroupnetSubnetsSubnetPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "nfsv3_rroce_only": { + "description": "Indicates that pool contains only RDMA RRoCE capable interfaces.", + "type": "boolean" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12GroupnetsGroupnetSubnetsSubnetPools": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolsPool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12HdfsLogLevel": { + "properties": { + "level": { + "description": "Setup the HDFS service log level for this node", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "default", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12HdfsSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v12HdfsSettingsSettings" + } + }, + "type": "object" + }, + "v12HdfsSettingsSettings": { + "description": "This is schema that contains HDFS protocol properties.", + "properties": { + "ambari_metrics_collector": { + "description": "Ambari metrics collector.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "ambari_namenode": { + "description": "NameNode of Ambari server.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "ambari_server": { + "description": "Ambari server", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "authentication_mode": { + "description": "Type of authentication for HDFS protocol.", + "enum": [ + "simple_only", + "kerberos_only" + ], + "type": "string" + }, + "data_transfer_cipher": { + "description": "Encryption algorithm to use for data transfer (if any).", + "enum": [ + "none", + "aes_128_ctr", + "aes_192_ctr", + "aes_256_ctr" + ], + "type": "string" + }, + "default_block_size": { + "description": "Block size (size=2**value) reported by HDFS server.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "default_checksum_type": { + "description": "Checksum type reported by HDFS server.", + "enum": [ + "none", + "crc32", + "crc32c" + ], + "type": "string" + }, + "hadoop_version_3_or_later": { + "description": "Hadoop client version is 3 or later.", + "type": "boolean" + }, + "hdfs_acl_enabled": { + "description": "Enable HDFS ACL on the zone", + "type": "boolean" + }, + "odp_version": { + "description": "ODP stack repository version number.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "root_directory": { + "description": "HDFS root directory.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "service": { + "description": "Enable or disable the HDFS service.", + "type": "boolean" + }, + "webhdfs_enabled": { + "description": "Enable or disable WebHDFS.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_SETTINGS" + }, + "v12JobJobSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v12JobJobSummarySummary" + } + }, + "type": "object" + }, + "v12JobJobSummarySummary": { + "properties": { + "cluster_is_degraded": { + "description": "Whether the cluster is in a degraded state. Note this is from the perspective of the node handling the query, which might be different from another node.", + "type": "boolean" + }, + "connected": { + "description": "Whether isi_job_d instances on all up nodes in the cluster are connected to the coordinator.", + "type": "boolean" + }, + "coordinator": { + "description": "The devid of the job engine coordinator.", + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "coordinator_lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "disconnected_nodes": { + "description": "If connected=false, this is the set of devids that are not connected to the coordinator.", + "items": { + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "type": "array" + }, + "down_or_read_only_nodes": { + "description": "Whether the cluster has any down or read-only nodes. These nodes are not considered in the connected property.", + "type": "boolean" + }, + "job_d_enabled": { + "description": "Whether the isi_job_d is enabled.", + "type": "boolean" + }, + "next_jid": { + "description": "The job ID to be assigned to the next job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "non_responding_nodes": { + "description": "Shows which nodes have not acknowledged the coordinator.", + "items": { + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "type": "array" + }, + "run_degraded": { + "description": "Whether the job engine would allow most jobs to run even when the cluster is in a degraded state.", + "type": "boolean" + }, + "stats_ready": { + "description": "Whether the coordinator has recently gathered statistics for all nodes in the cluster.", + "type": "boolean" + } + }, + "required": [ + "down_or_read_only_nodes", + "stats_ready", + "next_jid", + "coordinator", + "connected", + "cluster_is_degraded", + "run_degraded", + "job_d_enabled" + ], + "type": "object" + }, + "v12KmipServer": { + "properties": { + "ca_cert_path": { + "description": "Certification Authority (CA) certificate, used for TLS Mutual Authentication with the KMIP Server.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "client_cert_password": { + "description": "Cluster identity private key password.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "client_cert_path": { + "description": "Cluster identity certificate and private key used for TLS Mutual Authentication with the KMIP Server.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "connection_timeout": { + "description": "KMIP RPC connection timeout in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "host": { + "description": "KMIP server hostname.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique KMIP server identifier.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "minimum_tls_version": { + "description": "Denotes the minimum TLS version supported by the KTP. Default value is set to '1.2'. However other supported values are '1.0' and '1.1'.", + "maxLength": 3, + "minLength": 3, + "pattern": "^[0-9]{1}[.][0-9]{1}$", + "type": "string" + }, + "port": { + "description": "KMIP server port.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "retry_timeout": { + "description": "KMIP RPC retry timeout in milliseconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "client_cert_path", + "id", + "host", + "ca_cert_path" + ], + "type": "object" + }, + "v12KmipServerCaCert": { + "properties": { + "expiration_date": { + "description": "Certificate Authority (CA) certificate expiration date in UNIX timestamp format.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "fingerprint": { + "description": "Certification Authority (CA) certificate sha256 fingerprint.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "serial": { + "description": "Certification Authority (CA) certificate serial number field.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "subject": { + "description": "Certification Authority (CA) certificate subject field.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12KmipServerClientCert": { + "properties": { + "expiration_date": { + "description": "Cluster identity certificate expiration date in UNIX timestamp format.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "fingerprint": { + "description": "Cluster identity certificate sha256 fingerprint.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "serial": { + "description": "Cluster identity certificate serial number field.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "subject": { + "description": "Cluster identity certificate subject field.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12KmipServerExtended": { + "properties": { + "ca_cert": { + "$ref": "#/definitions/v12KmipServerCaCert" + }, + "client_cert": { + "$ref": "#/definitions/v12KmipServerClientCert" + }, + "connection_timeout": { + "description": "KMIP RPC connection timeout in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "host": { + "description": "KMIP server hostname.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique KMIP server identifier.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "minimum_tls_version": { + "description": "Denotes the minimum TLS version supported by the KTP. Default value is set to '1.2'. However other supported values are '1.0' and '1.1'.", + "maxLength": 3, + "minLength": 3, + "pattern": "^[0-9]{1}[.][0-9]{1}$", + "type": "string" + }, + "port": { + "description": "KMIP server port.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "retry_timeout": { + "description": "KMIP RPC retry timeout in milliseconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "retry_timeout", + "minimum_tls_version", + "ca_cert", + "id", + "port", + "host", + "connection_timeout", + "client_cert" + ], + "type": "object" + }, + "v12KmipServerExtendedExtended": { + "properties": { + "ca_cert_path": { + "description": "Certification Authority (CA) certificate, used for TLS Mutual Authentication with the KMIP Server.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "client_cert_password": { + "description": "Cluster identity private key password.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "client_cert_path": { + "description": "Cluster identity certificate and private key used for TLS Mutual Authentication with the KMIP Server.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "connection_timeout": { + "description": "KMIP RPC connection timeout in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "host": { + "description": "KMIP server hostname.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "minimum_tls_version": { + "description": "Denotes the minimum TLS version supported by the KTP. Default value is set to '1.2'. However other supported values are '1.0' and '1.1'.", + "maxLength": 3, + "minLength": 3, + "pattern": "^[0-9]{1}[.][0-9]{1}$", + "type": "string" + }, + "port": { + "description": "KMIP server port.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "retry_timeout": { + "description": "KMIP RPC retry timeout in milliseconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12KmipServerExtendedExtendedExtended": { + "properties": { + "ca_cert": { + "$ref": "#/definitions/v12KmipServerCaCert" + }, + "client_cert": { + "$ref": "#/definitions/v12KmipServerClientCert" + }, + "connection_timeout": { + "description": "KMIP RPC connection timeout in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "host": { + "description": "KMIP server hostname.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique KMIP server identifier.", + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "minimum_tls_version": { + "description": "Denotes the minimum TLS version supported by the KTP. Default value is set to '1.2'. However other supported values are '1.0' and '1.1'.", + "maxLength": 3, + "minLength": 3, + "pattern": "^[0-9]{1}[.][0-9]{1}$", + "type": "string" + }, + "port": { + "description": "KMIP server port.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "retry_timeout": { + "description": "KMIP RPC retry timeout in milliseconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12KmipServerVerifyItem": { + "properties": { + "ca_cert_path": { + "description": "Certification Authority (CA) certificate, used for TLS Mutual Authentication with the KMIP Server.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "client_cert_password": { + "description": "Cluster identity private key password.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "client_cert_path": { + "description": "Cluster identity certificate and private key used for TLS Mutual Authentication with the KMIP Server.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "connection_timeout": { + "description": "KMIP RPC connection timeout in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "host": { + "description": "KMIP server hostname.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "minimum_tls_version": { + "description": "Denotes the minimum TLS version supported by the KTP. Default value is set to '1.2'. However other supported values are '1.0' and '1.1'.", + "maxLength": 3, + "minLength": 3, + "pattern": "^[0-9]{1}[.][0-9]{1}$", + "type": "string" + }, + "port": { + "description": "KMIP server port.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "retry_timeout": { + "description": "KMIP RPC retry timeout in milliseconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "client_cert_path", + "host", + "ca_cert_path" + ], + "type": "object" + }, + "v12KmipServers": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "servers": { + "items": { + "$ref": "#/definitions/v12KmipServerExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12KmipServersExtended": { + "additionalProperties": false, + "properties": { + "servers": { + "items": { + "$ref": "#/definitions/v12KmipServerExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12Lfn": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/Createv12LfnItemResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12LfnExtended": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/Createv12LfnItemResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12LfnItem": { + "properties": { + "max_bytes": { + "description": "Specifies the maximum number of bytes the UTF-8 encoded filename can have. This may be more than the character limit as a single character could require up to 4 bytes to be encoded.", + "maximum": 1024, + "minimum": 255, + "type": "integer" + }, + "max_chars": { + "description": "Specifies the maximum number of characters a filename can have. Each character will require between 1 and 4 bytes to encode.", + "maximum": 1024, + "minimum": 255, + "type": "integer" + }, + "path": { + "description": "Specifies the root path that the file name length properties apply to. Files in this directory and all sub-directories will inherit these settings unless overriden.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "policy": { + "description": "Specifies the name length policy for bytes and chars.", + "enum": [ + "restricted", + "full", + "custom" + ], + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object" + }, + "v12LfnPathParams": { + "properties": { + "max_bytes": { + "description": "Specifies the maximum number of bytes the UTF-8 encoded filename can have. This may be more than the character limit as a single character could require up to 4 bytes to be encoded.", + "maximum": 1024, + "minimum": 255, + "type": "integer" + }, + "max_chars": { + "description": "Specifies the maximum number of characters a filename can have. Each character will require between 1 and 4 bytes to encode.", + "maximum": 1024, + "minimum": 255, + "type": "integer" + }, + "path": { + "description": "Specifies the root path that the file name length properties apply to. Files in this directory and all sub-directories will inherit these settings unless overriden.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "policy": { + "description": "Specifies the name length policy for bytes and chars.", + "enum": [ + "restricted", + "full", + "custom" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12NetworkExternal": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v12NetworkExternalSettings" + } + }, + "type": "object" + }, + "v12NetworkExternalExtended": { + "properties": { + "ipv6_auto_config_enabled": { + "description": "True if rtsold daemon is enabled. When set to false, the rtsold service is disabled, and IPv6 auto configuration is disabled", + "type": "boolean" + }, + "sbr": { + "description": "Enable or disable Source Based Routing (Defaults to false)", + "type": "boolean" + }, + "sc_rebalance_delay": { + "description": "Delay in seconds for IP rebalance.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "tcp_ports": { + "description": "List of client TCP ports.", + "items": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12NetworkExternalSettings": { + "properties": { + "default_groupnet": { + "description": "Default client-side DNS settings for non-multitenancy aware programs", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "ipv6_auto_config_enabled": { + "description": "True if rtsold daemon is enabled. When set to false, the rtsold service is disabled, and IPv6 auto configuration is disabled", + "type": "boolean" + }, + "sbr": { + "description": "Enable or disable Source Based Routing (Defaults to false)", + "type": "boolean" + }, + "sc_rebalance_delay": { + "description": "Delay in seconds for IP rebalance.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "tcp_ports": { + "description": "List of client TCP ports.", + "items": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "sbr", + "sc_rebalance_delay", + "ipv6_auto_config_enabled", + "default_groupnet", + "tcp_ports" + ], + "type": "object" + }, + "v12NetworkInterface": { + "properties": { + "flags": { + "description": "List of interface flags", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Id is a concatenation of lnn and name in the format 'lnn:name' e.g. 3:ext-2.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ip_addrs": { + "description": "List of IP addresses", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ipv4_gateway": { + "description": "Address of the default IPv4 gateway", + "maxLength": 16, + "minLength": 1, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "ipv6_gateway": { + "description": "Address of the default IPv6 gateway", + "maxLength": 40, + "minLength": 1, + "pattern": "^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "The mtu the interface.", + "maximum": 9000, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the interface.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "nic_name": { + "description": "NIC name", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "owners": { + "description": "List of owners (membership)", + "items": { + "$ref": "#/definitions/v12NetworkInterfaceOwner" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of the interface", + "enum": [ + "up", + "no_carrier", + "active", + "inactive", + "disabled", + "unknown" + ], + "type": "string" + }, + "type": { + "description": "The type of network interface", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "vlans": { + "description": "List of VLANs", + "items": { + "$ref": "#/definitions/v12NetworkInterfaceVlan" + }, + "maxItems": 4094, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "status", + "ipv4_gateway", + "name", + "owners", + "mtu", + "nic_name", + "ip_addrs", + "lnn", + "flags", + "ipv6_gateway", + "vlans", + "type", + "id" + ], + "type": "object" + }, + "v12NetworkInterfaceOwner": { + "properties": { + "access_zone": { + "description": "Name of configured Access Zone.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The id of the owner. The concatenation of the groupnet, subnet, and pool fields as relevant.", + "maxLength": 98, + "minLength": 1, + "type": "string" + }, + "ip_addrs": { + "description": "List of IPs on this interface in the pool", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "pool": { + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "subnet": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Specifies the type of network addresses that this interface owner contains.", + "enum": [ + "static", + "dynamic", + "smartconnect_service", + "ipv6_link_local", + "internal" + ], + "type": "string" + }, + "vlan_id": { + "description": "the VLAN ID that corresponds to the ID number for the VLAN set on the switch, with a value from 1 to 4094.", + "maximum": 4094, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v12NetworkInterfaceVlan": { + "properties": { + "flags": { + "description": "List of interface flags", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Id is a concatenation of lnn and name in the format 'lnn:name' e.g. 3:ext-2.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ip_addrs": { + "description": "List of IP addresses", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ipv4_gateway": { + "description": "Address of the default IPv4 gateway", + "maxLength": 16, + "minLength": 1, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "ipv6_gateway": { + "description": "Address of the default IPv6 gateway", + "maxLength": 40, + "minLength": 1, + "pattern": "^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "The mtu the interface.", + "maximum": 9000, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the interface.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "nic_name": { + "description": "NIC name", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "Status of the interface", + "enum": [ + "up", + "no_carrier", + "active", + "inactive", + "disabled", + "unknown" + ], + "type": "string" + }, + "type": { + "description": "The type of network interface", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "vlan_id": { + "description": "The configured VLAN ID.", + "maximum": 4094, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "ipv4_gateway", + "ipv6_gateway" + ], + "type": "object" + }, + "v12NetworkInterfaces": { + "additionalProperties": false, + "properties": { + "errors": { + "description": "A list of errors encountered by the individual nodes involved in this request, or null if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "interfaces": { + "items": { + "$ref": "#/definitions/v12NetworkInterface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NetworkPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Name of the groupnet this pool belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique Pool ID.", + "maxLength": 99, + "minLength": 1, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "nfsv3_rroce_only": { + "description": "Indicates that pool contains only RDMA RRoCE capable interfaces.", + "type": "boolean" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "rules": { + "description": "Names of the rules in this pool.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_suspended_nodes": { + "description": "List of LNNs showing currently suspended nodes in SmartConnect.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "subnet": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12NetworkPools": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v12NetworkPool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NfsLogLevel": { + "properties": { + "level": { + "description": "Valid NFS logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12NfsSettingsGlobal": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v12NfsSettingsGlobalSettings" + } + }, + "type": "object" + }, + "v12NfsSettingsGlobalSettings": { + "description": "Specifies the global NFS configuration settings.", + "properties": { + "nfsv3_enabled": { + "description": "True if NFSv3 is enabled.", + "type": "boolean" + }, + "nfsv3_rdma_enabled": { + "description": "True if the RDMA is enabled for NFSv3.", + "type": "boolean" + }, + "nfsv4_enabled": { + "description": "True if NFSv4 is enabled.", + "type": "boolean" + }, + "rpc_maxthreads": { + "description": "Specifies the maximum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "rpc_minthreads": { + "description": "Specifies the minimum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "rquota_enabled": { + "description": "True if the rquota protocol is enabled.", + "type": "boolean" + }, + "service": { + "description": "True if the NFS service is enabled. When set to false, the NFS service is disabled.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_GLOBAL" + }, + "v12NodeHardware": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v12NodeHardwareNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NodeHardwareNode": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_depth": { + "description": "Chassis depth for this node if applicable (e.g., Normal, Deep, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "compute_type": { + "description": "Type of compute node if applicable (e.g., Low, Medium, High, Turbo, Ultra, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "model": { + "description": "PowerScale node model identifier string (S200, X410, Infinity-H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model_code": { + "description": "PowerScale node model code string (S200, X410, H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_slot_id": { + "description": "Position of node within chassis. -1 for error or not supported.", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "peer_serial_number": { + "description": "Serial number of this node's peer/buddy node.(Infinity Only)", + "type": "string" + }, + "performance_code": { + "description": "Performance code of this node, if applicable (2, 4, 5, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sled_drive_count": { + "description": "Size of drive sleds in node, if applicable. Expected values: 3, 4, 6. 0 if unable to determine sled size. -1 for error or not supported. If PSI_Get fails: -1. PSI_Get can fail if PSI not initialized, or key does not exist.", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "tier": { + "description": "Platform tier level of this node if applicable(positive for a defined tier, 0 for unknown or not supported, -1 for error).", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "top_level_assembly_serial_number": { + "description": "Serial number of the top level assembly of this node.(Infinity Only)", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "top_level_assembly_serial_number", + "peer_serial_number" + ], + "type": "object" + }, + "v12NodeState": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v12NodeStateNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NodeStateNode": { + "description": "Node state information (reported and modifiable).", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "readonly": { + "$ref": "#/definitions/v10ClusterNodeStateReadonly" + }, + "servicelight": { + "$ref": "#/definitions/v12ClusterNodeStateServicelight" + }, + "smartfail": { + "$ref": "#/definitions/v10ClusterNodeStateSmartfail" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NodeStateServicelight": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v12NodeStateServicelightNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NodeStateServicelightExtended": { + "description": "Node service light state.", + "properties": { + "enabled": { + "description": "The node service light state (True = on).", + "type": "boolean" + }, + "supported": { + "description": "This node supports a service light.", + "type": "boolean" + }, + "valid": { + "description": "The node service light state is valid (False = Error).", + "type": "boolean" + } + }, + "type": "object" + }, + "v12NodeStateServicelightNode": { + "description": "Node service light state.", + "properties": { + "enabled": { + "description": "The node service light state (True = on).", + "type": "boolean" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "supported": { + "description": "This node supports a service light.", + "type": "boolean" + }, + "valid": { + "description": "The node service light state is valid (False = Error).", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "type": "object" + }, + "v12NodeStatus": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v12NodeStatusNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NodeStatusNode": { + "description": "Node status information (hardware reported).", + "properties": { + "batterystatus": { + "$ref": "#/definitions/v10ClusterNodeStatusBatterystatus" + }, + "capacity": { + "description": "Storage capacity of this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusCapacityItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "cpu": { + "$ref": "#/definitions/v10ClusterNodeStatusCpu" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "nvram": { + "$ref": "#/definitions/v10ClusterNodeStatusNvram" + }, + "powersupplies": { + "$ref": "#/definitions/v12ClusterNodeStatusPowersupplies" + }, + "release": { + "description": "OneFS release.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uptime": { + "description": "Seconds this node has been online.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "version": { + "description": "OneFS version.", + "maxLength": 511, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v12NodeStatusNvram": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v12NodeStatusNvramNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NodeStatusNvramNode": { + "description": "Node NVRAM information.", + "properties": { + "batteries": { + "description": "This node's NVRAM battery status information.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusNvramBattery" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "battery_count": { + "description": "This node's NVRAM battery count. On failure: -1, otherwise 1 or 2.", + "maximum": 2, + "minimum": -1, + "type": "integer" + }, + "charge_status": { + "description": "This node's NVRAM battery charge status, as a color.", + "enum": [ + "BLACK", + "GREEN", + "YELLOW", + "RED", + "UNKNOWN", + "Not supported" + ], + "maxLength": 13, + "minLength": 3, + "type": "string" + }, + "charge_status_number": { + "description": "This node's NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3.", + "maximum": 3, + "minimum": -1, + "type": "integer" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "present": { + "description": "This node has NVRAM.", + "type": "boolean" + }, + "present_flash": { + "description": "This node has NVRAM with flash storage.", + "type": "boolean" + }, + "present_size": { + "description": "The size of the NVRAM, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "present_type": { + "description": "This node's NVRAM type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "supported": { + "description": "This node supports NVRAM.", + "type": "boolean" + }, + "supported_flash": { + "description": "This node supports NVRAM with flash storage.", + "type": "boolean" + }, + "supported_size": { + "description": "The maximum size of the NVRAM, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "supported_type": { + "description": "This node's supported NVRAM type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v12NodeStatusPowersupplies": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v12NodeStatusPowersuppliesNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12NodeStatusPowersuppliesNode": { + "description": "Information about this node's power supplies.", + "properties": { + "count": { + "description": "Count of how many power supplies are supported.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "failures": { + "description": "Count of how many power supplies have failed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "A descriptive status string for this node's power supplies.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "supplies": { + "description": "List of this node's power supplies.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusPowersuppliesSupply" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12NodetypeAssess": { + "properties": { + "from_nodepools": { + "description": "Pools assessed for removing nodetype.", + "items": { + "$ref": "#/definitions/v10NodetypeAssessNodetypeFromNodepoolItem" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "to_nodepools": { + "description": "Pools assessed for adding nodetype.", + "items": { + "$ref": "#/definitions/v10NodetypeAssessNodetypeFromNodepoolItem" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "to_nodepools", + "from_nodepools" + ], + "type": "object" + }, + "v12QuotaQuota": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise an accounting quota.", + "type": "boolean" + }, + "force": { + "description": "Force creation of quotas on the root of /ifs or percent based quotas.", + "type": "boolean" + }, + "ignore_limit_checks": { + "description": "If true, skip child quota's threshold comparison with parent quota path.", + "type": "boolean" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholds" + }, + "thresholds_include_overhead": { + "description": "This option is deprecated. Use the option 'thresholds_on' to select the usage on which thresholds to apply.", + "type": "boolean" + }, + "thresholds_on": { + "default": "fslogicalsize", + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "type": "string" + } + }, + "required": [ + "include_snapshots", + "path", + "type" + ], + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "v12QuotaQuotaExtended": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "efficiency_ratio": { + "description": "Represents the ratio of logical space provided to physical space used. This accounts for protection overhead, metadata, and compression ratios for the data.", + "maximum": 1.79769e+308, + "minimum": 0, + "type": "number", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_EFFICIENCYRATIO" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise a accounting quota.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the quota.", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "linked": { + "description": "For user, group and directory quotas, true if the quota is linked and controlled by a parent default-* quota. Linked quotas cannot be modified until they are unlinked.", + "type": "boolean" + }, + "notifications": { + "description": "Summary of notifications: 'custom' indicates one or more notification rules available from the notifications sub-resource; 'default' indicates system default rules are used; 'disabled' indicates that no notifications will be used for this quota.; 'badmap' indicates that notification rule has problem in rule map.", + "enum": [ + "custom", + "default", + "disabled", + "badmap" + ], + "maxLength": 8, + "minLength": 6, + "type": "string" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ready": { + "description": "True if the default resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "reduction_ratio": { + "description": "Represents the ratio of logical space provided to physical data space used. This accounts for compression and data deduplication effects.", + "maximum": 1.79769e+308, + "minimum": 0, + "type": "number", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_REDUCTIONRATIO" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholdsExtended" + }, + "thresholds_on": { + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v12QuotaQuotaUsage" + } + }, + "required": [ + "enforced", + "include_snapshots", + "container", + "usage", + "thresholds", + "persona", + "linked", + "notifications", + "ready", + "path", + "type", + "id" + ], + "type": "object" + }, + "v12QuotaQuotaExtendedExtended": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise an accounting quota.", + "type": "boolean" + }, + "force": { + "description": "Force creation of quotas on the root of /ifs or percent based quotas.", + "type": "boolean" + }, + "ignore_limit_checks": { + "description": "If true, skip child quota's threshold comparison with parent quota path.", + "type": "boolean" + }, + "linked": { + "description": "If false and the quota is linked, attempt to unlink.", + "type": "boolean" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholds" + }, + "thresholds_include_overhead": { + "description": "This option is deprecated. Use the option 'thresholds_on' to select the usage on which thresholds to apply.", + "type": "boolean" + }, + "thresholds_on": { + "default": "fslogicalsize", + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "v12QuotaQuotaThresholds": { + "properties": { + "advisory": { + "description": "Usage bytes at which notifications will be sent but writes will not be denied.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "hard": { + "description": "Usage bytes at which further writes will be denied.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "percent_advisory": { + "description": "Advisory threshold as percent of hard threshold.", + "maximum": 99.99, + "minimum": 0.01, + "type": "number" + }, + "percent_soft": { + "description": "Soft threshold as percent of hard threshold.", + "maximum": 99.99, + "minimum": 0.01, + "type": "number" + }, + "soft": { + "description": "Usage bytes at which notifications will be sent and soft grace time will be started.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "soft_grace": { + "description": "Time in seconds after which the soft threshold has been hit before writes will be denied.", + "maximum": 1073741823, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v12QuotaQuotaThresholdsExtended": { + "properties": { + "advisory": { + "description": "Usage bytes at which notifications will be sent but writes will not be denied.", + "minimum": 1, + "type": "integer" + }, + "advisory_exceeded": { + "description": "True if the advisory threshold has been hit.", + "type": "boolean" + }, + "advisory_last_exceeded": { + "description": "Time at which advisory threshold was hit.", + "type": "integer" + }, + "hard": { + "description": "Usage bytes at which further writes will be denied.", + "minimum": 1, + "type": "integer" + }, + "hard_exceeded": { + "description": "True if the hard threshold has been hit.", + "type": "boolean" + }, + "hard_last_exceeded": { + "description": "Time at which hard threshold was hit.", + "type": "integer" + }, + "percent_advisory": { + "description": "Advisory threshold as percent of hard threshold. Usage bytes at which notifications will be sent but writes will not be denied.", + "maximum": 99.99, + "minimum": 0.01, + "type": "number" + }, + "percent_soft": { + "description": "Soft threshold as percent of hard threshold. Usage bytes at which notifications will be sent and soft grace time will be started.", + "maximum": 99.99, + "minimum": 0.01, + "type": "number" + }, + "soft": { + "description": "Usage bytes at which notifications will be sent and soft grace time will be started.", + "minimum": 1, + "type": "integer" + }, + "soft_exceeded": { + "description": "True if the soft threshold has been hit.", + "type": "boolean" + }, + "soft_grace": { + "description": "Time in seconds after which the soft threshold has been hit before writes will be denied.", + "minimum": 1, + "type": "integer" + }, + "soft_last_exceeded": { + "description": "Time at which soft threshold was hit", + "type": "integer" + } + }, + "required": [ + "advisory", + "soft_last_exceeded", + "hard_last_exceeded", + "soft_exceeded", + "hard_exceeded", + "hard", + "advisory_last_exceeded", + "advisory_exceeded", + "soft_grace", + "soft" + ], + "type": "object" + }, + "v12QuotaQuotaUsage": { + "properties": { + "applogical": { + "description": "Bytes used by governed data apparent to application.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "applogical_ready": { + "description": "True if applogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "fslogical": { + "description": "Bytes used by governed data apparent to filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fslogical_ready": { + "description": "True if fslogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "fsphysical": { + "description": "Physical data usage adjusted to account for shadow store efficiency", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_USAGE_FSPHYSICAL" + }, + "fsphysical_ready": { + "description": "True if fsphysical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "inodes": { + "description": "Number of inodes (filesystem entities) used by governed data.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "inodes_ready": { + "description": "True if inodes resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "physical": { + "description": "Bytes used for governed data and filesystem overhead.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "physical_data": { + "description": "Number of physical blocks for file data", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "physical_data_ready": { + "description": "True if physical_data resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "physical_protection": { + "description": "Number of physical blocks for file protection", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "physical_protection_ready": { + "description": "True if physical_protection resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "physical_ready": { + "description": "True if physical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "shadow_refs": { + "description": "Number of shadow references (cloned, deduplicated or packed filesystem blocks) used by governed data.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "shadow_refs_ready": { + "description": "True if shadow_refs resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + } + }, + "required": [ + "inodes_ready", + "physical_ready", + "fslogical_ready", + "fsphysical_ready", + "fslogical", + "shadow_refs_ready", + "applogical", + "shadow_refs", + "applogical_ready", + "physical_protection_ready", + "physical_data", + "physical_protection", + "physical_data_ready", + "inodes", + "physical" + ], + "type": "object" + }, + "v12QuotaQuotas": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v12QuotaQuotaExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v12QuotaQuotasExtended": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v12QuotaQuotaExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12S3Bucket": { + "properties": { + "acl": { + "description": "Specifies an ordered list of S3 permissions.", + "items": { + "$ref": "#/definitions/v10S3BucketAclItem" + }, + "maxItems": 100, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "description": { + "description": "Description for this S3 bucket.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Bucket ID.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Bucket name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "object_acl_policy": { + "description": "Set behavior of modifying object acls", + "enum": [ + "replace", + "deny" + ], + "type": "string" + }, + "owner": { + "description": "Specifies the name of the owner.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "Path of bucket within /ifs.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "zid": { + "description": "Zone ID", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "description", + "object_acl_policy", + "zid", + "owner", + "path", + "id", + "name" + ], + "type": "object" + }, + "v12S3Buckets": { + "additionalProperties": false, + "properties": { + "buckets": { + "items": { + "$ref": "#/definitions/v12S3Bucket" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_S3_BUCKETS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "buckets" + ], + "type": "object" + }, + "v12S3BucketsExtended": { + "additionalProperties": false, + "properties": { + "buckets": { + "items": { + "$ref": "#/definitions/v12S3Bucket" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "buckets" + ], + "type": "object" + }, + "v12S3SettingsZone": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v12S3SettingsZoneSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v12S3SettingsZoneSettings": { + "properties": { + "base_domain": { + "description": "Specifies the S3 base domain name.", + "maxLength": 255, + "minLength": 0, + "pattern": "^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$", + "type": "string" + }, + "bucket_directory_create_mode": { + "description": "Create bucket directory with this permission mode", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "object_acl_policy": { + "description": "Default object ACL policy for S3 Buckets.", + "enum": [ + "replace", + "deny" + ], + "type": "string" + }, + "root_path": { + "description": "Specifies the S3 bucket root path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "use_md5_for_etag": { + "description": "Use MD5 for Etag on upload", + "type": "boolean" + }, + "validate_content_md5": { + "description": "Validate given Content-MD5", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_S3_SETTINGS_ZONE" + }, + "v12SedMigrateItem": { + "properties": { + "retry": { + "description": "Set to true to retry KMIP migration in the previous direction for errored nodes. e.g. if error occured after migrate with 'to_server=true', using 'sed/migrate' handler with 'retry=true' will retry migration to server. Similarly, if previous migration was 'to_server=false', retry will try to restore back to local. Also note that, whenever a 'retry' arg is provided to the handler, regardless of true or false, 'to_server' arg will be ignored. i.e. if using the handler with ('retry':true(or false), 'to_server': true), the 'to_server' arg will be ignored and have no effects.", + "type": "boolean" + }, + "to_server": { + "description": "Set to true to indicate migrating all keys to server. Set to false to indicate retoring all keys back to local.", + "type": "boolean" + } + }, + "type": "object" + }, + "v12SedSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v12SedSettingsSettings" + } + }, + "type": "object" + }, + "v12SedSettingsExtended": { + "properties": { + "kmip_enabled": { + "description": "True if the KMIP SEDS feature is enabled and migration is allowed. When set to false, the KMIP SEDS feature is disabled, migration is not allowed. User can disable the feature only when ALL keys are in LOCAL status.", + "type": "boolean" + } + }, + "type": "object" + }, + "v12SedSettingsSettings": { + "properties": { + "kmip_enabled": { + "description": "True if the KMIP SEDS feature is enabled and migration is allowed. When set to false, the KMIP SEDS feature is disabled, migration is not allowed. User can disable the feature only when ALL keys are in LOCAL status.", + "type": "boolean" + }, + "kmip_server": { + "description": "Current kmip server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "supported": { + "description": "True if the SEDS is supported by the platform.", + "type": "boolean" + } + }, + "required": [ + "kmip_server", + "supported", + "kmip_enabled" + ], + "type": "object" + }, + "v12SedStatus": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v12SedStatusNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12SedStatusExtended": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v12SedStatusNodeExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12SedStatusNode": { + "properties": { + "error_msg": { + "description": "information of the error if there is an error status. Empty if no error occurred.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "location": { + "description": "Current location of the key.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "remote_key_id": { + "description": "Key ID in the remote KMIP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Current key migration status. If no SEDs are avaiable and KMIP is not supported, it will show OFFLINE status.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "status", + "lnn", + "id", + "remote_key_id", + "location", + "error_msg" + ], + "type": "object" + }, + "v12SedStatusNodeExtended": { + "properties": { + "error_msg": { + "description": "information of the error if there is an error status. Empty if no error occurred.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "location": { + "description": "Current location of the key.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "remote_key_id": { + "description": "Key ID in the remote KMIP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Current key migration status. If no SEDs are avaiable and KMIP is not supported, it will show OFFLINE status.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12SmbLogLevel": { + "properties": { + "level": { + "description": "Valid SMB logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v12SmbShare": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_path": { + "description": "Create path if does not exist.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "sparse_file": { + "description": "Enables sparse file.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share.", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object" + }, + "v12SmbShareExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Share ID.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "sparse_file": { + "description": "Enables sparse file.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zid": { + "description": "Numeric ID of the access zone which contains this SMB share", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "path", + "id", + "zid", + "name" + ], + "type": "object" + }, + "v12SmbShareExtendedExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "sparse_file": { + "description": "Enables sparse file.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share.", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12SmbShares": { + "additionalProperties": false, + "properties": { + "digest": { + "description": "An identifier for a set of shares.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "shares": { + "items": { + "$ref": "#/definitions/v12SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v12SmbSharesExtended": { + "additionalProperties": false, + "properties": { + "shares": { + "items": { + "$ref": "#/definitions/v12SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v12StoragepoolNodetype": { + "properties": { + "id": { + "description": "The system ID given to the nodetype.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "manual": { + "description": "Whether or not the nodetype is in a manually managed node pool.", + "type": "boolean" + }, + "nodes": { + "description": "The nodes that are part of this nodetype.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "product_name": { + "description": "The product name of the node type.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "nodes", + "manual", + "id", + "product_name" + ], + "type": "object" + }, + "v12StoragepoolNodetypes": { + "additionalProperties": false, + "properties": { + "nodetypes": { + "items": { + "$ref": "#/definitions/v12StoragepoolNodetype" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODETYPES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12StoragepoolNodetypesExtended": { + "additionalProperties": false, + "properties": { + "nodetypes": { + "items": { + "$ref": "#/definitions/v12StoragepoolNodetype" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12SubnetsSubnetPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "nfsv3_rroce_only": { + "description": "Indicates that pool contains only RDMA RRoCE capable interfaces.", + "type": "boolean" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v12SubnetsSubnetPoolIface": { + "properties": { + "iface": { + "description": "A string that defines an interface name.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v12SubnetsSubnetPoolStaticRoute": { + "properties": { + "gateway": { + "description": "Address of the gateway in the format: yyy.yyy.yyy.yyy", + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "prefixlen": { + "description": "Prefix length in the format: nn.", + "maximum": 128, + "minimum": 0, + "type": "integer" + }, + "subnet": { + "description": "Network address in the format: xxx.xxx.xxx.xxx", + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + } + }, + "required": [ + "prefixlen", + "subnet", + "gateway" + ], + "type": "object" + }, + "v12SubnetsSubnetPools": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolsPool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12SubnetsSubnetPoolsPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Name of the groupnet this pool belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique Pool ID.", + "maxLength": 99, + "minLength": 1, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "nfsv3_rroce_only": { + "description": "Indicates that pool contains only RDMA RRoCE capable interfaces.", + "type": "boolean" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "rules": { + "description": "Names of the rules in this pool.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_suspended_nodes": { + "description": "List of LNNs showing currently suspended nodes in SmartConnect.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "subnet": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ifaces", + "aggregation_mode", + "sc_failover_policy", + "nfsv3_rroce_only", + "sc_subnet", + "sc_suspended_nodes", + "id", + "subnet", + "rebalance_policy", + "sc_connect_policy", + "groupnet", + "description", + "rules", + "access_zone", + "alloc_method", + "ranges", + "sc_dns_zone_aliases", + "sc_dns_zone", + "name", + "static_routes", + "sc_ttl", + "addr_family", + "sc_auto_unsuspend_delay" + ], + "type": "object" + }, + "v12UpgradeCluster": { + "description": "Cluster wide upgrade status info.", + "properties": { + "cluster_overview": { + "$ref": "#/definitions/v12UpgradeClusterClusterOverview" + }, + "cluster_state": { + "description": "The different states of an upgrade, rollback, or assessment. One of the following values: 'committed', 'upgraded', 'partially upgraded', 'upgrading', 'rolling back', 'assessing', 'error'", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "committed_features": { + "$ref": "#/definitions/v12UpgradeClusterCommittedFeatures" + }, + "current_process": { + "description": "The current upgrade activity.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "finish_time": { + "description": "The time when a rollback, assessment or upgrade has finished completely. Use ISO 8601 standard. Null if the cluster_state is not 'upgraded'.", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "fw_pkg": { + "description": "The location (path) of the firmware package which must be within /ifs.", + "maxLength": 4096, + "minLength": 3, + "type": "string" + }, + "fw_pkg_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs. Null if the cluster_state is 'committed' or 'upgraded.'", + "maxLength": 4096, + "minLength": 5, + "type": "string" + }, + "node_median_time": { + "description": "The median time (seconds) to complete each node so far during this upgrade. Before the first node in an upgrade has completed this key will have an associated null value.", + "type": "integer" + }, + "onefs_version_current": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "onefs_version_upgrade": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "patch_action": { + "description": "The most recent patch action performed.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "patch_name": { + "description": "The patch with the most recent patch action.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "start_time": { + "description": "The time when an upgrade, rollback, or assessment was started. Use ISO 8601 standard. Null if the cluster_state is 'committed' or 'partially upgraded.'", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "upgrade_is_committed": { + "description": "True if upgrade is committed.", + "type": "boolean" + }, + "upgrade_process_state": { + "description": "The different states of upgrade process. One of the following values: 'Not started', 'Running', 'Pausing', 'Paused'. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "upgrade_settings": { + "$ref": "#/definitions/v12UpgradeClusterUpgradeSettings" + }, + "upgrade_triggered_time": { + "description": "Time at which upgrade was originally requested.", + "maxLength": 128, + "minLength": 4, + "type": "string" + } + }, + "type": "object" + }, + "v12UpgradeClusterClusterOverview": { + "description": "The cluster overview of an upgrade process.", + "properties": { + "nodes_current": { + "description": "Number of nodes running the current OneFS version.", + "maximum": 576, + "minimum": 1, + "type": "integer" + }, + "nodes_total": { + "description": "Total number of nodes on the cluster.", + "maximum": 576, + "minimum": 1, + "type": "integer" + }, + "nodes_transitioning": { + "description": "Number of nodes transitioning between OneFS versions. Null if the cluster_state is 'committed' or 'assessing.'", + "maximum": 576, + "minimum": 0, + "type": "integer" + }, + "nodes_upgraded": { + "description": "Number of nodes running the upgraded OneFS version. Null if the cluster_state is 'committed' or 'assessing.'", + "maximum": 576, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12UpgradeClusterCommittedFeatures": { + "description": "The feature set supported as of the most recent upgrade commit.", + "properties": { + "default_gen": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gen_bits": { + "items": { + "$ref": "#/definitions/v12UpgradeClusterCommittedFeaturesGenBit" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v12UpgradeClusterCommittedFeaturesGenBit": { + "properties": { + "bits": { + "items": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "gen": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v12UpgradeClusterOnefsVersionCurrent": { + "description": "The current OneFS version before upgrade.", + "properties": { + "bugfix": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "maintenance": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "major": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "minor": { + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "version": { + "description": "Hex representation of the OneFS version integer.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v12UpgradeClusterUpgradeSettings": { + "description": "The settings necessary when starting an upgrade. Null if the cluster_state is not 'upgrading' or 'partially upgraded.' or 'error'.", + "properties": { + "nodes_to_rolling_upgrade": { + "description": "The nodes (to be) scheduled for upgrade ordered by queue position number. Null if the cluster_state is 'partially upgraded' or upgrade_type is 'simultaneous'. One of the following values: [, , ... ], 'all', null", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + }, + "upgrade_type": { + "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous'", + "maxLength": 128, + "minLength": 3, + "type": "string" + } + }, + "type": "object" + }, + "v14AuthId": { + "properties": { + "ntoken": { + "$ref": "#/definitions/v14AuthIdNtoken" + } + }, + "type": "object" + }, + "v14AuthIdNtoken": { + "description": "Specifies properties for a security token for the currently authenticated user.", + "properties": { + "additional_id": { + "description": "Specifies additional UIDs, GIDs, and SIDs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "group_sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ifs_restricted": { + "description": "Indicates if this user has restricted access to the /ifs file system.", + "type": "boolean" + }, + "local_address": { + "description": "Specifies the IP address of the node that is serving the request.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "on_disk_group_id": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "on_disk_user_id": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "privilege": { + "description": "Specifies the privileges granted to the currently authenticated user.", + "items": { + "$ref": "#/definitions/v14AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "protocol": { + "description": "Specifies the protocol that is responsible for the creation of the token. The integer values for each protocol are as follows: NFS (1), SMB (2), NLM (3), FTP (4), HTTP (5), ISCSI (7), SMB2 (8), NFS4 (9), OneFS API (10), HDFS (15), console (16), and SSH (17).", + "maximum": 128, + "minimum": 0, + "type": "integer" + }, + "remote_address": { + "description": "Specifies the IP address of the client requesting information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "user_sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "zid": { + "description": "Specifies the zone ID of the access zone that is serving the request.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "zone_id": { + "description": "Specifies the name of the access zone that is serving the request.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v14AuthIdNtokenPrivilegeItem": { + "description": "Specifies the system-defined privilege that may be granted to users.", + "properties": { + "id": { + "description": "Specifies the ID of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "permission": { + "description": "permission of the privilege, 'r' = read , 'x' = read-execute, 'w' = read-execute-write, '-' = no permission", + "enum": [ + "r", + "w", + "x", + "-" + ], + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v14AuthPrivilege": { + "description": "Specifies the system-defined privilege that may be granted to users.", + "properties": { + "category": { + "description": "Specifies the general categorization of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Specifies a short description of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "parent_id": { + "description": "Specifies the parent ID of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "permission": { + "description": "Permissions the privilege has r=read , x=read-execute, w=read-execute-write.", + "enum": [ + "r", + "w", + "x" + ], + "type": "string" + }, + "privilegelevel": { + "description": "Specifies the level of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uri": { + "description": "Specifies the associated uri for the privilege.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "category", + "description", + "id" + ], + "type": "object" + }, + "v14AuthPrivileges": { + "additionalProperties": false, + "properties": { + "privileges": { + "items": { + "$ref": "#/definitions/v14AuthPrivilege" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14AuthRole": { + "description": "Specifies the role maps privileges to users and groups.", + "properties": { + "description": { + "description": "Specifies the description of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "members": { + "description": "Specifies the users or groups that have this role.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the role.", + "maxLength": 255, + "minLength": 0, + "pattern": "^[^ \t\n](.*[^ \t\n])*$", + "type": "string" + }, + "privileges": { + "description": "Specifies the privileges granted by this role.", + "items": { + "$ref": "#/definitions/v14AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v14AuthRoleExtended": { + "allOf": [ + { + "$ref": "#/definitions/v14AuthRole" + }, + { + "description": "Specifies the role maps privileges to users and groups.", + "properties": { + "description": { + "description": "Specifies the description of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "members": { + "description": "Specifies the users or groups that have this role.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "privileges": { + "description": "Specifies the privileges granted by this role.", + "items": { + "$ref": "#/definitions/v14AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "privileges", + "description", + "members", + "id" + ], + "type": "object" + } + ] + }, + "v14AuthRoleExtendedExtended": { + "description": "Specifies the role maps privileges to users and groups.", + "properties": { + "description": { + "description": "Specifies the description of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "members": { + "description": "Specifies the users or groups that have this role.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the role.", + "maxLength": 255, + "minLength": 0, + "pattern": "^[^ \t\n](.*[^ \t\n])*$", + "type": "string" + }, + "privileges": { + "description": "Specifies the privileges granted by this role.", + "items": { + "$ref": "#/definitions/v14AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14AuthRoles": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "roles": { + "items": { + "$ref": "#/definitions/v14AuthRoleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14AuthRolesExtended": { + "additionalProperties": false, + "properties": { + "roles": { + "items": { + "$ref": "#/definitions/v14AuthRoleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14CatalogExport": { + "description": "Allows a catalog artifact to be exported out of the catalog to a file that the user can access. A typical use case would be if a user needs to export artifacts prior to a full catalog wipe or if a specific package is needed so that it can be applied on another cluster.", + "properties": { + "file": { + "description": "Path to export the signed file to", + "maxLength": 4096, + "minLength": 3, + "type": "string" + }, + "hash": { + "description": "The sha256 hash of the file stored in catalog", + "maxLength": 128, + "minLength": 3, + "type": "string" + } + }, + "required": [ + "hash", + "file" + ], + "type": "object" + }, + "v14CatalogImport": { + "description": "Allow a signed package to be re-imported into the catalog. A typical use case would be if a required package is missing or damaged. All user imported files will be subjected to a full signature verification including verifying the sha256 hashes for all data regions. Files that are not correctly signed will not be allowed in the catalog.", + "properties": { + "file": { + "description": "Path of the signed file to import in the catalog", + "maxLength": 4096, + "minLength": 3, + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + }, + "v14CatalogList": { + "description": "List metadata for artifacts in the catalog.", + "properties": { + "artifacts": { + "description": "List of catalog entries", + "items": { + "$ref": "#/definitions/v14CatalogListArtifact" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14CatalogListArtifact": { + "description": "List metadata for artifacts in the catalog.", + "properties": { + "content_type": { + "description": "the type of upgrade", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "desc": { + "description": "description of pacakge", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "hash": { + "description": "hash associated with artifact", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "onefs_version": { + "description": "onefs version", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "readme": { + "description": "value describing that README file exists", + "type": "boolean" + }, + "reference": { + "description": "onefs component that references this entry.", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v14CatalogReadme": { + "description": "README file content for artifact in the catalog.", + "properties": { + "readme": { + "description": "The README of the file stored in catalog", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "readme" + ], + "type": "object" + }, + "v14CatalogRemove": { + "description": "Allows a user to remove a specific sha256 artifact and all related metadata. If the file is needed again in the future it will need to be re-imported.", + "properties": { + "hash": { + "description": "The sha256 hash of the file stored in catalog", + "maxLength": 128, + "minLength": 3, + "type": "string" + } + }, + "required": [ + "hash" + ], + "type": "object" + }, + "v14CatalogVerify": { + "description": "Verification of the signatures of any specified file, a specific artifact in the catalog, or all artifacts in the catalog.", + "properties": { + "artifacts": { + "description": "List of verified packages", + "items": { + "$ref": "#/definitions/v14CatalogVerifyArtifact" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14CatalogVerifyArtifact": { + "description": "Verification of the signatures of any specified file, a specific artifact in the catalog, or all artifacts in the catalog.", + "properties": { + "artifact": { + "description": "File or Hash", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "verified": { + "description": "Verification of valid signature", + "type": "boolean" + } + }, + "type": "object" + }, + "v14ClusterAc": { + "description": "Cluster ACS resume.", + "properties": { + "exclude_sn": { + "description": "List of the node serial number.", + "items": { + "description": "Serial number of a node.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_sn": { + "description": "List of the node serial number.", + "items": { + "description": "Serial number of a node.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14ClusterAcs": { + "description": "Cluster ACS status.", + "properties": { + "failed_nodes_sn": { + "description": "list of failed nodes serial number.", + "items": { + "description": "Serial number of a node.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "joined_nodes": { + "description": "the number of joined nodes.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "license_status": { + "description": "the status of license activation.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "srs_status": { + "description": "the status of SRS enablement.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "total_nodes": { + "description": "total nodes number of the cluster.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "unresponsive_sn": { + "description": "list of unresponsive nodes serial number.", + "items": { + "description": "Serial number of a node.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14ClusterModeSettings": { + "description": " To GET/SET URLs for Monitoring, Support and Cloud Storage console", + "properties": { + "cloud_storage_console": { + "description": "URL for cloud storage console", + "maxLength": 2048, + "minLength": 11, + "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)[a-z0-9]+([-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/[^ ]*)?$|^((http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\:[0-9]{0,4})?(\\/[a-zA-Z0-9_]*)?$", + "type": "string" + }, + "monitoring": { + "description": "URL for monitoring", + "maxLength": 2048, + "minLength": 11, + "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)[a-z0-9]+([-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/[^ ]*)?$|^((http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\:[0-9]{0,4})?(\\/[a-zA-Z0-9_]*)?$", + "type": "string" + }, + "staas_mode_enabled": { + "description": "Gives STaaS mode status", + "type": "boolean" + }, + "support": { + "description": "URL for support", + "maxLength": 2048, + "minLength": 11, + "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)[a-z0-9]+([-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/[^ ]*)?$|^((http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\:[0-9]{0,4})?(\\/[a-zA-Z0-9_]*)?$", + "type": "string" + } + }, + "type": "object" + }, + "v14ClusterModeSettingsExtended": { + "description": " To GET/SET URLs for Monitoring, Support and Cloud Storage console", + "properties": { + "cloud_storage_console": { + "description": "URL for cloud storage console", + "maxLength": 2048, + "minLength": 11, + "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)[a-z0-9]+([-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/[^ ]*)?$|^((http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\:[0-9]{0,4})?(\\/[a-zA-Z0-9_]*)?$", + "type": "string" + }, + "monitoring": { + "description": "URL for monitoring", + "maxLength": 2048, + "minLength": 11, + "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)[a-z0-9]+([-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/[^ ]*)?$|^((http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\:[0-9]{0,4})?(\\/[a-zA-Z0-9_]*)?$", + "type": "string" + }, + "support": { + "description": "URL for support", + "maxLength": 2048, + "minLength": 11, + "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)[a-z0-9]+([-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/[^ ]*)?$|^((http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\:[0-9]{0,4})?(\\/[a-zA-Z0-9_]*)?$", + "type": "string" + } + }, + "type": "object" + }, + "v14ClusterNode": { + "description": "Node information.", + "properties": { + "drive_d_config": { + "$ref": "#/definitions/v14ClusterNodeDriveDConfig" + }, + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "hardware": { + "$ref": "#/definitions/v12ClusterNodeHardware" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "internal_ip_address": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "$ref": "#/definitions/v10ClusterNodePartitions" + }, + "sensors": { + "$ref": "#/definitions/v10ClusterNodeSensors" + }, + "sleds": { + "description": "List of the sleds in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSled" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "state": { + "$ref": "#/definitions/v12ClusterNodeState" + }, + "status": { + "$ref": "#/definitions/v12ClusterNodeStatus" + } + }, + "required": [ + "internal_ip_address" + ], + "type": "object" + }, + "v14ClusterNodeDriveDConfig": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "alert": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAlert" + }, + "allow": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAllow" + }, + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "instant_secure_erase": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigInstantSecureErase" + }, + "log": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigLog" + }, + "reboot": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigReboot" + }, + "spin_wait": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigSpinWait" + }, + "stall": { + "$ref": "#/definitions/v14ClusterNodeDriveDConfigStall" + } + }, + "type": "object" + }, + "v14ClusterNodeDriveDConfigStall": { + "description": "Configuration settings to evaluate a drive stall.", + "properties": { + "clear_time": { + "default": 2592000, + "description": "The amount of time in seconds with no stalls before ignoring previous stalls.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "diskscrub_stripes": { + "default": 128, + "description": "Number of stripes to read during a diskscrub.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_error_frequency": { + "default": 0, + "description": "The number of errors during stalled drive disk exercises to cause the drive to be softfailed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_slow_access": { + "default": 0, + "description": "The number of slow accesses during stalled drive disk exercises to cause the drive to be softfailed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_slow_frequency": { + "default": 0, + "description": "The number of slow frequency triggers during stalled drive disk exercises to cause the drive to be softfailed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_total_stall_time": { + "default": 10800, + "description": "The maximum amount of time, in seconds, to remain stalled before softfailing the drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_total_stall_time_without_error": { + "default": 108000, + "description": "Max amount of time to spend in stalled before softfailing the drive even without new errors.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "scan_max_ecc_delay": { + "default": 60, + "description": "Maximum delay in seconds after an ECC correction during a scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "scan_size": { + "default": 16777216, + "description": "Total bytes of error-free reads to complete a scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sleep": { + "default": 30, + "description": "Delay in seconds between evaluations.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14ClusterNodes": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v14ClusterNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14EventSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v14EventSettingsSettings" + } + }, + "type": "object" + }, + "v14EventSettingsSettings": { + "description": "Settings for CELOG system.", + "properties": { + "heartbeat_interval": { + "description": "Interval between heartbeat events. \"daily\", \"weekly\", or \"monthly\".", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "retention_days": { + "description": "Retention period in days.", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" + }, + "storage_limit": { + "description": "Storage limit in megabytes per terabyte of available storage.", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v14InternalNetworksPreferredNetwork": { + "description": "A string to represent the backend preferred network.", + "properties": { + "high_lnn": { + "description": "Low-numbered LNN of node pair", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "low_lnn": { + "description": "Low-numbered LNN of node pair", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "preferred_network": { + "description": "Backend network fabric primary network int-a and secondary network int-b", + "enum": [ + "int-a", + "int-b" + ], + "type": "string" + } + }, + "required": [ + "low_lnn", + "high_lnn", + "preferred_network" + ], + "type": "object" + }, + "v14InternalNetworksSettings": { + "description": "Cluster internal network related configuration properties", + "properties": { + "internal_networks_settings": { + "$ref": "#/definitions/v14InternalNetworksSettingsInternalNetworksSettings" + } + }, + "type": "object" + }, + "v14InternalNetworksSettingsExtended": { + "description": "Represents configuration properties to apply per backend network", + "properties": { + "network": { + "$ref": "#/definitions/v14InternalNetworksSettingsNetwork" + } + }, + "required": [ + "network" + ], + "type": "object" + }, + "v14InternalNetworksSettingsInternalNetworksSettings": { + "additionalProperties": false, + "properties": { + "network": { + "items": { + "$ref": "#/definitions/v14InternalNetworksSettingsInternalNetworksSettingsNetworkItem" + }, + "maxItems": 2, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v14InternalNetworksSettingsInternalNetworksSettingsNetworkItem": { + "description": "Represents configuraton properties per backend network", + "properties": { + "backend_config": { + "$ref": "#/definitions/v14InternalNetworksSettingsInternalNetworksSettingsNetworkItemBackendConfig" + }, + "name": { + "description": "Name of the backend network.", + "enum": [ + "int-a", + "int-b", + "all" + ], + "type": "string" + } + }, + "required": [ + "backend_config", + "name" + ], + "type": "object" + }, + "v14InternalNetworksSettingsInternalNetworksSettingsNetworkItemBackendConfig": { + "description": "Represents a list of configuration properties related to backend fabric.", + "properties": { + "fabric_monitoring": { + "description": "Represents if backend fabric monitoring is enabled or disabled.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string" + }, + "shared_backend": { + "description": "Represents if backend network is shared among multiple OneFS clusters.", + "type": "boolean" + } + }, + "required": [ + "fabric_monitoring" + ], + "type": "object" + }, + "v14InternalNetworksSettingsNetwork": { + "description": "Represents configuraton properties per backend network", + "properties": { + "backend_config": { + "$ref": "#/definitions/v14InternalNetworksSettingsNetworkBackendConfig" + }, + "name": { + "description": "Name of the backend network.", + "enum": [ + "int-a", + "int-b", + "all" + ], + "type": "string" + } + }, + "required": [ + "backend_config", + "name" + ], + "type": "object" + }, + "v14InternalNetworksSettingsNetworkBackendConfig": { + "description": "Represents a list of configuration properties related to backend fabric.", + "properties": { + "fabric_monitoring": { + "description": "Represents if backend fabric monitoring is enabled or disabled.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string" + } + }, + "required": [ + "fabric_monitoring" + ], + "type": "object" + }, + "v14NetworkInterface": { + "properties": { + "flags": { + "description": "List of interface flags", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Id is a concatenation of lnn and name in the format 'lnn:name' e.g. 3:ext-2.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ip_addrs": { + "description": "List of IP addresses", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ipv4_gateway": { + "description": "Address of the default IPv4 gateway", + "maxLength": 16, + "minLength": 1, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "ipv6_gateway": { + "description": "Address of the default IPv6 gateway", + "maxLength": 40, + "minLength": 1, + "pattern": "^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "The mtu the interface.", + "maximum": 9000, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the interface.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "nic_name": { + "description": "NIC name", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "owners": { + "description": "List of owners (membership)", + "items": { + "$ref": "#/definitions/v12NetworkInterfaceOwner" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "speed": { + "description": "The negotiated speed of the interface, in Mbps.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "Status of the interface", + "enum": [ + "up", + "no_carrier", + "active", + "inactive", + "disabled", + "unknown" + ], + "type": "string" + }, + "type": { + "description": "The type of network interface", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "vlans": { + "description": "List of VLANs", + "items": { + "$ref": "#/definitions/v12NetworkInterfaceVlan" + }, + "maxItems": 4094, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "status", + "ipv4_gateway", + "name", + "type", + "owners", + "mtu", + "nic_name", + "ip_addrs", + "lnn", + "flags", + "ipv6_gateway", + "vlans", + "speed", + "id" + ], + "type": "object" + }, + "v14NetworkInterfaces": { + "additionalProperties": false, + "properties": { + "errors": { + "description": "A list of errors encountered by the individual nodes involved in this request, or null if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "interfaces": { + "items": { + "$ref": "#/definitions/v14NetworkInterface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14NfsSettingsGlobal": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v14NfsSettingsGlobalSettings" + } + }, + "type": "object" + }, + "v14NfsSettingsGlobalSettings": { + "description": "Specifies the global NFS configuration settings.", + "properties": { + "nfsv3_enabled": { + "description": "True if NFSv3 is enabled.", + "type": "boolean" + }, + "nfsv3_rdma_enabled": { + "description": "True if the RDMA is enabled for NFSv3.", + "type": "boolean" + }, + "nfsv40_enabled": { + "description": "Enable/disable minor version 0 of NFSv4 protocol.", + "type": "boolean" + }, + "nfsv41_enabled": { + "description": "Enable/disable minor version 1 of NFSv4 protocol.", + "type": "boolean" + }, + "nfsv42_enabled": { + "description": "Enable/disable minor version 2 of NFSv4 protocol.", + "type": "boolean" + }, + "nfsv4_enabled": { + "description": "Enable/disable all minor versions of NFSv4 protocol.", + "type": "boolean" + }, + "rpc_maxthreads": { + "description": "Specifies the maximum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "rpc_minthreads": { + "description": "Specifies the minimum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "rquota_enabled": { + "description": "True if the rquota protocol is enabled.", + "type": "boolean" + }, + "service": { + "description": "True if the NFS service is enabled. When set to false, the NFS service is disabled.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_GLOBAL" + }, + "v14NodeDriveconfig": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v14NodeDriveconfigNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14NodeDriveconfigExtended": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "instant_secure_erase": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigInstantSecureErase" + }, + "stall": { + "$ref": "#/definitions/v14NodeDriveconfigStall" + } + }, + "type": "object" + }, + "v14NodeDriveconfigNode": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "alert": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAlert" + }, + "allow": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAllow" + }, + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "instant_secure_erase": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigInstantSecureErase" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "log": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigLog" + }, + "reboot": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigReboot" + }, + "spin_wait": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigSpinWait" + }, + "stall": { + "$ref": "#/definitions/v14ClusterNodeDriveDConfigStall" + } + }, + "type": "object" + }, + "v14NodeDriveconfigStall": { + "description": "Configuration settings to evaluate a drive stall.", + "properties": { + "max_total_stall_time_without_error": { + "default": 108000, + "description": "Max amount of time to spend in stalled before softfailing the drive even without new errors.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14PapiSettings": { + "additionalProperties": false, + "properties": { + "papi_settings": { + "$ref": "#/definitions/v14PapiSettingsPapiSettings" + } + }, + "required": [ + "papi_settings" + ], + "type": "object" + }, + "v14PapiSettingsPapiSettings": { + "properties": { + "auto_configure_child_limit": { + "default": "true", + "description": "If true, PAPI automatically configures the child limit.", + "type": "boolean" + }, + "child_settings": { + "$ref": "#/definitions/v14PapiSettingsPapiSettingsChildSettings" + } + }, + "type": "object" + }, + "v14PapiSettingsPapiSettingsChildSettings": { + "description": "This schema describes various values related to PAPI children.", + "properties": { + "child_limit": { + "description": "The number of PAPI requests that can be processed concurrently.", + "maximum": 65535, + "minimum": 2, + "type": "integer" + }, + "child_limit_ceiling": { + "description": "Max value of child_limit that can be controlled.", + "maximum": 65535, + "minimum": 2, + "type": "integer" + }, + "child_limit_extension": { + "description": "Extends the child limit for serving the URIs.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "child_limit_floor": { + "description": "Min value of child_limit that can be controlled.", + "maximum": 65535, + "minimum": 2, + "type": "integer" + } + }, + "type": "object" + }, + "v14ProvidersAds": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v14ProvidersAdsAdsItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14ProvidersAdsAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "dup_spns": { + "description": "Get duplicate SPNs in the provider domain", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "extra_expected_spns": { + "description": "List of additional SPNs to expect beyond what automatic checking routines might find", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "forest": { + "description": "Specifies the Active Directory forest.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname": { + "description": "Specifies the fully qualified hostname stored in the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "instance": { + "description": "Specifies Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_account": { + "description": "Specifies the machine account name when creating a SAM account with Active Directory.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "netbios_domain": { + "description": "Specifies the NetBIOS domain name associated with the machine account.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "primary_domain": { + "description": "Specifies the AD domain to which the provider is joined.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "rpc_call_timeout": { + "description": "The maximum amount of time (in seconds) an RPC call to Active Directory is allowed to take.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "server_retry_limit": { + "description": "The number of retries attempted when a call to Active Directory fails due to network error.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "site": { + "description": "Specifies the site for the Active Directory.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "system": { + "description": "If set to true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v14ProvidersAdsAdsItemExtended": { + "allOf": [ + { + "$ref": "#/definitions/v14ProvidersAdsAdsItem" + }, + { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "recommended_spns": { + "description": "Configuration recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "spns": { + "description": "Currently configured SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "v14ProvidersAdsExtended": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v14ProvidersAdsAdsItemExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14ProvidersAdsIdParams": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_controller": { + "description": "Specifies the domain controller to which the authentication service should send requests", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "extra_expected_spns": { + "description": "List of additional SPNs to expect beyond what automatic checking routines might find", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "password": { + "description": "Specifies the password used during domain join.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "reset_schannel": { + "description": "Resets the secure channel to the primary domain.", + "type": "boolean" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "rpc_call_timeout": { + "description": "The maximum amount of time (in seconds) an RPC call to Active Directory is allowed to take.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "server_retry_limit": { + "description": "The number of retries attempted when a call to Active Directory fails due to network error.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "spns": { + "description": "Currently configured SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "description": "Specifies the user name that has permission to join a machine to the given domain.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v14ProvidersAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "dns_domain": { + "description": "Specifies the DNS search domain. Set this parameter if the DNS search domain has a unique name or address.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "extra_expected_spns": { + "description": "List of additional SPNs to expect beyond what automatic checking routines might find", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "instance": { + "description": "Specifies Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "kerberos_hdfs_spn": { + "description": "Determines if connecting through HDFS with Kerberos.", + "type": "boolean" + }, + "kerberos_nfs_spn": { + "description": "Determines if connecting through NFS with Kerberos.", + "type": "boolean" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_account": { + "description": "Specifies the machine account name when creating a SAM account with Active Directory.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "organizational_unit": { + "description": "Specifies the organizational unit.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the password used during domain join.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "rpc_call_timeout": { + "description": "The maximum amount of time (in seconds) an RPC call to Active Directory is allowed to take.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "server_retry_limit": { + "description": "The number of retries attempted when a call to Active Directory fails due to network error.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "description": "Specifies the user name that has permission to join a machine to the given domain.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "user", + "password", + "name" + ], + "type": "object" + }, + "v14RolePrivileges": { + "additionalProperties": false, + "properties": { + "privileges": { + "items": { + "$ref": "#/definitions/v14AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14SessionsInvalidation": { + "description": "Specifies properties for a user Platform API session invalidation.", + "properties": { + "expiration": { + "description": "The time in seconds since the UNIX epoc when this invalidation expires.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "Specifies the serialized form of the user persona, which can be 'UID:0', 'USER:name' or 'SID:S-1-1'.", + "maxLength": 261, + "minLength": 0, + "type": "string" + }, + "not_before": { + "description": "The time in seconds since the UNIX epoch, before which sessions for a user are disallowed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v14SessionsInvalidationExtended": { + "description": "Specifies properties for a user Platform API session invalidation.", + "properties": { + "id": { + "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", + "maxLength": 261, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the persona name, which must be combined with a type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "not_before": { + "description": "The time since the UNIX epoch to not allow sessions for a user.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "Specifies the type of persona, which must be combined with a name.", + "enum": [ + "user", + "group", + "wellknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v14SessionsInvalidationExtendedExtended": { + "description": "Specifies properties for a user Platform API session invalidation.", + "properties": { + "expiration": { + "description": "The time in seconds since the UNIX epoc when this invalidation expires.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "not_before": { + "description": "The time in seconds since the UNIX epoch, before which sessions for a user are disallowed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14SessionsInvalidations": { + "additionalProperties": false, + "properties": { + "invalidations": { + "items": { + "$ref": "#/definitions/v14SessionsInvalidationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14SettingsSessions": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v14SettingsSessionsSettings" + } + }, + "type": "object" + }, + "v14SettingsSessionsSettings": { + "description": "Settings for Platform API sessions.", + "properties": { + "key_rotation": { + "description": "The amount of time in seconds before rotating the session signing key with a new key.", + "maximum": 2147483646, + "minimum": 300, + "type": "integer" + } + }, + "type": "object" + }, + "v14SnapshotWritable": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "writable": { + "items": { + "$ref": "#/definitions/Createv14SnapshotWritableItemResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14SnapshotWritableExtended": { + "additionalProperties": false, + "properties": { + "writable": { + "items": { + "$ref": "#/definitions/Createv14SnapshotWritableItemResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14SnapshotWritableItem": { + "properties": { + "dst_path": { + "description": "The user supplied /ifs path of writable snapshot.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "src_snap": { + "description": "The user supplied source snapshot name or ID. This will be null for writable snapshots pending delete.", + "minLength": 0, + "type": "string" + } + }, + "required": [ + "dst_path", + "src_snap" + ], + "type": "object" + }, + "v14SnapshotWritableSnapshotSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v14SnapshotWritableSnapshotSummarySummary" + } + }, + "type": "object" + }, + "v14SnapshotWritableSnapshotSummarySummary": { + "properties": { + "active_count": { + "description": "Total number of active writable snapshots.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "active_phys_size": { + "description": "Sum of storage in bytes used by active writable snapshots.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "count": { + "description": "Total number of writable snapshots.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "deleting_count": { + "description": "Total number of delete-pending writable snapshots.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "deleting_phys_size": { + "description": "Sum of storage in bytes used by delete-pending writable snapshots.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size": { + "description": "Sum of storage in bytes used by all writable snapshots.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14SummaryCloud": { + "additionalProperties": false, + "properties": { + "cloud": { + "items": { + "$ref": "#/definitions/v14SummaryCloudCloudItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14SummaryCloudCloudItem": { + "description": "Cloudpools account and policy statistics.", + "properties": { + "account": { + "description": "Account name", + "maxLength": 768, + "minLength": 1, + "type": "string" + }, + "account_key": { + "description": "Key for account", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "cloud": { + "description": "Name of cloud provider", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "deletes": { + "description": "Number of delete operations", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "guid": { + "description": "Cluster GUID", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "in": { + "description": "Number of bytes in", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "node": { + "description": "The node this data came from", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "out": { + "description": "Number of bytes out", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "policy": { + "description": "Policy name", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "policy_id": { + "description": "Id of the policy", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "reads": { + "description": "Number of read operations", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "time": { + "description": "Timestamp", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "writes": { + "description": "Number of write operations", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14SyncPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v14SyncPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v14SyncPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v14SyncPolicyExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v14SyncPolicy": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sync_existing_snapshot_expiration": { + "description": "If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true", + "type": "boolean" + }, + "sync_existing_target_snapshot_pattern": { + "description": "The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "target_host", + "name", + "target_path", + "action" + ], + "type": "object" + }, + "v14SyncPolicyExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "database_mirrored": { + "description": "If true, SyncIQ databases have been mirrored.", + "type": "boolean" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_set": { + "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET.", + "type": "boolean" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_certificate_id": { + "description": "The ID of the source cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_domain_marked": { + "description": "If true, the source root path has been domain marked with a SyncIQ domain.", + "type": "boolean" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sync_existing_snapshot_expiration": { + "description": "If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true", + "type": "boolean" + }, + "sync_existing_target_snapshot_pattern": { + "description": "The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "encrypted", + "database_mirrored", + "last_success", + "source_domain_marked", + "id", + "target_host", + "source_certificate_id", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v14SyncPolicyExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "enum": [ + false + ], + "type": "boolean" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sync_existing_snapshot_expiration": { + "description": "If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true", + "type": "boolean" + }, + "sync_existing_target_snapshot_pattern": { + "description": "The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v14SyncPolicyExtendedExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "database_mirrored": { + "description": "If true, SyncIQ databases have been mirrored.", + "type": "boolean" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_set": { + "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET.", + "type": "boolean" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_certificate_id": { + "description": "The ID of the source cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_domain_marked": { + "description": "If true, the source root path has been domain marked with a SyncIQ domain.", + "type": "boolean" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sync_existing_snapshot_expiration": { + "description": "If set to true, the expire duration for target archival snapshot is the remaining expire duration of source snapshot, requires --sync-existing-snapshot=true", + "type": "boolean" + }, + "sync_existing_target_snapshot_pattern": { + "description": "The naming pattern for snapshot on the destination cluster when --sync-existing-snapshot is true", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "last_success", + "id", + "target_host", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v14SyncSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v14SyncSettingsSettings" + } + }, + "type": "object" + }, + "v14SyncSettingsExtended": { + "description": "Global SyncIQ settings.", + "properties": { + "bandwidth_reservation_reserve_absolute": { + "description": "The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidth_reservation_reserve_percentage.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bandwidth_reservation_reserve_percentage": { + "description": "The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.", + "maximum": 99, + "minimum": 1, + "type": "integer" + }, + "cluster_certificate_id": { + "description": "The ID of this cluster's certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_CLUSTER_CERTIFICATE_ID" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "encryption_required": { + "description": "If true, requires all SyncIQ policies to utilize encrypted communications.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_ENCRYPTION_REQUIRED" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "preferred_rpo_alert": { + "description": "If specified, display as default RPO Alert value for new policy creation via WebUI", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_PREFERRED_RPO_ALERT" + }, + "renegotiation_period": { + "description": "If specified, the duration to persist encrypted connection before forcing a renegotiation.", + "maximum": 2147483646, + "minimum": 60, + "type": "integer" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "rpo_alerts": { + "description": "If disabled, no RPO alerts will be generated.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_RPO_ALERTS" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "use_workers_per_node": { + "description": "If enabled, SyncIQ will use the deprecated workers_per_node field with worker pools functionality and limit workers accordingly.", + "type": "boolean" + } + }, + "type": "object" + }, + "v14SyncSettingsSettings": { + "description": "Global SyncIQ settings.", + "properties": { + "bandwidth_reservation_reserve_absolute": { + "description": "The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidth_reservation_reserve_percentage.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bandwidth_reservation_reserve_percentage": { + "description": "The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.", + "maximum": 99, + "minimum": 1, + "type": "integer" + }, + "cluster_certificate_id": { + "description": "The ID of this cluster's certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_CLUSTER_CERTIFICATE_ID" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "encryption_required": { + "description": "If true, requires all SyncIQ policies to utilize encrypted communications.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_ENCRYPTION_REQUIRED" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "max_concurrent_jobs": { + "description": "The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.", + "maximum": 1000, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "preferred_rpo_alert": { + "description": "If specified, display as default RPO Alert value for new policy creation via WebUI", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_PREFERRED_RPO_ALERT" + }, + "renegotiation_period": { + "description": "If specified, the duration to persist encrypted connection before forcing a renegotiation.", + "maximum": 2147483646, + "minimum": 60, + "type": "integer" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "rpo_alerts": { + "description": "If disabled, no RPO alerts will be generated.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_RPO_ALERTS" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "use_workers_per_node": { + "description": "If enabled, SyncIQ will use the deprecated workers_per_node field with worker pools functionality and limit workers accordingly.", + "type": "boolean" + } + }, + "type": "object" + }, + "v15CertificatesCaIdParams": { + "properties": { + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v15CertificatesCaItem": { + "properties": { + "certificate_path": { + "description": "Local path to the certificate that is to be imported.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Administrator specified name identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + } + }, + "required": [ + "certificate_path", + "name" + ], + "type": "object" + }, + "v15CertificatesIdentityItem": { + "properties": { + "certificate_key_password": { + "description": "Optional private key password. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "certificate_key_path": { + "description": "Local path to the certificate key that is to be imported.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "certificate_path": { + "description": "Local path to the certificate that is to be imported.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Administrator specified name identifier.", + "maxLength": 128, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + } + }, + "required": [ + "certificate_path", + "name" + ], + "type": "object" + }, + "v15CheckReport": { + "additionalProperties": false, + "properties": { + "report": { + "items": { + "$ref": "#/definitions/v15CheckReportReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15CheckReportReportItem": { + "description": "Specifies the report for failures in the last run of the security checks.", + "properties": { + "category": { + "description": "Specifies the category of the failed security check.", + "enum": [ + "HEALTHCHECK", + "PERIODIC", + "STIG" + ], + "type": "string" + }, + "check_failed": { + "description": "Specifies the name of the failed security check.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "reason": { + "description": "Specifies the reason due to which the security check has failed.", + "maxLength": 8192, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15CheckSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v15CheckSettingsSettings" + } + }, + "type": "object" + }, + "v15CheckSettingsSettings": { + "additionalProperties": false, + "description": "This schema defines security check settings.", + "properties": { + "action": { + "description": "Action to be taken on encountering security anomalies", + "enum": [ + "celog", + "reboot", + "shutdown" + ], + "type": "string" + }, + "stig_path": { + "description": "Security Hardening file path", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v15ClusterNode": { + "description": "Node information.", + "properties": { + "drive_d_config": { + "$ref": "#/definitions/v14ClusterNodeDriveDConfig" + }, + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v15ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "hardware": { + "$ref": "#/definitions/v12ClusterNodeHardware" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "internal_ip_address": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "$ref": "#/definitions/v10ClusterNodePartitions" + }, + "sensors": { + "$ref": "#/definitions/v10ClusterNodeSensors" + }, + "sleds": { + "description": "List of the sleds in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSled" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "state": { + "$ref": "#/definitions/v12ClusterNodeState" + }, + "status": { + "$ref": "#/definitions/v12ClusterNodeStatus" + } + }, + "required": [ + "internal_ip_address" + ], + "type": "object" + }, + "v15ClusterNodeDrive": { + "description": "Drive information.", + "properties": { + "bay_group": { + "description": "The name of the bay group this drive belongs to.", + "maxLength": 2147483646, + "minLength": 0, + "type": "string" + }, + "baynum": { + "description": "Numerical representation of this drive's bay.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "blocks": { + "description": "Number of blocks on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "chassis": { + "description": "The chassis number which contains this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "devname": { + "description": "This drive's device name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "firmware": { + "$ref": "#/definitions/v10ClusterNodeDriveFirmware" + }, + "format_progress": { + "description": "Drive format progress percentage.", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "handle": { + "description": "Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "interface_type": { + "description": "String representation of this drive's interface type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnum": { + "description": "This drive's logical drive number in IFS.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "locnstr": { + "description": "String representation of this drive's physical location.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logical_block_length": { + "description": "Size of a logical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "media_class": { + "description": "String representation of this drive's media class.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "media_type": { + "description": "String representation of this drive's media type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "This drive's manufacturer and model.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "pending_actions": { + "description": "This drive's current outstanding actions. For example, \"add\" or \"firmware_update\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "physical_block_length": { + "description": "Size of a physical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "present": { + "description": "Indicates whether this drive is physically present in the node.", + "type": "boolean" + }, + "purpose": { + "description": "This drive's purpose in the DRV state machine.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "purpose_description": { + "description": "Description of this drive's purpose.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "serial": { + "description": "Serial number for this drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ui_state": { + "description": "This drive's state as presented to the UI.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "wwn": { + "description": "The drive's 'worldwide name' from its NAA identifiers.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "x_loc": { + "description": "This drive's x-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "y_loc": { + "description": "This drive's y-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15ClusterNodes": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v15ClusterNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15ClusterServices": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v15ClusterServicesNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15ClusterServicesNode": { + "description": "Services info of the cluster.", + "properties": { + "devid": { + "description": "Device ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "services": { + "description": "List of the services on the node.", + "items": { + "$ref": "#/definitions/v15ClusterServicesNodeService" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "devid" + ], + "type": "object" + }, + "v15ClusterServicesNodeService": { + "description": "The status of a service", + "properties": { + "name": { + "description": "Service name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "state": { + "description": "Service state.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverAccount": { + "additionalProperties": false, + "properties": { + "account_type": { + "description": "Type of the data storage account", + "enum": [ + "DM", + "AWS_S3", + "ECS_S3", + "AZURE" + ], + "type": "string" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/v15DatamoverAccountCredentials" + }, + "local_network_pool": { + "description": "Local platform-specific network restriction", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Name for this Data Mover account", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "remote_network_pool": { + "description": "Remote platform-specific network restriction", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "uri": { + "description": "A valid URI pointing to the data storage", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "account_type", + "uri", + "name" + ], + "type": "object" + }, + "v15DatamoverAccountCredentials": { + "additionalProperties": false, + "properties": { + "auth_mode": { + "description": "The authentication mode for this account", + "enum": [ + "CLOUD", + "CERTIFICATE" + ], + "type": "string" + }, + "certificate": { + "$ref": "#/definitions/v15DatamoverAccountCredentialsCertificate" + }, + "cloud": { + "$ref": "#/definitions/v15DatamoverAccountCredentialsCloud" + } + }, + "required": [ + "auth_mode" + ], + "type": "object" + }, + "v15DatamoverAccountCredentialsCertificate": { + "additionalProperties": false, + "description": "Certificate-based authentication credentials", + "properties": { + "ca_certificate_id": { + "description": "Unique CA certificate identifier.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "client_certificate_id": { + "description": "Unique client certificate identifier.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "enable_encryption": { + "description": "Whether to enable encryption over the communication channel", + "type": "boolean" + } + }, + "type": "object" + }, + "v15DatamoverAccountCredentialsCertificateExtended": { + "additionalProperties": false, + "description": "Certificate-based authentication credentials", + "properties": { + "ca_certificate_id": { + "description": "Unique CA certificate identifier.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "client_certificate_id": { + "description": "Unique client certificate identifier.", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "enable_encryption": { + "description": "Whether to enable encryption over the communication channel", + "type": "boolean" + } + }, + "type": "object" + }, + "v15DatamoverAccountCredentialsCloud": { + "additionalProperties": false, + "description": "Cloud authentication credentials", + "properties": { + "access_id": { + "description": "Access ID", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "proxy": { + "$ref": "#/definitions/v15DatamoverAccountCredentialsCloudProxy" + }, + "secret_key": { + "description": "Secret key", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverAccountCredentialsCloudExtended": { + "additionalProperties": false, + "description": "Cloud authentication credentials", + "properties": { + "access_id": { + "description": "Access ID", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "proxy": { + "$ref": "#/definitions/v15DatamoverAccountCredentialsCloudProxyExtended" + } + }, + "type": "object" + }, + "v15DatamoverAccountCredentialsCloudProxy": { + "additionalProperties": false, + "description": "Proxy information for connection to cloud accounts", + "properties": { + "proxy_password": { + "description": "Proxy password", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "proxy_port": { + "description": "Proxy port", + "maximum": 65535, + "minimum": 1024, + "type": "integer" + }, + "proxy_type": { + "description": "Proxy type", + "enum": [ + "SOCKS_4", + "SOCKS_5", + "HTTP" + ], + "type": "string" + }, + "proxy_uri": { + "description": "Proxy uri", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "proxy_username": { + "description": "Proxy username", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverAccountCredentialsCloudProxyExtended": { + "additionalProperties": false, + "description": "Proxy information for connection to cloud accounts", + "properties": { + "proxy_port": { + "description": "Proxy port", + "maximum": 65535, + "minimum": 1024, + "type": "integer" + }, + "proxy_type": { + "description": "Proxy type", + "enum": [ + "SOCKS_4", + "SOCKS_5", + "HTTP" + ], + "type": "string" + }, + "proxy_uri": { + "description": "Proxy uri", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "proxy_username": { + "description": "Proxy username", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverAccountCredentialsExtended": { + "additionalProperties": false, + "properties": { + "auth_mode": { + "description": "The authentication mode for this account", + "enum": [ + "CLOUD", + "CERTIFICATE" + ], + "type": "string" + }, + "certificate": { + "$ref": "#/definitions/v15DatamoverAccountCredentialsCertificateExtended" + }, + "cloud": { + "$ref": "#/definitions/v15DatamoverAccountCredentialsCloudExtended" + } + }, + "required": [ + "auth_mode" + ], + "type": "object" + }, + "v15DatamoverAccountExtended": { + "additionalProperties": false, + "properties": { + "account_type": { + "description": "Type of the data storage account", + "enum": [ + "DM", + "AWS_S3", + "ECS_S3", + "AZURE" + ], + "type": "string" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/v15DatamoverAccountCredentialsExtended" + }, + "id": { + "description": "Unique account ID", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "local_network_pool": { + "description": "Local platform-specific network restriction", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Name for this Data Mover account", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "remote_network_pool": { + "description": "Remote platform-specific network restriction", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uri": { + "description": "A valid URI pointing to the data storage", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "version": { + "description": "Version number of the config store when this object was edited.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v15DatamoverAccountExtendedExtended": { + "additionalProperties": false, + "properties": { + "account_type": { + "description": "Type of the data storage account", + "enum": [ + "DM", + "AWS_S3", + "ECS_S3", + "AZURE" + ], + "type": "string" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "credentials": { + "$ref": "#/definitions/v15DatamoverAccountCredentials" + }, + "local_network_pool": { + "description": "Local platform-specific network restriction", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Name for this Data Mover account", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "remote_network_pool": { + "description": "Remote platform-specific network restriction", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "uri": { + "description": "A valid URI pointing to the data storage", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "version": { + "description": "Version number of the config store when this object was edited.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverAccounts": { + "additionalProperties": false, + "properties": { + "accounts": { + "items": { + "$ref": "#/definitions/v15DatamoverAccountExtended" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverAccountsExtended": { + "additionalProperties": false, + "properties": { + "accounts": { + "items": { + "$ref": "#/definitions/v15DatamoverAccountExtended" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15DatamoverBasePolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v15DatamoverBasePoliciesPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverBasePoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v15DatamoverBasePoliciesPolicy" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15DatamoverBasePoliciesPolicy": { + "additionalProperties": false, + "properties": { + "base_account_id": { + "description": "Account ID (local or remote DM system) where the policy should be created.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "True: policy is enabled, False: otherwise.", + "type": "boolean" + }, + "id": { + "description": "The unique policy identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "A user provided base policy name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "new_tasks_account": { + "description": "Account of the system to create tasks on. This overrides the default task affinity.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "override_list": { + "description": "The list of fields which will override a concrete policy.", + "items": { + "enum": [ + "ENABLED", + "PRIORITY", + "SCHEDULE", + "BRIEFCASE", + "SOURCE_ACCOUNT_ID", + "TARGET_ACCOUNT_ID", + "BASE_ACCOUNT_ID", + "TASK_ACCOUNT_ID", + "SUBPATHS", + "SOURCE_BASE_PATH", + "TARGET_BASE_PATH", + "SRC_DATASET_RETENTION", + "TGT_DATASET_RETENTION" + ], + "type": "string" + }, + "maxItems": 14, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "priority": { + "description": "The relative priority of the policy.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "schedule": { + "$ref": "#/definitions/v15DatamoverBasePoliciesPolicySchedule" + }, + "source_account_id": { + "description": "Account ID of the source data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_base_path": { + "description": "Filesystem base path on source DM system which has the directories/files for which dataset has to be created.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "src_dataset_retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "target_account_id": { + "description": "Account ID of the target data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Filesystem base path on target DM syestem which has the directories/files for which dataset has to be created.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "tgt_dataset_retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "version": { + "description": "Version number of the config store when this object was edited.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "enabled", + "priority", + "name" + ], + "type": "object" + }, + "v15DatamoverBasePoliciesPolicySchedule": { + "description": "The schedule of the policy- start time, recurrence, specific date-times.", + "properties": { + "date_times": { + "description": "The specific date/times at which this policy should run regardless of the start_time and recurrence.", + "items": { + "description": "The time in '%Y-%m-%d %H:%M:%S' format. The year range is 2001-2099.", + "maxLength": 19, + "minLength": 14, + "pattern": "20[0-9][0-9]-1[0-2]|[1-9]-3[01]|[12][0-9]|0?[1-9] 2[0-3]|1[0-9]|0?[0-9]:[0-5]?[0-9]:[0-5]?[0-9]", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "recurrence": { + "description": "The cron expression to represent a repetitive schedule for the policy w.r.t. start_time.", + "items": { + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "start_time": { + "description": "The date/time of the first run of the policy. It should be in 'yyyy-mm-dd hh:mn:ss' format, where year range is 2001-2099.", + "maxLength": 19, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverBasePolicy": { + "additionalProperties": false, + "properties": { + "base_account_id": { + "description": "Account ID (local or remote DM system) where the policy should be created.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "True: policy is enabled, False: otherwise.", + "type": "boolean" + }, + "id": { + "description": "The unique policy identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "A user provided base policy name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "new_tasks_account": { + "description": "Account of the system to create tasks on. This overrides the default task affinity.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "override_list": { + "description": "The list of fields which will override a concrete policy.", + "items": { + "enum": [ + "ENABLED", + "PRIORITY", + "SCHEDULE", + "BRIEFCASE", + "SOURCE_ACCOUNT_ID", + "TARGET_ACCOUNT_ID", + "BASE_ACCOUNT_ID", + "TASK_ACCOUNT_ID", + "SUBPATHS", + "SOURCE_BASE_PATH", + "TARGET_BASE_PATH", + "SRC_DATASET_RETENTION", + "TGT_DATASET_RETENTION" + ], + "type": "string" + }, + "maxItems": 14, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "priority": { + "description": "The relative priority of the policy.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "schedule": { + "$ref": "#/definitions/v15DatamoverBasePolicySchedule" + }, + "source_account_id": { + "description": "Account ID of the source data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_base_path": { + "description": "Filesystem base path on source DM system which has the directories/files for which dataset has to be created.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "src_dataset_retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "target_account_id": { + "description": "Account ID of the target data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Filesystem base path on target DM syestem which has the directories/files for which dataset has to be created.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "tgt_dataset_retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "version": { + "description": "Version number of the config store when this object was edited.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "override_list", + "name" + ], + "type": "object" + }, + "v15DatamoverBasePolicyExtended": { + "additionalProperties": false, + "properties": { + "base_account_id": { + "description": "Account ID (local or remote DM system) where the policy should be created.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "True: policy is enabled, False: otherwise.", + "type": "boolean" + }, + "name": { + "description": "A user provided base policy name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "new_tasks_account": { + "description": "Account of the system to create tasks on. This overrides the default task affinity.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "override_list": { + "description": "The list of fields which will override a concrete policy.", + "items": { + "enum": [ + "ENABLED", + "PRIORITY", + "SCHEDULE", + "BRIEFCASE", + "SOURCE_ACCOUNT_ID", + "TARGET_ACCOUNT_ID", + "BASE_ACCOUNT_ID", + "TASK_ACCOUNT_ID", + "SUBPATHS", + "SOURCE_BASE_PATH", + "TARGET_BASE_PATH", + "SRC_DATASET_RETENTION", + "TGT_DATASET_RETENTION" + ], + "type": "string" + }, + "maxItems": 14, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "priority": { + "description": "The relative priority of the policy.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "schedule": { + "$ref": "#/definitions/v15DatamoverBasePolicySchedule" + }, + "source_account_id": { + "description": "Account ID of the source data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_base_path": { + "description": "Filesystem base path on source DM system which has the directories/files for which dataset has to be created.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "src_dataset_retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "target_account_id": { + "description": "Account ID of the target data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Filesystem base path on target DM syestem which has the directories/files for which dataset has to be created.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "tgt_dataset_retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "version": { + "description": "Version number of the config store when this object was edited.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverBasePolicySchedule": { + "description": "The schedule of the policy- start time, recurrence, specific date-times.", + "properties": { + "date_times": { + "description": "The specific date/times at which this policy should run regardless of the start_time and recurrence.", + "items": { + "description": "The time in '%Y-%m-%d %H:%M:%S' format. The year range is 2001-2099.", + "maxLength": 19, + "minLength": 14, + "pattern": "20[0-9][0-9]-1[0-2]|[1-9]-3[01]|[12][0-9]|0?[1-9] 2[0-3]|1[0-9]|0?[0-9]:[0-5]?[0-9]:[0-5]?[0-9]", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "recurrence": { + "description": "The cron expression to represent a repetitive schedule for the policy w.r.t. start_time.", + "items": { + "maxLength": 200, + "minLength": 1, + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "start_time": { + "description": "The date/time of the first run of the policy. It should be in 'yyyy-mm-dd hh:mn:ss' format, where year range is 2001-2099.", + "maxLength": 19, + "minLength": 14, + "pattern": "20[0-9][0-9]-1[0-2]|[1-9]-3[01]|[12][0-9]|0?[1-9] 2[0-3]|1[0-9]|0?[0-9]:[0-5]?[0-9]:[0-5]?[0-9]", + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverBasePolicyTgtDatasetRetention": { + "additionalProperties": false, + "properties": { + "dataset_expiry_action": { + "description": "The action to be taken after dataset expiry.", + "enum": [ + "DELETE" + ], + "type": "string" + }, + "dataset_reserve": { + "description": "The number of datasets in this tree to protect from expiration.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "dataset_retention_period": { + "description": "The time before dataset expiry, represented as number of seconds after dataset creation time.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverDataset": { + "additionalProperties": false, + "description": "Schema of a Data Mover dataset.", + "properties": { + "dataset_base_path": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "dataset_creation_time": { + "description": "The time when the dataset is created. The time in seconds past the epoch", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "dataset_expiry_action": { + "description": "The action to be taken after dataset expiry.", + "enum": [ + "DELETE" + ], + "type": "string" + }, + "dataset_global_id": { + "$ref": "#/definitions/v15DatamoverDatasetDatasetGlobalId" + }, + "dataset_retention_period": { + "description": "The time when dataset will expire which is calculated based upon dataset creation time plus dataset retention period specified for the dataset. It is the time in seconds past the epoch", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "dataset_state": { + "description": "The state of dataset.", + "enum": [ + "INVALID", + "INPROGRESS", + "COMPLETE", + "COMPLETE_PARTIAL", + "ERROR" + ], + "type": "string" + }, + "dataset_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "dataset_type": { + "description": "Dataset type from one of these: A file system on object store in a copy format, a file system on object store in a backup format or file on file dataset.", + "enum": [ + "FILE_ON_OBJECT_COPY", + "FILE_ON_OBJECT_BACKUP", + "FILE" + ], + "type": "string" + }, + "id": { + "description": "The locally unique dataset identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverDatasetDatasetGlobalId": { + "additionalProperties": false, + "description": "The globally unique identifier of dataset.", + "properties": { + "dataset_revision": { + "$ref": "#/definitions/v15DatamoverDatasetDatasetGlobalIdDatasetRevision" + }, + "dataset_tree_id": { + "$ref": "#/definitions/v15DatamoverDatasetDatasetGlobalIdDatasetRevision" + } + }, + "type": "object" + }, + "v15DatamoverDatasetDatasetGlobalIdDatasetRevision": { + "additionalProperties": false, + "description": "The revision information of dataset.", + "properties": { + "local_unid": { + "description": "The locally unique Data Mover identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "system_guid": { + "description": "The globally unique Data Mover identifier.", + "maxLength": 36, + "minLength": 2, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverDatasetExtended": { + "allOf": [ + { + "$ref": "#/definitions/v15DatamoverDataset" + }, + { + "additionalProperties": false, + "description": "Schema of a Data Mover dataset.", + "properties": { + "snapshot_path": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "v15DatamoverDatasets": { + "additionalProperties": false, + "properties": { + "datasets": { + "items": { + "$ref": "#/definitions/v15DatamoverDataset" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverDatasetsExtended": { + "additionalProperties": false, + "properties": { + "datasets": { + "items": { + "$ref": "#/definitions/v15DatamoverDatasetExtended" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJob" + }, + "maxItems": 1000, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobsJob": { + "additionalProperties": false, + "description": "Schema of a Data Mover job.", + "properties": { + "id": { + "description": "Unique Job ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_control_request": { + "description": "Job control request.", + "enum": [ + "NONE", + "PAUSE_JOB", + "RESUME_JOB", + "CANCEL_JOB", + "COMPLETE_PARTIAL_JOB" + ], + "type": "string" + }, + "job_end_time": { + "description": "The time in seconds past the epoch", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "job_policy_id": { + "description": "Policy ID associated with this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_priority": { + "description": "The relative priority of the job.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "job_start_time": { + "description": "The time in seconds past the epoch", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "job_state": { + "description": "Job state", + "enum": [ + "INVALID", + "PENDING", + "RUNNING", + "PAUSED", + "FINISHING", + "FAILING", + "CANCELLING", + "CANCELLED", + "FAILED", + "FINISHED", + "SHADOW_JOB" + ], + "type": "string" + }, + "job_state_flags": { + "description": "This shows if job has some failure and failure code/info: DM_JOB_HAS_NO_FAILURE = 0, DM_JOB_FAILURE_ENCOUNTERED = 1, DM_JOB_CANNOT_COMPLETE = 2, DM_JOB_ALREADY_RUNNING = 4.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_type_specific_attrs": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrs" + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobsJobJobTypeSpecificAttrs": { + "description": "Job type specific attributes.", + "properties": { + "dataset_baseline_copy_job": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetBaselineCopyJob" + }, + "dataset_creation_job": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetCreationJob" + }, + "dataset_expiration_job": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetExpirationJob" + }, + "dataset_incremental_copy_job": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetIncrementalCopyJob" + }, + "job_type": { + "description": "Type of the Data Mover job.", + "enum": [ + "DATASET_CREATION_JOB", + "DATASET_EXPIRATION_JOB", + "DATASET_INCREMENTAL_COPY_JOB", + "DATASET_BASELINE_COPY_JOB" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetBaselineCopyJob": { + "description": "Fields specific to dataset baseline copy job.", + "properties": { + "create_dataset_on_target": { + "description": "Target dataset creation flag. True if dataset should be created on target, false otherwise.", + "type": "boolean" + }, + "dataset_id": { + "description": "The unique dataset identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_tasks_account": { + "description": "Account where to create task.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "source_account_id": { + "description": "Account ID of the source storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_base_path": { + "description": "Filesystem source base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "target_account_id": { + "description": "Account ID of the target storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Target base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_dataset_type": { + "description": "Dataset type on target.", + "enum": [ + "FILE_ON_OBJECT_COPY", + "FILE_ON_OBJECT_BACKUP", + "FILE" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetCreationJob": { + "description": "Fields specific to dataset creation job.", + "properties": { + "account_id": { + "description": "Account ID of the source storage system, where the dataset is to be created.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "base_path": { + "description": "Filesystem path for dataset creation. The subpath is relative to this path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "statistics": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetCreationJobStatistics" + }, + "subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetCreationJobStatistics": { + "description": "Statistics for this job", + "properties": { + "dataset_id": { + "description": "Dataset ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetExpirationJob": { + "description": "Fields specific to dataset retention job.", + "properties": { + "account_id": { + "description": "The account where this dataset expiration job is to be run.", + "maxLength": 48, + "minLength": 2, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetIncrementalCopyJob": { + "description": "Fields specific to dataset incremental copy job.", + "properties": { + "new_tasks_account": { + "description": "Account of the system to create tasks on. This overrides the default task affinity.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "source_account_id": { + "description": "Account ID of the source storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_base_path": { + "description": "Filesystem source base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_account_id": { + "description": "Account ID of the target storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Target base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_dataset_type": { + "description": "Dataset type on target.", + "enum": [ + "FILE_ON_OBJECT_COPY", + "FILE_ON_OBJECT_BACKUP", + "FILE" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverJob": { + "additionalProperties": false, + "description": "Schema of a Data Mover job.", + "properties": { + "id": { + "description": "Unique Job ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_control_request": { + "description": "Job control request.", + "enum": [ + "NONE", + "PAUSE_JOB", + "RESUME_JOB", + "CANCEL_JOB", + "COMPLETE_PARTIAL_JOB" + ], + "type": "string" + }, + "job_end_time": { + "description": "The time in seconds past the epoch", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "job_policy_id": { + "description": "Policy ID associated with this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_priority": { + "description": "The relative priority of the job.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "job_start_time": { + "description": "The time in seconds past the epoch", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "job_state": { + "description": "Job state", + "enum": [ + "INVALID", + "PENDING", + "RUNNING", + "PAUSED", + "FINISHING", + "FAILING", + "CANCELLING", + "CANCELLED", + "FAILED", + "FINISHED", + "SHADOW_JOB" + ], + "type": "string" + }, + "job_state_flags": { + "description": "This shows if job has some failure and failure code/info: DM_JOB_HAS_NO_FAILURE = 0, DM_JOB_FAILURE_ENCOUNTERED = 1, DM_JOB_CANNOT_COMPLETE = 2, DM_JOB_ALREADY_RUNNING = 4.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_type_specific_attrs": { + "$ref": "#/definitions/v15DatamoverJobJobTypeSpecificAttrs" + } + }, + "type": "object" + }, + "v15DatamoverJobJobTypeSpecificAttrs": { + "description": "Job type specific attributes.", + "properties": { + "dataset_baseline_copy_job": { + "$ref": "#/definitions/v15DatamoverJobJobTypeSpecificAttrsDatasetBaselineCopyJob" + }, + "dataset_creation_job": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetCreationJob" + }, + "dataset_expiration_job": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJobJobTypeSpecificAttrsDatasetExpirationJob" + }, + "dataset_incremental_copy_job": { + "$ref": "#/definitions/v15DatamoverJobJobTypeSpecificAttrsDatasetIncrementalCopyJob" + }, + "job_type": { + "description": "Type of the Data Mover job.", + "enum": [ + "DATASET_CREATION_JOB", + "DATASET_EXPIRATION_JOB", + "DATASET_INCREMENTAL_COPY_JOB", + "DATASET_BASELINE_COPY_JOB" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverJobJobTypeSpecificAttrsDatasetBaselineCopyJob": { + "description": "Fields specific to dataset baseline copy job.", + "properties": { + "create_dataset_on_target": { + "description": "Target dataset creation flag. True if dataset should be created on target, false otherwise.", + "type": "boolean" + }, + "dataset_id": { + "description": "The unique dataset identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_tasks_account": { + "description": "Account where to create task.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "source_account_id": { + "description": "Account ID of the source storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_base_path": { + "description": "Filesystem source base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "statistics": { + "$ref": "#/definitions/v15DatamoverJobJobTypeSpecificAttrsDatasetBaselineCopyJobStatistics" + }, + "target_account_id": { + "description": "Account ID of the target storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Target base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_dataset_type": { + "description": "Dataset type on target.", + "enum": [ + "FILE_ON_OBJECT_COPY", + "FILE_ON_OBJECT_BACKUP", + "FILE" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverJobJobTypeSpecificAttrsDatasetBaselineCopyJobStatistics": { + "description": "Baseline copy job statistics.", + "properties": { + "0K_8K_files_xferred": { + "description": "Total number of files that were <= 8K in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "100M_10G_files_xferred": { + "description": "Total number of files that were greater than 100MB and <= 10GB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "1M_100M_files_xferred": { + "description": "Total number of files that were greater than 1MB and <= 100MB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "8K_1M_files_xferred": { + "description": "Total number of files that were greater than 8K and <= 1MB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ads_xferred": { + "description": "Total number of alternate data streams transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_files_xferred": { + "description": "Total number of block files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_xferred": { + "description": "Total number of file bytes transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_files_xferred": { + "description": "Total number of char files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_xferred": { + "description": "Total number of directories transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifo_files_xferred": { + "description": "Total number of FIFO files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_xferred": { + "description": "Total number of files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hardlinks_xferred": { + "description": "Total number of hardlinks transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "huge_files_xferred": { + "description": "Total number of files that were greater than 10GB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sock_files_xferred": { + "description": "Total number of socket files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "softlinks_xferred": { + "description": "Total number of softlinks transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_base_dataset_id": { + "description": "Source Base Dataset ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_dataset_id": { + "description": "Target Dataset ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_size_xferred": { + "description": "Total size of files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverJobJobTypeSpecificAttrsDatasetIncrementalCopyJob": { + "description": "Fields specific to dataset incremental copy job.", + "properties": { + "new_tasks_account": { + "description": "Account of the system to create tasks on. This overrides the default task affinity.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "source_account_id": { + "description": "Account ID of the source storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_base_path": { + "description": "Filesystem source base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "statistics": { + "$ref": "#/definitions/v15DatamoverJobJobTypeSpecificAttrsDatasetIncrementalCopyJobStatistics" + }, + "target_account_id": { + "description": "Account ID of the target storage system.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Target base path.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_dataset_type": { + "description": "Dataset type on target.", + "enum": [ + "FILE_ON_OBJECT_COPY", + "FILE_ON_OBJECT_BACKUP", + "FILE" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverJobJobTypeSpecificAttrsDatasetIncrementalCopyJobStatistics": { + "description": "Incremental copy job statistics.", + "properties": { + "0K_8K_files_xferred": { + "description": "Total number of files that were <= 8K in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "100M_10G_files_xferred": { + "description": "Total number of files that were greater than 100MB and <= 10GB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "1M_100M_files_xferred": { + "description": "Total number of files that were greater than 1MB and <= 100MB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "8K_1M_files_xferred": { + "description": "Total number of files that were greater than 8K and <= 1MB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ads_xferred": { + "description": "Total number of alternate data streams transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_files_xferred": { + "description": "Total number of block files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_xferred": { + "description": "Total number of file bytes transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_files_xferred": { + "description": "Total number of char files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_xferred": { + "description": "Total number of directories transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifo_files_xferred": { + "description": "Total number of FIFO files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_xferred": { + "description": "Total number of files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hardlinks_xferred": { + "description": "Total number of hardlinks transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "huge_files_xferred": { + "description": "Total number of files that were greater than 10GB in size.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_ads_deleted": { + "description": "Total number of alternate data streams deleted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_bytes_changed": { + "description": "Total number of bytes changed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_bytes_truncated": { + "description": "Total number of bytes truncated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_dirs_change": { + "description": "Total number of directories changed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_dirs_moved": { + "description": "Total number of directories moved.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_files_linked": { + "description": "Total number of files linked.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_inodes_scan": { + "description": "Total number of inodes scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_new_dirs_created": { + "description": "Total number of new directories created.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_snapshot_scan": { + "description": "Total number of snapshot scan.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_trees_deleted": { + "description": "Total number of trees deleted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_updated_files": { + "description": "Total number of updated files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sock_files_xferred": { + "description": "Total number of socket files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "softlinks_xferred": { + "description": "Total number of softlinks transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_base_dataset_id": { + "description": "Source Base Dataset ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_incremental_dataset_id": { + "description": "Source Incremental Dataset ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_dataset_id": { + "description": "Target Dataset ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_size_xferred": { + "description": "Total size of files transferred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v15DatamoverHistoricalJobsJob" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v15DatamoverJob" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15DatamoverPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v15DatamoverPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v15DatamoverPolicyExtended" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15DatamoverPolicy": { + "additionalProperties": false, + "description": "Schema of a Data Mover policy.", + "properties": { + "base_policy_id": { + "description": "Identifier of the base policy for this concrete policy", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "True: policy is enabled, False: otherwise.", + "type": "boolean" + }, + "name": { + "description": "A user provided policy name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "parent_exec_policy_id": { + "description": "If a valid policy ID, then a job for this policy will be scheduled immediately after the parent policy job completes. This is optional field", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "policy_specific_attr": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttr" + }, + "priority": { + "description": "The relative priority of the policy.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "run_now": { + "description": "Execute the policy immediately instead of waiting for it to run as scheduled.", + "type": "boolean" + }, + "schedule": { + "$ref": "#/definitions/v15DatamoverBasePolicySchedule" + } + }, + "required": [ + "policy_specific_attr", + "enabled", + "priority", + "name" + ], + "type": "object" + }, + "v15DatamoverPolicyExtended": { + "additionalProperties": false, + "description": "Schema of a Data Mover policy.", + "properties": { + "base_policy_id": { + "description": "Identifier of the base policy for this concrete policy", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "disabled_by_dm": { + "description": "This flag indicates if policy has been disabled by the datamover system. This flag is set to true when a job for the given policy is cancelled", + "type": "boolean" + }, + "enabled": { + "description": "True: policy is enabled, False: otherwise.", + "type": "boolean" + }, + "id": { + "description": "The unique policy identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "A user provided policy name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "parent_exec_policy_id": { + "description": "If a valid policy ID, then a job for this policy will be scheduled immediately after the parent policy job completes. This is optional field", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "policy_specific_attr": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrExtended" + }, + "priority": { + "description": "The relative priority of the policy.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "run_now": { + "description": "Execute the policy immediately instead of waiting for it to run as scheduled.", + "type": "boolean" + }, + "schedule": { + "$ref": "#/definitions/v15DatamoverBasePolicySchedule" + }, + "validity": { + "description": "Whether the policy is valid.", + "type": "boolean" + }, + "version": { + "description": "Version number of the config store when this object was edited.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "name", + "enabled", + "priority" + ], + "type": "object" + }, + "v15DatamoverPolicyExtendedExtended": { + "additionalProperties": false, + "description": "Schema of a Data Mover policy.", + "properties": { + "base_policy_id": { + "description": "Identifier of the base policy for this concrete policy", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "briefcase": { + "description": "An opaque container for storing additional data in this object, e.g. key-value pairs", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "True: policy is enabled, False: otherwise.", + "type": "boolean" + }, + "name": { + "description": "A user provided policy name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "parent_exec_policy_id": { + "description": "If a valid policy ID, then a job for this policy will be scheduled immediately after the parent policy job completes. This is optional field", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "policy_specific_attr": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrExtendedExtended" + }, + "priority": { + "description": "The relative priority of the policy.", + "enum": [ + "LOW", + "NORMAL", + "HIGH" + ], + "type": "string" + }, + "run_now": { + "description": "Execute the policy immediately instead of waiting for it to run as scheduled.", + "type": "boolean" + }, + "schedule": { + "$ref": "#/definitions/v15DatamoverBasePolicySchedule" + }, + "version": { + "description": "Version number of the config store when this object was edited.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttr": { + "properties": { + "copy_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrCopyPolicy" + }, + "creation_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrCreationPolicy" + }, + "expiration_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrExpirationPolicy" + }, + "policy_type": { + "description": "The type of policy - Creation, Expiration, Copy, Repeat-Copy.", + "enum": [ + "CREATION", + "EXPIRATION", + "COPY", + "REPEAT_COPY" + ], + "type": "string" + }, + "repeat_copy_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicy" + } + }, + "required": [ + "policy_type" + ], + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrCopyPolicy": { + "additionalProperties": false, + "properties": { + "create_dataset_on_target": { + "description": "Whether or not to create dataset on the target storage system.", + "type": "boolean" + }, + "dataset_copy_policy_base": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicyDatasetCopyPolicyBase" + }, + "dataset_id": { + "description": "The unique dataset identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_base_path": { + "description": "Base path of the dataset on the source storage system.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrCopyPolicyExtended": { + "additionalProperties": false, + "properties": { + "create_dataset_on_target": { + "description": "Whether or not to create dataset on the target storage system.", + "type": "boolean" + }, + "dataset_copy_policy_base": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicyDatasetCopyPolicyBase" + }, + "dataset_id": { + "description": "The unique dataset identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_base_path": { + "description": "Base path of the dataset on the source storage system.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_subpaths": { + "description": "Set of filesystem paths relative to base path.", + "items": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrCreationPolicy": { + "description": "Fields specific to dataset creation.", + "properties": { + "account_id": { + "description": "Account ID of the source storage system, where the dataset is to be created.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "base_path": { + "description": "Filesystem base path which has the directories/files for which dataset has to be created.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrExpirationPolicy": { + "description": "Fields specific to dataset retention policy.", + "properties": { + "account_id": { + "description": "The account where this expiration policy is to be run.", + "maxLength": 48, + "minLength": 2, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrExtended": { + "properties": { + "copy_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrCopyPolicyExtended" + }, + "creation_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrCreationPolicy" + }, + "expiration_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrExpirationPolicy" + }, + "policy_type": { + "description": "The type of policy - Creation, Expiration, Copy, Repeat-Copy.", + "enum": [ + "CREATION", + "EXPIRATION", + "COPY", + "REPEAT_COPY" + ], + "type": "string" + }, + "repeat_copy_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicy" + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrExtendedExtended": { + "properties": { + "copy_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrCopyPolicy" + }, + "creation_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrCreationPolicy" + }, + "expiration_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrExpirationPolicy" + }, + "policy_type": { + "description": "The type of policy - Creation, Expiration, Copy, Repeat-Copy.", + "enum": [ + "CREATION", + "EXPIRATION", + "COPY", + "REPEAT_COPY" + ], + "type": "string" + }, + "repeat_copy_policy": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicy" + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicy": { + "additionalProperties": false, + "properties": { + "dataset_copy_policy_base": { + "$ref": "#/definitions/v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicyDatasetCopyPolicyBase" + }, + "reconnect": { + "description": "This boolean allows starting with incremental syncs and skipping the initial baseline sync if the target base path contains a leaf dataset which is an ancestor of a source base path dataset.", + "type": "boolean" + }, + "source_base_path": { + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15DatamoverPolicyPolicySpecificAttrRepeatCopyPolicyDatasetCopyPolicyBase": { + "additionalProperties": false, + "properties": { + "base_account_id": { + "description": "Account ID (local or remote DM system) where the policy should be created. This is an optional field, if not specified it will be set to the local account ID.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "copy_retention": { + "$ref": "#/definitions/v15DatamoverBasePolicyTgtDatasetRetention" + }, + "new_tasks_account": { + "description": "Account ID where to create all the tasks. This is an optional field, if not specified will be set to the local account ID.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "source_account_id": { + "description": "Account ID of the source data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_account_id": { + "description": "Account ID of the target data storage.", + "maxLength": 48, + "minLength": 2, + "type": "string" + }, + "target_base_path": { + "description": "Base path on the target storage system.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_dataset_type": { + "description": "Dataset type from one of these: A file system on object store in a copy format, a file system on object store in a backup format or file on file dataset.", + "enum": [ + "FILE_ON_OBJECT_COPY", + "FILE_ON_OBJECT_BACKUP", + "FILE" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15EventAlertCondition": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "items": { + "enum": [ + "all", + "SYS_DISK_EVENTS", + "100000000", + "NODE_STATUS_EVENTS", + "200000000", + "REBOOT_EVENTS", + "300000000", + "SW_EVENTS", + "400000000", + "QUOTA_EVENTS", + "500000000", + "SNAP_EVENTS", + "600000000", + "WINNET_EVENTS", + "700000000", + "FILESYS_EVENTS", + "800000000", + "HW_EVENTS", + "900000000", + "CPOOL_EVENTS", + "1100000000" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "Channels for alert.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "exclude_eventgroup_ids": { + "description": "Event Group categories to be excluded from alerts.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "severities": { + "description": "Severities to be alerted.", + "items": { + "enum": [ + "emergency", + "critical", + "warning", + "information" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "name", + "channels", + "condition" + ], + "type": "object" + }, + "v15EventAlertConditionExtended": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "items": { + "enum": [ + "all", + "SYS_DISK_EVENTS", + "100000000", + "NODE_STATUS_EVENTS", + "200000000", + "REBOOT_EVENTS", + "300000000", + "SW_EVENTS", + "400000000", + "QUOTA_EVENTS", + "500000000", + "SNAP_EVENTS", + "600000000", + "WINNET_EVENTS", + "700000000", + "FILESYS_EVENTS", + "800000000", + "HW_EVENTS", + "900000000", + "CPOOL_EVENTS", + "1100000000" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "Channels for alert.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "exclude_eventgroup_ids": { + "description": "Event Group categories to be excluded from alerts.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "severities": { + "description": "Severities to be alerted.", + "items": { + "enum": [ + "emergency", + "critical", + "warning", + "information" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15EventAlertConditions": { + "additionalProperties": false, + "properties": { + "alert-conditions": { + "items": { + "$ref": "#/definitions/v15EventAlertConditionsAlert-Condition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15EventAlertConditionsAlert-Condition": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "items": { + "enum": [ + "all", + "SYS_DISK_EVENTS", + "100000000", + "NODE_STATUS_EVENTS", + "200000000", + "REBOOT_EVENTS", + "300000000", + "SW_EVENTS", + "400000000", + "QUOTA_EVENTS", + "500000000", + "SNAP_EVENTS", + "600000000", + "WINNET_EVENTS", + "700000000", + "FILESYS_EVENTS", + "800000000", + "HW_EVENTS", + "900000000", + "CPOOL_EVENTS", + "1100000000" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "Channels for alert.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "exclude_eventgroup_ids": { + "description": "Event Group categories to be excluded from alerts.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "severities": { + "description": "Severities to be alerted.", + "items": { + "enum": [ + "emergency", + "critical", + "warning", + "information" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15EventAlertConditionsAlert-ConditionExtended": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "items": { + "enum": [ + "all", + "SYS_DISK_EVENTS", + "100000000", + "NODE_STATUS_EVENTS", + "200000000", + "REBOOT_EVENTS", + "300000000", + "SW_EVENTS", + "400000000", + "QUOTA_EVENTS", + "500000000", + "SNAP_EVENTS", + "600000000", + "WINNET_EVENTS", + "700000000", + "FILESYS_EVENTS", + "800000000", + "HW_EVENTS", + "900000000", + "CPOOL_EVENTS", + "1100000000" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "Channels for alert.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "exclude_eventgroup_ids": { + "description": "Event Group categories to be excluded from alerts.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "severities": { + "description": "Severities to be alerted.", + "items": { + "enum": [ + "emergency", + "critical", + "warning", + "information" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15EventAlertConditionsExtended": { + "additionalProperties": false, + "properties": { + "alert-conditions": { + "items": { + "$ref": "#/definitions/v15EventAlertConditionsAlert-ConditionExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15HealthcheckAutoupdate": { + "description": "HealthCheck autoupdate.", + "properties": { + "autoupdate": { + "$ref": "#/definitions/v15HealthcheckAutoupdateAutoupdate" + } + }, + "type": "object" + }, + "v15HealthcheckAutoupdateAutoupdate": { + "description": "Autoupdate status", + "properties": { + "compliance_update": { + "description": "Enable flag for compliance mode.", + "type": "boolean" + }, + "enabled": { + "description": "Autoupdate enable flag.", + "type": "boolean" + }, + "last_failed_upgrade_package": { + "description": "The name of the last failed upgrade package.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "number_of_failed_upgrades": { + "description": "Number of failed upgrade attempts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15HealthcheckVersion": { + "description": "Healthcheck version", + "properties": { + "version": { + "description": "The version number.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + }, + "v15HttpService": { + "properties": { + "enabled": { + "description": "A True value indicates the service is currently enabled on the cluster.", + "type": "boolean" + }, + "id": { + "description": "A string used to identify the service.", + "enum": [ + "PowerScaleUI", + "Platform-API-External", + "RAN", + "RemoteService" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15HttpServiceExtended": { + "properties": { + "enabled": { + "description": "A True value indicates the service is currently enabled on the cluster.", + "type": "boolean" + } + }, + "type": "object" + }, + "v15HttpServices": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "services": { + "items": { + "$ref": "#/definitions/v15HttpService" + }, + "maxItems": 4, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15HttpServicesExtended": { + "additionalProperties": false, + "properties": { + "services": { + "items": { + "$ref": "#/definitions/v15HttpService" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v15NfsAlias": { + "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", + "properties": { + "name": { + "description": "Specifies the name by which the alias can be referenced.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "path": { + "description": "Specifies the path to which the alias points.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the alias is valid.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_NFS_ALIASES" + }, + "v15NfsAliasExtended": { + "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", + "properties": { + "health": { + "description": "Specifies whether the alias is usable.", + "enum": [ + "good", + "illegal file type", + "illegal path", + "name conflict", + "not exported", + "path not found", + "unknown" + ], + "type": "string" + }, + "id": { + "description": "Specifies a string which represents the unique location of the alias.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Specifies the name by which the alias can be referenced.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "path": { + "description": "Specifies the path to which the alias points.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the alias is valid.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15NfsAliases": { + "additionalProperties": false, + "properties": { + "aliases": { + "items": { + "$ref": "#/definitions/v15NfsAliasExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_NFS_ALIASES" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15NodeDrives": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v15NodeDrivesNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15NodeDrivesNode": { + "description": "Information about this node's drives.", + "properties": { + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v15ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15PoolsPoolStatus": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v15PoolsPoolStatusSettings" + } + }, + "type": "object" + }, + "v15PoolsPoolStatusSettings": { + "properties": { + "id": { + "description": "Unique Pool ID.", + "maxLength": 99, + "minLength": 1, + "type": "string" + }, + "nodes": { + "description": "The status of the requested nodes.", + "items": { + "$ref": "#/definitions/v15PoolsPoolStatusSettingsNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_dns_overview": { + "$ref": "#/definitions/v15PoolsPoolStatusSettingsScDnsOverview" + }, + "total_configured_nodes": { + "description": "The number of nodes configured in the Network Pool.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total_configured_nodes", + "nodes", + "sc_dns_overview", + "id" + ], + "type": "object" + }, + "v15PoolsPoolStatusSettingsNode": { + "properties": { + "devid": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "interface_status": { + "$ref": "#/definitions/v15PoolsPoolStatusSettingsNodeInterfaceStatus" + }, + "ip_status": { + "description": "Summary of the status of the IPs currently configured on this node. usable: The node has IPs allocated that are usable. none_usable: The node has IPs configured, but they are currently not in a usable state. This can occur for a variety of reasons. For static IPs, this can occur if the node is down, or if the interfaces are down. For dynamic IPs, this can occur if all of the IPs are about to move to a different node. none_configured: The node has no IPs from the Network Pool configured currently.", + "enum": [ + "usable", + "none_usable", + "none_configured" + ], + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "node_state": { + "description": "The node's current state within the cluster.", + "enum": [ + "up", + "draining", + "smartfailing", + "shutting_down", + "down" + ], + "type": "string" + }, + "protocols_running": { + "description": "Indicates if the node has the required protocols to be resolvable via DNS.", + "type": "boolean" + }, + "sc_dns_resolvable": { + "description": "Indicates if the node can be resolved via SmartConnect DNS or not.", + "type": "boolean" + }, + "suspended": { + "description": "Indicates if the node has been suspended within the Network Pool.", + "type": "boolean" + } + }, + "type": "object" + }, + "v15PoolsPoolStatusSettingsNodeInterfaceStatus": { + "properties": { + "total": { + "description": "The number of interfaces on the node that are configured within this Network Pool", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "usable": { + "description": "The number of interfaces on the node that are configured within this Network Pool and are currently usable to SmartConnect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15PoolsPoolStatusSettingsScDnsOverview": { + "properties": { + "needs_attention": { + "description": "The number of nodes that either are not resolvable via SmartConnect DNS or may need attention for other reasons such as an unusable Network Interface.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resolvable": { + "description": "The number of nodes that can be resolved via SmartConnect DNS.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sc_subnet": { + "description": "The subnet responsible for DNS resolution for this pool.", + "maxLength": 66, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v15QuotaQuota": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "description": { + "description": "Free form text description of the quota.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise an accounting quota.", + "type": "boolean" + }, + "force": { + "description": "Force creation of quotas on the root of /ifs or percent based quotas.", + "type": "boolean" + }, + "ignore_limit_checks": { + "description": "If true, skip child quota's threshold comparison with parent quota path.", + "type": "boolean" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "labels": { + "description": "Tags to identify a quota domain.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholds" + }, + "thresholds_include_overhead": { + "description": "This option is deprecated. Use the option 'thresholds_on' to select the usage on which thresholds to apply.", + "type": "boolean" + }, + "thresholds_on": { + "default": "fslogicalsize", + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "type": "string" + } + }, + "required": [ + "include_snapshots", + "path", + "type" + ], + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "v15QuotaQuotaExtended": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "description": { + "description": "User settable free form text description of the quota.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "efficiency_ratio": { + "description": "Represents the ratio of logical space provided to physical space used. This accounts for protection overhead, metadata, and compression ratios for the data.", + "maximum": 1.79769e+308, + "minimum": 0, + "type": "number", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_EFFICIENCYRATIO" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise a accounting quota.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the quota.", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "labels": { + "description": "Tags to identify a quota domain.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "linked": { + "description": "For user, group and directory quotas, true if the quota is linked and controlled by a parent default-* quota. Linked quotas cannot be modified until they are unlinked.", + "type": "boolean" + }, + "notifications": { + "description": "Summary of notifications: 'custom' indicates one or more notification rules available from the notifications sub-resource; 'default' indicates system default rules are used; 'disabled' indicates that no notifications will be used for this quota.; 'badmap' indicates that notification rule has problem in rule map.", + "enum": [ + "custom", + "default", + "disabled", + "badmap" + ], + "maxLength": 8, + "minLength": 6, + "type": "string" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ready": { + "description": "True if the default resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "reduction_ratio": { + "description": "Represents the ratio of logical space provided to physical data space used. This accounts for compression and data deduplication effects.", + "maximum": 1.79769e+308, + "minimum": 0, + "type": "number", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_REDUCTIONRATIO" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholdsExtended" + }, + "thresholds_on": { + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v12QuotaQuotaUsage" + } + }, + "required": [ + "enforced", + "include_snapshots", + "container", + "description", + "usage", + "thresholds", + "labels", + "persona", + "linked", + "notifications", + "ready", + "path", + "type", + "id" + ], + "type": "object" + }, + "v15QuotaQuotaExtendedExtended": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "description": { + "description": "Free form text description of the quota.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise an accounting quota.", + "type": "boolean" + }, + "force": { + "description": "Force creation of quotas on the root of /ifs or percent based quotas.", + "type": "boolean" + }, + "ignore_limit_checks": { + "description": "If true, skip child quota's threshold comparison with parent quota path.", + "type": "boolean" + }, + "labels": { + "description": "Tags to identify a quota domain.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "linked": { + "description": "If false and the quota is linked, attempt to unlink.", + "type": "boolean" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholds" + }, + "thresholds_include_overhead": { + "description": "This option is deprecated. Use the option 'thresholds_on' to select the usage on which thresholds to apply.", + "type": "boolean" + }, + "thresholds_on": { + "default": "fslogicalsize", + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "v15QuotaQuotas": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v15QuotaQuotaExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v15QuotaQuotasExtended": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v15QuotaQuotaExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15ReportSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v15SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "throughput": { + "description": "Throughput of a job", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "throughput", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v15ReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v15ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15ReportsReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v15ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15ReportsReportSubreportsSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v15SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "throughput": { + "description": "Throughput of a job", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "throughput", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v15ReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v15ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15SecurityCheck": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v15SecurityCheckSettings" + } + }, + "type": "object" + }, + "v15SecurityCheckItem": { + "additionalProperties": false, + "description": "This schema defines security check start configuration.", + "properties": { + "action": { + "description": "Action to be taken on encountering security anomalies", + "enum": [ + "celog", + "reboot", + "shutdown" + ], + "type": "string" + }, + "exclude_list": { + "description": "Comma separated security check names to exclude from the run", + "items": { + "description": "Security checks", + "enum": [ + "ClusterHealthCheck", + "PeriodicSecurityCheck", + "StigComplianceCheck" + ], + "type": "string" + }, + "maxItems": 2, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "mode": { + "description": "Mode of running security check: cluster, or node", + "enum": [ + "cluster", + "node" + ], + "type": "string" + }, + "name": { + "description": "Name of specific security check to run", + "enum": [ + "ClusterHealthCheck", + "PeriodicSecurityCheck", + "StigComplianceCheck" + ], + "type": "string" + }, + "node_lnn": { + "description": "Comma separated node numbers (LNN) to run security checks", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "v15SecurityCheckSettings": { + "description": "This is schema that contains security check status.", + "properties": { + "security_check_running": { + "description": "Gives Security check status.", + "type": "boolean" + } + }, + "type": "object" + }, + "v15SecuritySettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v15SecuritySettingsSettings" + } + }, + "type": "object" + }, + "v15SecuritySettingsSettings": { + "description": "This is schema that contains security properties.", + "properties": { + "fips_mode_enabled": { + "description": "Enable OpenSSL FIPS compliance", + "type": "boolean" + } + }, + "type": "object" + }, + "v15SyncJob": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test" + ], + "type": "string" + }, + "id": { + "description": "The ID or Name of the policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "log_level": { + "description": "Only valid for allow_write, and allow_write_revert; specify the desired logging level, will be stored in the logs for isi_migrate, defaults to 'info'.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_copy": { + "description": "Skips the copy phase of the service replication allow-write operation.", + "type": "boolean" + }, + "skip_failover": { + "description": "Skips the data failover phase of the service replication allow-write operation.", + "type": "boolean" + }, + "skip_map": { + "description": "Skips the mapping phase of the service replication allow-write operation.", + "type": "boolean" + }, + "source_snapshot": { + "description": "An optional snapshot to copy/sync from.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "tgt_path": { + "description": "Specifies the directory to output the service replication files for restoration.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "timestamp": { + "description": "Specifies the timestamp of a service replication policy backup to restore from.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "workers_per_node": { + "description": "Only valid for allow_write, and allow_write_revert; specify the desired workers per node, defaults to 3.", + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_JOBS" + }, + "v15SyncJobExtended": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v15SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "throughput": { + "description": "Throughput of a job", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "workers": { + "description": "A list of workers for this job.", + "items": { + "$ref": "#/definitions/v15SyncJobWorker" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "workers", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "throughput", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v15SyncJobPhase": { + "properties": { + "end_time": { + "description": "The time the job ended this phase.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phase": { + "description": "The phase that the job was in.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "start_time": { + "description": "The time the job began this phase.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "statistics": { + "$ref": "#/definitions/v15SyncJobPhaseStatistics" + } + }, + "type": "object" + }, + "v15SyncJobPhaseStatistics": { + "description": "Statistics for each phase of this job.", + "properties": { + "compliance_dir_links": { + "description": "Compliance Dir Links", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "corrected_lins": { + "description": "Corrected LINs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "deleted_dirs": { + "description": "Deleted Dirs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "deleted_files": { + "description": "Deleted Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "dirs": { + "description": "Dirs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "files": { + "description": "Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "flipped_lins": { + "description": "Flipped LINs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hash_exceptions": { + "description": "Hash Exceptions", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "linked_dirs": { + "description": "Linked Dirs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "linked_files": { + "description": "Linked Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "marked_directories": { + "description": "Marked Directories", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "marked_files": { + "description": "Marked Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "modified_dirs": { + "description": "Modified Dirs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "modified_files": { + "description": "Modified Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "modified_lins": { + "description": "Modified LINs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "new_compliance_dirs": { + "description": "New Compliance Dirs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "new_dirs": { + "description": "New Dirs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "new_files": { + "description": "New Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "new_resynced_files": { + "description": "New Resynced Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "resynced_file_links": { + "description": "Resynced File Links", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "resynced_lins": { + "description": "Resynced LINs", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlinked_files": { + "description": "Unlinked Files", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v15SyncJobServiceReportItem": { + "properties": { + "component": { + "description": "The component that was processed.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "directory": { + "description": "The directory of the service export.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "end_time": { + "description": "The time the job ended this component.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_msg": { + "description": "A list of error messages generated while exporting components.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "filter": { + "description": "A list of path-based filters for exporting components.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "handlers_failed": { + "description": "The number of handlers failed during export.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "handlers_skipped": { + "description": "The number of handlers skipped during export.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "handlers_transferred": { + "description": "The number of handlers exported.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "records_failed": { + "description": "The number of records failed during export.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "records_skipped": { + "description": "The number of records skipped during export.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "records_transferred": { + "description": "The number of records exported.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job began this component.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "The current status of export for this component.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v15SyncJobWorker": { + "properties": { + "connected": { + "description": "Whether there is a connection between the source and target.", + "type": "boolean" + }, + "last_split": { + "description": "The last time a network split occurred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_work": { + "description": "The last time the worker performed work.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lin": { + "description": "The LIN being worked on.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "The lnn the worker is assigned to run on.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "process_id": { + "description": "The process ID of the worker.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "The source host for this worker.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_host": { + "description": "The target host for this worker.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "worker_id": { + "description": "The ID of the worker.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15SyncJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v15SyncJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_JOBS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15SyncJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v15SyncJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15SyncReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v15SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "throughput": { + "description": "Throughput of a job", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "throughput", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v15SyncReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v15SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15SyncReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v15SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15TargetReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v15SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "throughput": { + "description": "Throughput of a job", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "throughput", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v15TargetReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v15TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_TARGET_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15TargetReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v15TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15TargetReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v15ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15ThrottlingBwRule": { + "description": "Statistics for this job", + "properties": { + "bw_limit": { + "description": "Bandwidth limit, in bytes/s", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "netmask": { + "description": "Netmask in the presentation format, e.g. 192.168.0.100/16 or 2001:0db8:85a3:0000:0000:8a2e:0370:7334/64", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "rule_type": { + "description": "Type of Bandwidth throttling rule.", + "enum": [ + "NETMASK" + ], + "type": "string" + } + }, + "required": [ + "rule_type", + "netmask", + "bw_limit" + ], + "type": "object" + }, + "v15ThrottlingBwRuleExtended": { + "description": "Statistics for this job", + "properties": { + "bw_limit": { + "description": "Bandwidth limit, in bytes/s", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v15ThrottlingBwRules": { + "additionalProperties": false, + "properties": { + "bandwidth-rules": { + "items": { + "$ref": "#/definitions/v15ThrottlingBwRulesBandwidth-Rule" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "total", + "bandwidth-rules" + ], + "type": "object" + }, + "v15ThrottlingBwRulesBandwidth-Rule": { + "description": "Statistics for this job", + "properties": { + "bw_limit": { + "description": "Bandwidth limit, in bytes/s", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "Unique ID of the Bandwidth throttling rule.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "netmask": { + "description": "Netmask in the presentation format, e.g. 192.168.0.100/16 or 2001:0db8:85a3:0000:0000:8a2e:0370:7334/64", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "rule_type": { + "description": "Type of Bandwidth throttling rule.", + "enum": [ + "NETMASK" + ], + "type": "string" + } + }, + "type": "object" + }, + "v15ThrottlingBwRulesExtended": { + "additionalProperties": false, + "properties": { + "bandwidth-rules": { + "items": { + "$ref": "#/definitions/v15ThrottlingBwRulesBandwidth-Rule" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v15ThrottlingSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v15ThrottlingSettingsSettings" + } + }, + "type": "object" + }, + "v15ThrottlingSettingsSettings": { + "description": "Datamover throttling related settings", + "properties": { + "allowed_cpu_threshold": { + "description": "Allowed CPU percentage threshold for the Datamover", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "system_cpu_load_threshold": { + "description": "System CPU load threshold at which Datamover will backoff (if consuming above the allowed CPU percentage)", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v1AdsProviderControllers": { + "additionalProperties": false, + "properties": { + "controllers": { + "items": { + "$ref": "#/definitions/v1AdsProviderControllersController" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AdsProviderControllersController": { + "description": "Specifies a controller for an ADS provider.", + "properties": { + "dc_address": { + "description": "Specifies the address for the domain controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "dc_name": { + "description": "Specifies the name of the domain controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the address for the domain controller. This value is the same as the 'dc_address' value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AdsProviderDomains": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/v1AdsProviderDomainsDomain" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AdsProviderDomainsDomain": { + "description": "Specifies properties for trusted domains of configured ADS providers.", + "properties": { + "dc_address": { + "description": "Specifies the address for the domain controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "dc_name": { + "description": "Specifies the name for the domain controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain": { + "description": "Specifies the name of the domain.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "guid": { + "description": "Specifies the globally unique ID for the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies a unique identifier for every domain returned.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name for the domain.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "sid": { + "description": "Specifies the security ID for the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "site": { + "description": "Specifies the site that the cluster is in for that domain.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "Specifies the status of the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "trust_type": { + "description": "Specifies the type of trust for this domain. Options include 'primary', 'unknown', 'external', and 'forest'.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AuditSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v1AuditSettingsSettings" + } + }, + "type": "object" + }, + "v1AuditSettingsSettings": { + "description": "Settings for Audit.", + "properties": { + "audited_zones": { + "description": "Specifies zones that are audited when the protocol_auditing_enabled property is enabled.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "cee_log_time": { + "description": "Specifies that events past a certain date are forwarded by the audit CEE forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS'.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cee_server_uris": { + "description": "Specifies a list of Common Event Enabler (CEE) server URIs. Protocol audit logs are sent to these URIs for external processing.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "config_auditing_enabled": { + "description": "Specifies whether logging for API configuration changes are enabled.", + "type": "boolean" + }, + "config_syslog_enabled": { + "description": "Specifies whether configuration audit syslog messages are forwarded.", + "type": "boolean" + }, + "hostname": { + "description": "Specifies the hostname that is reported in protocol events from this cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "protocol_auditing_enabled": { + "description": "Specifies if logging for the I/O stream is enabled.", + "type": "boolean" + }, + "syslog_log_time": { + "description": "Specifies that events past a specified date are forwarded by the audit syslog forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS' format", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AuditTopic": { + "description": "Specifies the configuration settings for an audit topic.", + "properties": { + "max_cached_messages": { + "description": "Specifies the maximum number of messages that can be sent and received at the same time. Messages that are sent and received at the same time can be lost if a system crash occurs. You can prevent message loss by setting this property to 0, which sets audit logs to synchronous.", + "maximum": 16384, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Specifies the name of the audit topic.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v1AuditTopicExtended": { + "description": "Specifies the configuration settings for an audit topic.", + "properties": { + "id": { + "description": "Specifies the system-provided ID for the audit topic.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "max_cached_messages": { + "description": "Specifies the maximum number of messages that can be sent and received at the same time. Messages that are sent and received at the same time can be lost if a system crash occurs. You can prevent message loss by setting this property to 0, which sets audit logs to synchronous.", + "maximum": 16384, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Specifies the name of the audit topic.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AuditTopicExtendedExtended": { + "description": "Specifies the configuration settings for an audit topic.", + "properties": { + "id": { + "description": "Specifies the system-provided ID for the audit topic.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "max_cached_messages": { + "description": "Specifies the maximum number of messages that can be sent and received at the same time. Messages that are sent and received at the same time can be lost if a system crash occurs. You can prevent message loss by setting this property to 0, which sets audit logs to synchronous.", + "maximum": 16384, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1AuditTopics": { + "additionalProperties": false, + "properties": { + "topics": { + "items": { + "$ref": "#/definitions/v1AuditTopicExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthAccess": { + "additionalProperties": false, + "properties": { + "access": { + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItem": { + "description": "Specifies access permissions that the user has to the file information.", + "properties": { + "file": { + "$ref": "#/definitions/v1AuthAccessAccessItemFile" + }, + "id": { + "description": "Specifies the ID of the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "share": { + "$ref": "#/definitions/v1AuthAccessAccessItemShare" + }, + "user": { + "$ref": "#/definitions/v1AuthAccessAccessItemShareEffectiveUser" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItemFile": { + "description": "Specifies properties for access rights.", + "properties": { + "effective_path": { + "description": "Specifies absolute path in filesystem.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "file_permissions": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileFilePermissions" + }, + "group": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "is_snapshot": { + "description": "Specifies whether path is inside snapshot.", + "type": "boolean" + }, + "owner": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItemFileFilePermissions": { + "description": "Specifies a list of the relevant share permissions for the user.", + "properties": { + "delete_child": { + "description": "Specifies if the parent directory has the delete_child property set for the user. If the delete_child property is set for a user, that user is able to delete the file.", + "type": "boolean" + }, + "expected": { + "description": "Specifies the expected access rights for the user on the file.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "mode": { + "description": "Specifies the mode bits on the file.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ownership": { + "description": "True if the user owns the file.", + "type": "boolean" + }, + "relevant_aces": { + "description": "Specifies a list of the relevant Access Control Entrieswith respect to the user in the share.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemShareSharePermissionsShareRelevantAce" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "relevant_mode": { + "description": "Specifies the mode bits that are related to the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sticky": { + "description": "Specifies if the parent directory has the sticky bit property set indicating only the file's owner may delete the file.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItemFileGroup": { + "description": "Specifies the persona of the file group.", + "properties": { + "id": { + "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", + "maxLength": 261, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the persona name, which must be combined with a type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "Specifies the type of persona, which must be combined with a name.", + "enum": [ + "user", + "group", + "wellknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItemShare": { + "description": "Specifies the permissions that the user has on the share.", + "properties": { + "effective_user": { + "$ref": "#/definitions/v1AuthAccessAccessItemShareEffectiveUser" + }, + "share_permissions": { + "$ref": "#/definitions/v1AuthAccessAccessItemShareSharePermissions" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItemShareEffectiveUser": { + "description": "Returns the effective user based on share settings.", + "properties": { + "id": { + "description": "Specifies the serialized form of the persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the persona name, which must be combined with a type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "Specifies the type, which must be combined with a name.", + "enum": [ + "user", + "group", + "wellknown" + ], + "type": "string" + }, + "uid": { + "description": "Specifies the uid of the user.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItemShareSharePermissions": { + "description": "Specifies share permissions.", + "properties": { + "expected_permissions": { + "description": "Returns Share level permissions for the user.{ 'read' , 'write' , 'full' or 'none' will be the values}", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "impersonate_guest": { + "description": "Returns whether impersonate guest setting is enabled for the user on the share.", + "type": "boolean" + }, + "impersonate_user": { + "description": "Returns whether impersonate user setting is enabled on the share", + "type": "boolean" + }, + "run_as_root": { + "description": "Returns whether run as root is enabled for the user on the share", + "type": "boolean" + }, + "share_relevant_aces": { + "description": "Specifies a list of the relevant Access Control Entries withrespect to the user in the share.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemShareSharePermissionsShareRelevantAce" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthAccessAccessItemShareSharePermissionsShareRelevantAce": { + "description": "Specifies properties for an Access Control Entry.", + "properties": { + "ace": { + "description": "Specifies properties for an Access Control Entry", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AuthGroup": { + "description": "Specifies the configuration properties for a group.", + "properties": { + "gid": { + "description": "Specifies the numeric group identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "members": { + "description": "Specifies the members of the group.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the group name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "sid": { + "description": "Specifies the security identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_AUTH_GROUPS" + }, + "v1AuthGroupExtended": { + "description": "Specifies configuration properties for a group.", + "properties": { + "dn": { + "description": "Specifies the distinguished name for the user.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "dns_domain": { + "description": "Specifies the DNS domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain": { + "description": "Specifies the domain that the object is part of.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generated_gid": { + "description": "If true, the GID was generated.", + "type": "boolean" + }, + "gid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "id": { + "description": "Specifies the user or group ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "member_of": { + "description": "Specifies the groups that this user or group are members of.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "object_history": { + "items": { + "$ref": "#/definitions/v1AuthGroupObjectHistoryItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "provider": { + "description": "Specifies the authentication provider that the object belongs to.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sam_account_name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": { + "description": "Specifies the object type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "dn", + "domain", + "generated_gid", + "name", + "member_of", + "sid", + "dns_domain", + "sam_account_name", + "gid", + "provider", + "type", + "id" + ], + "type": "object" + }, + "v1AuthGroupExtendedExtended": { + "description": "Specifies the configuration properties for a group.", + "properties": { + "gid": { + "description": "Specifies the numeric group identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1AuthGroupObjectHistoryItem": { + "properties": { + "gid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "uid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + "type": "object" + }, + "v1AuthGroups": { + "additionalProperties": false, + "properties": { + "groups": { + "items": { + "$ref": "#/definitions/v1AuthGroupExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_AUTH_GROUPS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AuthGroupsExtended": { + "additionalProperties": false, + "properties": { + "groups": { + "items": { + "$ref": "#/definitions/v1AuthGroupExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthId": { + "properties": { + "ntoken": { + "$ref": "#/definitions/v1AuthIdNtoken" + } + }, + "type": "object" + }, + "v1AuthIdNtoken": { + "description": "Specifies properties for a security token for the currently authenticated user.", + "properties": { + "additional_id": { + "description": "Specifies additional UIDs, GIDs, and SIDs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "group_sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ifs_restricted": { + "description": "Indicates if this user has restricted access to the /ifs file system.", + "type": "boolean" + }, + "local_address": { + "description": "Specifies the IP address of the node that is serving the request.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "on_disk_group_id": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "on_disk_user_id": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "privilege": { + "description": "Specifies the privileges granted to the currently authenticated user.", + "items": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "protocol": { + "description": "Specifies the protocol that is responsible for the creation of the token. The integer values for each protocol are as follows: NFS (1), SMB (2), NLM (3), FTP (4), HTTP (5), ISCSI (7), SMB2 (8), NFS4 (9), OneFS API (10), HDFS (15), console (16), and SSH (17).", + "maximum": 128, + "minimum": 0, + "type": "integer" + }, + "remote_address": { + "description": "Specifies the IP address of the client requesting information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "user_sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "zid": { + "description": "Specifies the zone ID of the access zone that is serving the request.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "zone_id": { + "description": "Specifies the name of the access zone that is serving the request.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AuthIdNtokenPrivilegeItem": { + "description": "Specifies the system-defined privilege that may be granted to users.", + "properties": { + "id": { + "description": "Specifies the ID of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "read_only": { + "description": "True, if the privilege is read-only.", + "type": "boolean" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v1AuthNetgroup": { + "properties": { + "domainname": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hostname": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "netgroup": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "username": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1AuthNetgroups": { + "additionalProperties": false, + "properties": { + "netgroups": { + "items": { + "$ref": "#/definitions/v1AuthNetgroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthPrivilege": { + "description": "Specifies the system-defined privilege that may be granted to users.", + "properties": { + "category": { + "description": "Specifies the general categorization of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Specifies a short description of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the privilege.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "read_write": { + "description": "True, if the privilege is read-write.", + "type": "boolean" + } + }, + "required": [ + "category", + "description", + "id" + ], + "type": "object" + }, + "v1AuthPrivileges": { + "additionalProperties": false, + "properties": { + "privileges": { + "items": { + "$ref": "#/definitions/v1AuthPrivilege" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthRole": { + "description": "Specifies the role maps privileges to users and groups.", + "properties": { + "description": { + "description": "Specifies the description of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "members": { + "description": "Specifies the users or groups that have this role.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the role.", + "maxLength": 255, + "minLength": 0, + "pattern": "^[^ \t\n](.*[^ \t\n])*$", + "type": "string" + }, + "privileges": { + "description": "Specifies the privileges granted by this role.", + "items": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v1AuthRoleExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1AuthRole" + }, + { + "description": "Specifies the role maps privileges to users and groups.", + "properties": { + "description": { + "description": "Specifies the description of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "members": { + "description": "Specifies the users or groups that have this role.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "privileges": { + "description": "Specifies the privileges granted by this role.", + "items": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "privileges", + "description", + "members", + "id" + ], + "type": "object" + } + ] + }, + "v1AuthRoleExtendedExtended": { + "description": "Specifies the role maps privileges to users and groups.", + "properties": { + "description": { + "description": "Specifies the description of the role.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "members": { + "description": "Specifies the users or groups that have this role.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the role.", + "maxLength": 255, + "minLength": 0, + "pattern": "^[^ \t\n](.*[^ \t\n])*$", + "type": "string" + }, + "privileges": { + "description": "Specifies the privileges granted by this role.", + "items": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthRoles": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "roles": { + "items": { + "$ref": "#/definitions/v1AuthRoleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1AuthRolesExtended": { + "additionalProperties": false, + "properties": { + "roles": { + "items": { + "$ref": "#/definitions/v1AuthRoleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthShells": { + "description": "The list of supported shells.", + "properties": { + "shells": { + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthUser": { + "description": "Specifies the configuration properties for a user.", + "properties": { + "email": { + "description": "Specifies an email address for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "If true, the authenticated user is enabled.", + "type": "boolean" + }, + "expiry": { + "description": "Specifies the Unix Epoch time when the auth user will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gecos": { + "description": "Specifies the GECOS value, which is usually the full name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory": { + "description": "Specifies a home directory for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies a user name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Changes the password for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_expires": { + "description": "If true, the password should expire.", + "type": "boolean" + }, + "primary_group": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "prompt_password_change": { + "description": "If true, prompts the user to change their password at the next login.", + "type": "boolean" + }, + "shell": { + "description": "Specifies the shell for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "sid": { + "description": "Specifies a security identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "description": "Specifies a numeric user identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unlock": { + "description": "If true, the user account should be unlocked.", + "type": "boolean" + } + }, + "required": [ + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_AUTH_USERS" + }, + "v1AuthUserExtended": { + "description": "Specifies the configuration properties for a user.", + "properties": { + "email": { + "description": "Specifies an email address for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "If true, the authenticated user is enabled.", + "type": "boolean" + }, + "expiry": { + "description": "Specifies the Unix Epoch time when the auth user will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gecos": { + "description": "Specifies the GECOS value, which is usually the full name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory": { + "description": "Specifies a home directory for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Changes the password for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_expires": { + "description": "If true, the password should expire.", + "type": "boolean" + }, + "primary_group": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "prompt_password_change": { + "description": "If true, prompts the user to change their password at the next login.", + "type": "boolean" + }, + "shell": { + "description": "Specifies the shell for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "sid": { + "description": "Specifies a security identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "description": "Specifies a numeric user identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unlock": { + "description": "If true, the user account should be unlocked.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_AUTH_USERS" + }, + "v1AuthUsers": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "users": { + "items": { + "$ref": "#/definitions/v1MappingUsersLookupMappingItemUser" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_AUTH_USERS" + } + }, + "type": "object" + }, + "v1AuthUsersExtended": { + "additionalProperties": false, + "properties": { + "users": { + "items": { + "$ref": "#/definitions/v1MappingUsersLookupMappingItemUser" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1AuthWellknowns": { + "additionalProperties": false, + "properties": { + "wellknowns": { + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ChangelistLin": { + "properties": { + "atime": { + "$ref": "#/definitions/v1ChangelistLinCtime" + }, + "ctime": { + "$ref": "#/definitions/v1ChangelistLinCtime" + }, + "id": { + "description": "The LIN number of the file associated with the entry.", + "type": "string" + }, + "mtime": { + "$ref": "#/definitions/v1ChangelistLinCtime" + }, + "path": { + "description": "The path to the file associated with the entry.", + "type": "string" + }, + "size": { + "description": "The size of the file associated with the entry.", + "type": "integer" + }, + "type": { + "description": "Type of file.", + "type": "string" + } + }, + "required": [ + "path", + "type", + "id", + "size" + ], + "type": "object" + }, + "v1ChangelistLinCtime": { + "properties": { + "nsec": { + "description": "Nanoseconds component of timespec.", + "type": "integer" + }, + "sec": { + "description": "Seconds component of timespec.", + "type": "integer" + } + }, + "required": [ + "sec" + ], + "type": "object" + }, + "v1ChangelistLins": { + "additionalProperties": false, + "properties": { + "lins": { + "items": { + "$ref": "#/definitions/v1ChangelistLin" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1ClusterConfig": { + "description": "General cluster information.", + "properties": { + "description": { + "description": "Customer configurable description.", + "type": "string" + }, + "devices": { + "items": { + "$ref": "#/definitions/v1ClusterConfigDevice" + }, + "type": "array" + }, + "encoding": { + "description": "Default encoding.", + "type": "string" + }, + "guid": { + "description": "Cluster GUID.", + "type": "string" + }, + "is_compliance": { + "description": "If true, the cluster is in compliance mode. Compliance mode clusters do not allow root access and have stricter WORM (Write Once Read Many) features for retaining data in compliance with U.S. Securities and Exchange Commission rule 17a-4.", + "type": "boolean" + }, + "is_rolling_upgrade": { + "description": "If true, the cluster is currently performing a rolling upgrade. A false value means no upgrade is occurring or that the upgrade status cannot be determined.", + "type": "boolean" + }, + "join_mode": { + "description": "Node join mode: 'manual' or 'secure'.", + "type": "string" + }, + "local_devid": { + "description": "Device ID of the queried node.", + "type": "integer" + }, + "local_lnn": { + "description": "Device logical node number of the queried node.", + "type": "integer" + }, + "local_serial": { + "description": "Device serial number of the queried node.", + "type": "string" + }, + "name": { + "description": "Cluster name.", + "type": "string" + }, + "onefs_version": { + "$ref": "#/definitions/v1ClusterConfigOnefsVersion" + }, + "timezone": { + "$ref": "#/definitions/v1ClusterConfigTimezone" + } + }, + "required": [ + "local_devid", + "is_compliance", + "description", + "encoding", + "join_mode", + "local_serial", + "devices", + "is_rolling_upgrade", + "guid", + "local_lnn", + "name" + ], + "type": "object" + }, + "v1ClusterConfigDevice": { + "properties": { + "devid": { + "description": "Device ID.", + "type": "integer" + }, + "guid": { + "description": "Device GUID.", + "type": "string" + }, + "lnn": { + "description": "Device logical node number.", + "type": "integer" + } + }, + "required": [ + "guid", + "devid", + "lnn" + ], + "type": "object" + }, + "v1ClusterConfigOnefsVersion": { + "properties": { + "build": { + "description": "OneFS build string.", + "type": "string" + }, + "release": { + "description": "Kernel release number.", + "type": "string" + }, + "revision": { + "description": "OneFS build number.", + "type": "string" + }, + "type": { + "description": "Kernel release type.", + "type": "string" + }, + "version": { + "description": "Kernel full version information.", + "type": "string" + } + }, + "required": [ + "release", + "version", + "type", + "build", + "revision" + ], + "type": "object" + }, + "v1ClusterConfigTimezone": { + "description": "The cluster timezone settings.", + "properties": { + "abbreviation": { + "description": "Timezone abbreviation.", + "type": "string" + }, + "custom": { + "description": "Customer timezone information.", + "type": "string" + }, + "name": { + "description": "Timezone full name.", + "type": "string" + }, + "path": { + "description": "Timezone hierarchical name.", + "type": "string" + } + }, + "type": "object" + }, + "v1ClusterEmail": { + "properties": { + "settings": { + "$ref": "#/definitions/v1ClusterEmailSettings" + } + }, + "type": "object" + }, + "v1ClusterEmailExtended": { + "description": "Cluster email notification settings.", + "properties": { + "batch_mode": { + "description": "This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.", + "enum": [ + "all", + "severity", + "category", + "none" + ], + "type": "string" + }, + "mail_relay": { + "description": "The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "mail_sender": { + "description": "The full email address that will appear as the sender of notification messages.", + "maxLength": 254, + "minLength": 3, + "pattern": "[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}", + "type": "string" + }, + "mail_subject": { + "description": "The subject line for notification messages from this cluster.", + "maxLength": 990, + "minLength": 0, + "type": "string" + }, + "smtp_auth_passwd": { + "description": "Password to authenticate with if SMTP authentication is being used.", + "type": "string" + }, + "smtp_auth_security": { + "description": "The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.", + "enum": [ + "none", + "starttls" + ], + "type": "string" + }, + "smtp_auth_username": { + "description": "Username to authenticate with if SMTP authentication is being used. Pattern should be of type : ^[^]\"/\\[\\:;|=,+*?<>$]+", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "smtp_port": { + "description": "The port on the SMTP server to be used for relaying the notification messages.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "use_smtp_auth": { + "description": "If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.", + "type": "boolean" + }, + "user_template": { + "description": "Location of a custom template file that can be used to specify the layout of the notification emails.", + "pattern": "^/ifs$|^/ifs/", + "type": "string" + } + }, + "type": "object" + }, + "v1ClusterEmailSettings": { + "description": "Cluster email notification settings.", + "properties": { + "batch_mode": { + "description": "This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.", + "enum": [ + "all", + "severity", + "category", + "none" + ], + "type": "string" + }, + "mail_relay": { + "description": "The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "mail_sender": { + "description": "The full email address that will appear as the sender of notification messages.", + "maxLength": 254, + "type": "string" + }, + "mail_subject": { + "description": "The subject line for notification messages from this cluster.", + "maxLength": 990, + "minLength": 0, + "type": "string" + }, + "smtp_auth_passwd_set": { + "description": "Indicates if an SMTP authentication password is set.", + "type": "boolean" + }, + "smtp_auth_security": { + "description": "The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.", + "enum": [ + "none", + "starttls" + ], + "type": "string" + }, + "smtp_auth_username": { + "description": "Username to authenticate with if SMTP authentication is being used.", + "maxLength": 256, + "type": "string" + }, + "smtp_port": { + "description": "The port on the SMTP server to be used for relaying the notification messages.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "use_smtp_auth": { + "description": "If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.", + "type": "boolean" + }, + "user_template": { + "description": "Location of a custom template file that can be used to specify the layout of the notification emails.", + "type": "string" + } + }, + "required": [ + "smtp_auth_security", + "user_template", + "use_smtp_auth", + "smtp_auth_username", + "smtp_port", + "mail_subject", + "mail_sender", + "mail_relay", + "smtp_auth_passwd_set", + "batch_mode" + ], + "type": "object" + }, + "v1ClusterIdentity": { + "description": "Unprivileged cluster information for display when logging in.", + "properties": { + "description": { + "description": "A description of the cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logon": { + "$ref": "#/definitions/v1ClusterIdentityLogon" + }, + "name": { + "description": "The name of the cluster.", + "type": "string" + } + }, + "required": [ + "logon", + "description", + "name" + ], + "type": "object" + }, + "v1ClusterIdentityLogon": { + "description": "The information displayed when a user logs in to the cluster.", + "properties": { + "motd": { + "description": "The message of the day.", + "type": "string" + }, + "motd_header": { + "description": "The header to the message of the day.", + "type": "string" + } + }, + "required": [ + "motd_header", + "motd" + ], + "type": "object" + }, + "v1ClusterOwner": { + "description": "Cluster contact info settings.", + "properties": { + "company": { + "description": "Cluster owner company name.", + "type": "string" + }, + "location": { + "description": "Cluster owner location.", + "type": "string" + }, + "primary_email": { + "description": "Cluster owner primary email address.", + "type": "string" + }, + "primary_name": { + "description": "Cluster owner primary contact name.", + "type": "string" + }, + "primary_phone1": { + "description": "Cluster owner primary contact phone number 1.", + "type": "string" + }, + "primary_phone2": { + "description": "Cluster owner primary contact phone number 2.", + "type": "string" + }, + "secondary_email": { + "description": "Cluster owner secondary email address.", + "type": "string" + }, + "secondary_name": { + "description": "Cluster owner secondary contact name.", + "type": "string" + }, + "secondary_phone1": { + "description": "Cluster owner secondary contact phone number 1.", + "type": "string" + }, + "secondary_phone2": { + "description": "Cluster owner secondary contact phone number 2.", + "type": "string" + } + }, + "type": "object" + }, + "v1ClusterStatfs": { + "description": "Filesystem statistics", + "properties": { + "f_bavail": { + "description": "The number of free blocks available to non-superuser.", + "type": "integer" + }, + "f_bfree": { + "description": "The number of free blocks in the filesystem.", + "type": "integer" + }, + "f_blocks": { + "description": "The total number of data blocks in the filesystem.", + "type": "integer" + }, + "f_bsize": { + "description": "The filesystem fragment size.", + "type": "integer" + }, + "f_ffree": { + "description": "The number of free nodes available to non-superuser.", + "type": "integer" + }, + "f_files": { + "description": "The total number of file nodes in the filesystem.", + "type": "integer" + }, + "f_flags": { + "description": "A copy of the mount exported flags.", + "type": "integer" + }, + "f_fstypename": { + "description": "The filesystem type name.", + "type": "string" + }, + "f_iosize": { + "description": "The optimal transfer block size.", + "type": "integer" + }, + "f_mntfromname": { + "description": "The name of the mounted filesystem.", + "type": "string" + }, + "f_mntonname": { + "description": "The directory that the filesystem is mounted on.", + "type": "string" + }, + "f_namemax": { + "description": "The maximum length of a file name.", + "type": "integer" + }, + "f_owner": { + "description": "The ID of the user that mounted the filesystem.", + "type": "integer" + }, + "f_type": { + "description": "The type of the filesystem.", + "type": "integer" + }, + "f_version": { + "description": "The structure version number.", + "type": "integer" + } + }, + "required": [ + "f_type", + "f_bsize", + "f_bavail", + "f_owner", + "f_iosize", + "f_files", + "f_mntfromname", + "f_blocks", + "f_ffree", + "f_bfree", + "f_mntonname", + "f_namemax", + "f_version", + "f_flags", + "f_fstypename" + ], + "type": "object" + }, + "v1ClusterTime": { + "properties": { + "time": { + "description": "The current time on the cluster.", + "type": "integer" + } + }, + "required": [ + "time" + ], + "type": "object" + }, + "v1DebugStats": { + "description": "Statistics for all the methods of all URIs in the Platform API.", + "properties": { + "DESCRIBE": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "UNKNOWN": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "handlers": { + "items": { + "$ref": "#/definitions/v1DebugStatsHandler" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1DebugStatsHandler": { + "properties": { + "DELETE": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "GET": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "HEAD": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "POST": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "PUT": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "UNSUPPORTED": { + "$ref": "#/definitions/v1DebugStatsUnknown" + }, + "name": { + "description": "The URI.", + "type": "string" + } + }, + "type": "object" + }, + "v1DebugStatsUnknown": { + "description": "Per-method statistics.", + "properties": { + "calls": { + "description": "The number of calls.", + "type": "integer" + }, + "errors": { + "description": "The number of errors.", + "type": "integer" + }, + "time": { + "description": "The total amount of time spent in this method.", + "type": "number" + } + }, + "type": "object" + }, + "v1DedupeDedupeSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v1DedupeDedupeSummarySummary" + } + }, + "type": "object" + }, + "v1DedupeDedupeSummarySummary": { + "properties": { + "block_size": { + "description": "Size in bytes of a filesystem block.", + "type": "number" + }, + "estimated_physical_blocks": { + "description": "Estimated number of physical blocks deduped.", + "type": "number" + }, + "estimated_saved_blocks": { + "description": "Estimated number of physical blocks saved by dedupe.", + "type": "number" + }, + "logical_blocks": { + "description": "Number of logical blocks deduped.", + "type": "number" + }, + "saved_logical_blocks": { + "description": "Number of logical blocks saved by dedupe.", + "type": "number" + }, + "total_blocks": { + "description": "Total physical blocks in the cluster.", + "type": "number" + }, + "used_blocks": { + "description": "Total physical blocks used in the cluster.", + "type": "number" + } + }, + "required": [ + "estimated_saved_blocks", + "used_blocks", + "estimated_physical_blocks", + "saved_logical_blocks", + "total_blocks", + "logical_blocks", + "block_size" + ], + "type": "object" + }, + "v1DedupeReport": { + "properties": { + "phase": { + "description": "The phase of the job this report was generated for.", + "type": "integer" + }, + "results": { + "description": "The report results.", + "type": "string" + }, + "time": { + "description": "The time this report was generated in Unix epoch seconds.", + "type": "integer" + } + }, + "type": "object" + }, + "v1DedupeReportExtended": { + "description": "A report for a dedupe job.", + "properties": { + "dedupe_percent": { + "description": "The amount of space the directory trees under this job's paths now take up, compared to what they would take up if not deduplicated (0 ~ 100).", + "type": "string" + }, + "elapsed_time": { + "description": "The amount of time in seconds it took to run this job.", + "type": "integer" + }, + "id": { + "description": "An unique identifier for this report.", + "type": "integer" + }, + "job_id": { + "description": "The job id this report refers to.", + "type": "integer" + }, + "job_type": { + "description": "The type of dedupe job this report refers to.", + "type": "string" + }, + "reports": { + "description": "A list of report entries for this dedupe job.", + "items": { + "$ref": "#/definitions/v1DedupeReport" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1DedupeReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1DedupeReportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1DedupeReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1DedupeReportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1DedupeSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v1DedupeSettingsSettings" + } + }, + "type": "object" + }, + "v1DedupeSettingsExtended": { + "description": "Dedupe settings.", + "properties": { + "assess_paths": { + "description": "The paths that will be assessed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "paths": { + "description": "The paths that will be deduped.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1DedupeSettingsSettings": { + "description": "Dedupe settings.", + "properties": { + "assess_paths": { + "description": "The paths that will be assessed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "dedupe_schedule": { + "description": "The schedule for the dedupe job.", + "type": "string" + }, + "paths": { + "description": "The paths that will be deduped.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1FilepoolDefaultPolicy": { + "description": "A default filepool policy object", + "properties": { + "default-policy": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyDefault-Policy" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_DEFAULT_POLICY" + }, + "v1FilepoolDefaultPolicyAction": { + "description": "An action to apply to a file matching the policy", + "properties": { + "action_param": { + "description": "Varies according to action_type", + "type": "string" + }, + "action_type": { + "enum": [ + "set_requested_protection", + "set_data_access_pattern", + "enable_coalescer", + "apply_data_storage_policy", + "apply_snapshot_storage_policy", + "set_cloudpool_policy", + "enable_packing" + ], + "type": "string" + } + }, + "required": [ + "action_param", + "action_type" + ], + "type": "object" + }, + "v1FilepoolDefaultPolicyDefault-Policy": { + "description": "A default filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyDefault-PolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v1FilepoolDefaultPolicyDefault-PolicyAction": { + "description": "An action to apply to a file matching the policy", + "properties": { + "action_param": { + "description": "Varies according to action_type", + "type": "string" + }, + "action_type": { + "enum": [ + "set_requested_protection", + "set_data_access_pattern", + "enable_coalescer", + "apply_data_storage_policy", + "apply_snapshot_storage_policy", + "set_cloudpool_policy" + ], + "type": "string" + } + }, + "required": [ + "action_param", + "action_type" + ], + "type": "object" + }, + "v1FilepoolDefaultPolicyExtended": { + "additionalProperties": false, + "properties": { + "actions": { + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyAction" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_DEFAULT_POLICY" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v1FilepoolPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v1FilepoolPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_POLICIES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1FilepoolPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v1FilepoolPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1FilepoolPolicy": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyDefault-PolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "actions", + "file_matching_pattern" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_POLICIES" + }, + "v1FilepoolPolicyExtended": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyDefault-PolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "birth_cluster_id": { + "description": "The guid assigned to the cluster on which the account was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "id": { + "description": "A unique identifier for this policy", + "type": "integer" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + }, + "state": { + "description": "Indicates whether this policy is in a good state (\"OK\") or disabled (\"disabled\")", + "enum": [ + "OK", + "disabled" + ], + "type": "string" + }, + "state_details": { + "description": "Gives further information to describe the state of this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v1FilepoolPolicyExtendedExtended": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyDefault-PolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v1FilepoolPolicyFileMatchingPattern": { + "description": "The file matching rules for this policy", + "properties": { + "or_criteria": { + "items": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPatternOrCriteriaItem" + }, + "maxItems": 3, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "or_criteria" + ], + "type": "object" + }, + "v1FilepoolPolicyFileMatchingPatternOrCriteriaItem": { + "properties": { + "and_criteria": { + "items": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPatternOrCriteriaItemAndCriteriaItem" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "and_criteria" + ], + "type": "object" + }, + "v1FilepoolPolicyFileMatchingPatternOrCriteriaItemAndCriteriaItem": { + "properties": { + "attribute_exists": { + "description": "Indicates whether the existence of an attribute indicates a match (valid only with 'type' = 'custom_attribute')", + "type": "boolean" + }, + "begins_with": { + "description": "True to match the path exactly, False to match any subtree. (valid only with 'type' = 'path')", + "type": "boolean" + }, + "case_sensitive": { + "description": "True to indicate case sensitivity when comparing file attributes (valid only with 'type' = 'name' or 'type' = 'path')", + "type": "boolean" + }, + "field": { + "description": "File attribute field name to be compared in a custom comparison (valid only with 'type' = 'custom_attribute')", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "operator": { + "description": "The comparison operator to use while comparing an attribute with its value", + "enum": [ + "==", + "!=", + ">", + ">=", + "<", + "<=", + "!" + ], + "type": "string" + }, + "type": { + "description": "The file attribute to be compared to a given value", + "enum": [ + "name", + "path", + "link_count", + "accessed_time", + "birth_time", + "changed_time", + "metadata_changed_time", + "size", + "file_type", + "custom_attribute" + ], + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "units": { + "description": "Size unit value. One of 'B','KB','MB','GB','TB','PB','EB' (valid only with 'type' = 'size')", + "maxLength": 2, + "minLength": 1, + "type": "string" + }, + "use_relative_time": { + "description": "Whether time units refer to a calendar date and time (e.g., Jun 3, 2009) or a relative duration (e.g., 2 weeks) (valid only with 'type' in {accessed_time, birth_time, changed_time or metadata_changed_time}", + "type": "boolean" + }, + "value": { + "description": "The value to be compared against a file attribute", + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v1FilepoolTemplates": { + "additionalProperties": false, + "properties": { + "templates": { + "items": { + "$ref": "#/definitions/v1FilepoolPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_TEMPLATES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1FilepoolTemplatesExtended": { + "additionalProperties": false, + "properties": { + "templates": { + "items": { + "$ref": "#/definitions/v1FilepoolPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1FsaResult": { + "properties": { + "begin_time": { + "description": "Unix Epoch time of start of results collection job.", + "type": "integer" + }, + "content_path": { + "description": "Path to results database.", + "type": "string" + }, + "delete_link": { + "description": "Resource to call with DELETE to remove results..", + "type": "string" + }, + "end_time": { + "description": "Unix Epoch time of end of results collection job.", + "type": "integer" + }, + "fsa_state": { + "description": "State of the result set.", + "enum": [ + "unknown", + "work", + "reduce", + "publish" + ], + "type": "string" + }, + "id": { + "description": "The system generated result set ID.", + "type": "integer" + }, + "job_state": { + "description": "State information about the FSA Job.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pinned": { + "description": "True if the result is pinned to prevent automatic removal.", + "type": "boolean" + }, + "properties_link": { + "description": "Resource to call to get result properties.", + "type": "string" + }, + "version": { + "description": "FSA version used to create result set.", + "type": "integer" + } + }, + "required": [ + "properties_link", + "job_state", + "content_path", + "fsa_state", + "delete_link", + "pinned", + "version", + "end_time", + "begin_time", + "id" + ], + "type": "object" + }, + "v1FsaResultExtended": { + "properties": { + "pinned": { + "description": "True if the result is pinned to prevent automatic removal.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1FsaResults": { + "additionalProperties": false, + "properties": { + "results": { + "items": { + "$ref": "#/definitions/v1FsaResult" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1FsaResultsExtended": { + "additionalProperties": false, + "properties": { + "results": { + "items": { + "$ref": "#/definitions/v1FsaResult" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1FsaSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v1FsaSettingsSettings" + } + }, + "type": "object" + }, + "v1FsaSettingsSettings": { + "properties": { + "default_template": { + "description": "Name of question template to use for new FSA jobs.", + "type": "string" + }, + "disk_usage_depth": { + "description": "Maximum directory depth used for disk_usage question if not specified in the question.", + "type": "integer" + }, + "max_age": { + "description": "Maximum age of non-pinned results in seconds.", + "type": "integer" + }, + "max_count": { + "description": "Maximum number of non-pinned result sets to keep.", + "type": "integer" + }, + "squash_depth": { + "description": "Squash depth to use for squash binning questions if not specified in the question.", + "type": "integer" + }, + "top_n_max": { + "description": "Maximum number of items in a Top-N question result if not specified in the question.", + "type": "integer" + }, + "use_snapshot": { + "description": "If true, use a snapshot for consistency, otherwise analyze head.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1GroupMembers": { + "additionalProperties": false, + "properties": { + "members": { + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1HdfsProxyuser": { + "description": "This is hdfs impersonation information of a proxyuser", + "properties": { + "id": { + "description": "The ID of the role.", + "type": "string" + }, + "members": { + "description": "Users or groups impersonated by proxyuser.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "name": { + "description": "The name of the proxyuser.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_PROXYUSERS" + }, + "v1HdfsProxyuserExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1HdfsProxyuser" + }, + { + "description": "This is hdfs impersonation information of a proxyuser", + "properties": { + "id": { + "description": "The ID of the role.", + "type": "string" + }, + "members": { + "description": "Users or groups impersonated by proxyuser.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + } + }, + "required": [ + "id", + "members" + ], + "type": "object" + } + ] + }, + "v1HdfsProxyusers": { + "additionalProperties": false, + "properties": { + "proxyusers": { + "items": { + "$ref": "#/definitions/v1HdfsProxyuserExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_HDFS_PROXYUSERS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1HdfsProxyusersExtended": { + "additionalProperties": false, + "properties": { + "proxyusers": { + "items": { + "$ref": "#/definitions/v1HdfsProxyuserExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1HdfsRack": { + "description": "This is schema that contains HDFS rack properties.", + "properties": { + "client_ip_ranges": { + "description": "Array of IP ranges. Clients from one of these IP ranges are served by corresponding nodes from ip_pools array.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ip_pools": { + "description": "Array of IP pool names to use for serving clients from client_ip_ranges.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of the rack", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_RACKS" + }, + "v1HdfsRackExtended": { + "description": "This is schema that contains HDFS rack properties.", + "properties": { + "client_ip_ranges": { + "description": "Array of IP ranges. Clients from one of these IP ranges are served by corresponding nodes from ip_pools array.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "The ID of the rack.", + "type": "string" + }, + "ip_pools": { + "description": "Array of IP pool names to use for serving clients from client_ip_ranges.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of the rack", + "type": "string" + } + }, + "type": "object" + }, + "v1HdfsRackExtendedExtended": { + "description": "This is schema that contains HDFS rack properties.", + "properties": { + "client_ip_ranges": { + "description": "Array of IP ranges. Clients from one of these IP ranges are served by corresponding nodes from ip_pools array.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ip_pools": { + "description": "Array of IP pool names to use for serving clients from client_ip_ranges.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of the rack", + "type": "string" + } + }, + "type": "object" + }, + "v1HdfsRacks": { + "additionalProperties": false, + "properties": { + "racks": { + "items": { + "$ref": "#/definitions/v1HdfsRackExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_HDFS_RACKS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1HdfsRacksExtended": { + "additionalProperties": false, + "properties": { + "racks": { + "items": { + "$ref": "#/definitions/v1HdfsRackExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1HistoryFile": { + "additionalProperties": false, + "properties": { + "statistics": { + "items": { + "$ref": "#/definitions/v1HistoryFileStatistic" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1HistoryFileStatistic": { + "allOf": [ + { + "$ref": "#/definitions/v3HistoryCpuStatistic" + }, + { + "description": "A synciq performance report.", + "properties": { + "name": { + "description": "The name of the SyncIQ policy if specified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + ] + }, + "v1HistoryNetwork": { + "additionalProperties": false, + "properties": { + "statistics": { + "items": { + "$ref": "#/definitions/v1HistoryNetworkStatistic" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1HistoryNetworkStatistic": { + "allOf": [ + { + "$ref": "#/definitions/v3HistoryCpuStatistic" + }, + { + "description": "A synciq performance report.", + "properties": { + "name": { + "description": "The name of the SyncIQ policy if specified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + ] + }, + "v1JobEvent": { + "properties": { + "id": { + "description": "Job event ID.", + "type": "string" + }, + "job_id": { + "description": "Job ID.", + "minimum": 1, + "type": "integer" + }, + "job_type": { + "description": "Job Type.", + "type": "string" + }, + "message": { + "description": "Description of event.", + "type": "string" + }, + "phase": { + "description": "Job phase number at time of event.", + "type": "integer" + }, + "policy": { + "description": "Policy in effect for job at time of event.", + "type": "string" + }, + "progress": { + "description": "Job-type-specific progress indication.", + "type": "string" + }, + "running_time": { + "description": "Total running time of job.", + "type": "integer" + }, + "state": { + "description": "State of job associated with event.", + "type": "string" + }, + "time": { + "description": "Time of event in Unix epoch seconds.", + "type": "integer" + } + }, + "required": [ + "job_id", + "job_type", + "policy", + "state", + "time", + "phase", + "progress", + "message", + "id", + "running_time" + ], + "type": "object" + }, + "v1JobEvents": { + "additionalProperties": false, + "properties": { + "events": { + "items": { + "$ref": "#/definitions/v1JobEvent" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1JobJob": { + "properties": { + "allow_dup": { + "description": "Whether or not to queue the job if one of the same type is already running or queued.", + "type": "boolean" + }, + "changelistcreate_params": { + "$ref": "#/definitions/v1JobJobChangelistcreateParams" + }, + "domainmark_params": { + "$ref": "#/definitions/v1JobJobDomainmarkParams" + }, + "esrsmftdownload_params": { + "$ref": "#/definitions/v1JobJobEsrsmftdownloadParams" + }, + "paths": { + "description": "For jobs which take paths, the IFS paths to pass to the job.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "policy": { + "description": "Impact policy of this job instance.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "prepair_params": { + "$ref": "#/definitions/v1JobJobPrepairParams" + }, + "priority": { + "description": "Priority of this job instance; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "smartpoolstree_params": { + "$ref": "#/definitions/v1JobJobSmartpoolstreeParams" + }, + "snaprevert_params": { + "$ref": "#/definitions/v1JobJobSnaprevertParams" + }, + "type": { + "description": "Job type to queue.", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v1JobJobChangelistcreateParams": { + "description": "Parameters required for the ChangelistCreate job.", + "properties": { + "newer_snapid": { + "description": "Newer snapshot ID.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "older_snapid": { + "description": "Older snapshot ID.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "retain_repstate": { + "description": "Whether to retain the replication record after a changelist is created. Retaining a replication record allows a changelist to be recreated later.", + "type": "boolean" + } + }, + "required": [ + "newer_snapid", + "older_snapid" + ], + "type": "object" + }, + "v1JobJobDomainmarkParams": { + "description": "Parameters required for the DomainMark job.", + "properties": { + "delete": { + "description": "Whether this is a delete operation.", + "type": "boolean" + }, + "root": { + "description": "Base IFS path to associate with the domain.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "type": { + "description": "The type of domain.", + "enum": [ + "SnapRevert", + "SyncIQ", + "Worm" + ], + "maxLength": 10, + "minLength": 4, + "type": "string" + } + }, + "required": [ + "type", + "root" + ], + "type": "object" + }, + "v1JobJobEsrsmftdownloadParams": { + "description": "Parameters required for the ESRS MFT Download job.", + "properties": { + "checksum": { + "description": "File Checksum - SHA-256", + "maxLength": 64, + "minLength": 64, + "pattern": "^[a-f0-9A-F]{64}", + "type": "string" + }, + "file": { + "description": "File to download.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "path": { + "description": "Path to write downloaded file. Required to be on /ifs", + "maxLength": 4096, + "minLength": 4, + "pattern": "^\\/ifs", + "type": "string" + }, + "size": { + "description": "File Size", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "checksum", + "size", + "file", + "path" + ], + "type": "object" + }, + "v1JobJobExtended": { + "properties": { + "control_state": { + "description": "State to which the job is transitioning; if control_state is identical to state, the job's state is stable.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority", + "cancelled_user", + "cancelled_system", + "failed", + "succeeded", + "failed_not_retried", + "unknown" + ], + "type": "string" + }, + "create_time": { + "description": "The time the job was queued, in seconds since the epoch.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "current_phase": { + "description": "The current phase of the job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "description": { + "description": "A text representation of the job.", + "maxLength": 2147483646, + "minLength": 0, + "type": "string" + }, + "end_time": { + "description": "The time the job ended, in seconds since the Epoch.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "impact": { + "description": "The current impact of the job.", + "enum": [ + "Low", + "Medium", + "High", + "Paused" + ], + "type": "string" + }, + "participants": { + "description": "The set of devids working on the job.", + "items": { + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "paths": { + "description": "Paths for which the job was queued.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "policy": { + "description": "Current impact policy of the job.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Current priority of the job; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "progress": { + "description": "A text representation of the job's progress.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "retries_remaining": { + "description": "The number of retries remaining if the job fails.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "running_time": { + "description": "The number of seconds the job has executed.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started, in seconds since the Epoch.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "Current state of the job.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority", + "cancelled_user", + "cancelled_system", + "failed", + "succeeded", + "failed_not_retried", + "unknown" + ], + "type": "string" + }, + "total_phases": { + "description": "The total number of phases of the job type.", + "maximum": 15, + "minimum": 1, + "type": "integer" + }, + "type": { + "description": "The job type.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "waiting_on": { + "description": "The ID of a job for which this job is waiting.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "waiting_reason": { + "description": "The reason the job is waiting.", + "enum": [ + "blocked_by_priority" + ], + "type": "string" + } + }, + "required": [ + "impact", + "type", + "state", + "priority", + "create_time", + "policy", + "retries_remaining", + "total_phases", + "id" + ], + "type": "object" + }, + "v1JobJobExtendedExtended": { + "properties": { + "policy": { + "description": "Impact policy of this job instance.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Priority of this job instance; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "state": { + "description": "Desired new state of this job instance.", + "enum": [ + "run", + "pause", + "cancel" + ], + "type": "string" + } + }, + "type": "object" + }, + "v1JobJobPrepairParams": { + "description": "Parameters required for the PermissionRepair job.", + "properties": { + "mapping_type": { + "description": "Type of permissions; not accepted with mode=clone or mode=inherit.", + "enum": [ + "global", + "sid", + "unix", + "native" + ], + "maxLength": 6, + "minLength": 3, + "type": "string" + }, + "mode": { + "description": "Type of PermissionRepair operation.", + "enum": [ + "clone", + "inherit", + "convert" + ], + "maxLength": 8, + "minLength": 5, + "type": "string" + }, + "template": { + "description": "IFS file or directory to use as a template; required with mode=clone and mode=inherit, not accepted with mode=convert.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "zone": { + "description": "Authentication zone; not accepted with mode=clone or mode=inherit.", + "maxLength": 2147483646, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "v1JobJobSmartpoolstreeParams": { + "description": "Optional parameters for the SmartPoolsTree job.", + "properties": { + "directory_only": { + "description": "Skip processing of regular files.", + "type": "boolean" + }, + "nop": { + "description": "Calculate what would be done (dry run).", + "type": "boolean" + }, + "policy_only": { + "description": "Apply policies but skip restriping.", + "type": "boolean" + }, + "recurse": { + "description": "Process children, recursively.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1JobJobSnaprevertParams": { + "description": "Parameters required for the SnapRevert job.", + "properties": { + "snapid": { + "description": "Snapshot to revert.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "snapid" + ], + "type": "object" + }, + "v1JobJobSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v1JobJobSummarySummary" + } + }, + "type": "object" + }, + "v1JobJobSummarySummary": { + "properties": { + "cluster_is_degraded": { + "description": "Whether the cluster is in a degraded state. Note this is from the perspective of the node handling the query, which might be different from another node.", + "type": "boolean" + }, + "connected": { + "description": "Whether isi_job_d instances on all up nodes in the cluster are connected to the coordinator.", + "type": "boolean" + }, + "coordinator": { + "description": "The devid of the job engine coordinator.", + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "disconnected_nodes": { + "description": "If connected=false, this is the set of devids that are not connected to the coordinator.", + "items": { + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "type": "array" + }, + "down_or_read_only_nodes": { + "description": "Whether the cluster has any down or read-only nodes. These nodes are not considered in the connected property.", + "type": "boolean" + }, + "next_jid": { + "description": "The job ID to be assigned to the next job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "run_degraded": { + "description": "Whether the job engine would allow most jobs to run even when the cluster is in a degraded state.", + "type": "boolean" + }, + "stats_ready": { + "description": "Whether the coordinator has recently gathered statistics for all nodes in the cluster.", + "type": "boolean" + } + }, + "required": [ + "coordinator", + "stats_ready", + "next_jid", + "down_or_read_only_nodes", + "connected", + "cluster_is_degraded", + "run_degraded" + ], + "type": "object" + }, + "v1JobJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v1JobJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1JobJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v1JobJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1JobPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v1JobPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1JobPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v1JobPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1JobPolicy": { + "properties": { + "description": { + "description": "A helpful human-readable description of the impact policy.", + "type": "string" + }, + "intervals": { + "items": { + "$ref": "#/definitions/v1JobPolicyInterval" + }, + "type": "array" + }, + "name": { + "description": "The name of the impact policy.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v1JobPolicyExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1JobPolicy" + }, + { + "properties": { + "description": { + "description": "A helpful human-readable description of the impact policy.", + "type": "string" + }, + "id": { + "description": "The ID of the impact policy.", + "type": "string" + }, + "intervals": { + "items": { + "$ref": "#/definitions/v1JobPolicyInterval" + }, + "type": "array" + }, + "system": { + "description": "Whether or not this is a read-only system impact policy.", + "type": "boolean" + } + }, + "required": [ + "intervals", + "description", + "id" + ], + "type": "object" + } + ] + }, + "v1JobPolicyExtendedExtended": { + "properties": { + "description": { + "description": "A helpful human-readable description of the impact policy.", + "type": "string" + }, + "intervals": { + "items": { + "$ref": "#/definitions/v1JobPolicyInterval" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1JobPolicyInterval": { + "properties": { + "begin": { + "description": "Beginning time for the corresponding impact, in the format 'WWWW HH:MM', where 'WWWW' is the full English name of the day of the week, 'HH' is the hour (00-23), and 'MM' is the minute (00-59).", + "type": "string" + }, + "end": { + "description": "Ending time for the corresponding impact, in the format 'WWWW HH:MM', where 'WWWW' is the full English name of the day of the week, 'HH' is the hour (00-23), and 'MM' is the minute (00-59).", + "type": "string" + }, + "impact": { + "description": "Impact for the corresponding time span.", + "enum": [ + "Low", + "Medium", + "High", + "Paused" + ], + "type": "string" + } + }, + "required": [ + "impact", + "begin", + "end" + ], + "type": "object" + }, + "v1JobReport": { + "properties": { + "id": { + "description": "Job event ID.", + "type": "string" + }, + "job_id": { + "description": "Job ID.", + "minimum": 1, + "type": "integer" + }, + "job_type": { + "description": "Job Type.", + "type": "string" + }, + "phase": { + "description": "Job phase number at time of event.", + "type": "integer" + }, + "results": { + "description": "Job results, if applicable.", + "type": "string" + }, + "time": { + "description": "Time of event in Unix epoch seconds.", + "type": "integer" + } + }, + "required": [ + "job_id", + "job_type", + "results", + "time", + "phase", + "id" + ], + "type": "object" + }, + "v1JobReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1JobReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1JobStatistics": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v1JobStatisticsJob" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1JobStatisticsJob": { + "properties": { + "job_id": { + "description": "The job ID.", + "type": "integer" + }, + "nodes": { + "items": { + "$ref": "#/definitions/v1JobStatisticsJobNode" + }, + "type": "array" + }, + "phase": { + "description": "The current phase of the job.", + "type": "integer" + }, + "total_nodes": { + "description": "The number of nodes participating in the job.", + "type": "integer" + } + }, + "required": [ + "phase", + "nodes", + "job_id", + "total_nodes" + ], + "type": "object" + }, + "v1JobStatisticsJobNode": { + "properties": { + "cpu": { + "$ref": "#/definitions/v1JobStatisticsJobNodeCpu" + }, + "io": { + "$ref": "#/definitions/v1JobStatisticsJobNodeIo" + }, + "memory": { + "$ref": "#/definitions/v1JobStatisticsJobNodeMemory" + }, + "node": { + "description": "The devid of the node.", + "type": "integer" + }, + "pid": { + "description": "The process ID of the job on this node.", + "type": "integer" + }, + "total_workers": { + "description": "The number of workers for this job on this node.", + "type": "integer" + }, + "workers": { + "items": { + "$ref": "#/definitions/v1JobStatisticsJobNodeWorker" + }, + "type": "array" + } + }, + "required": [ + "node", + "workers", + "pid", + "total_workers", + "io", + "memory", + "cpu" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeCpu": { + "properties": { + "average": { + "description": "The average CPU utilization of the job on this node.", + "type": "number" + }, + "current": { + "description": "The current CPU utilization of the job on this node.", + "type": "number" + }, + "maximum": { + "description": "The maximum CPU utilization of the job on this node.", + "type": "number" + }, + "minimum": { + "description": "The minimum CPU utilization of the job on this node.", + "type": "number" + } + }, + "required": [ + "current", + "minimum", + "maximum" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeIo": { + "properties": { + "read": { + "$ref": "#/definitions/v1JobStatisticsJobNodeIoRead" + }, + "write": { + "$ref": "#/definitions/v1JobStatisticsJobNodeIoWrite" + } + }, + "required": [ + "read", + "write" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeIoRead": { + "properties": { + "bytes": { + "description": "The number of bytes recently read by this job on this node.", + "type": "integer" + }, + "ops": { + "description": "The number of read operations recently performed by this job on this node.", + "type": "integer" + } + }, + "required": [ + "bytes", + "ops" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeIoWrite": { + "properties": { + "bytes": { + "description": "The number of bytes recently written by this job on this node.", + "type": "integer" + }, + "ops": { + "description": "The number of write operations recently performed by this job on this node.", + "type": "integer" + } + }, + "required": [ + "bytes", + "ops" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeMemory": { + "properties": { + "physical": { + "$ref": "#/definitions/v1JobStatisticsJobNodeMemoryPhysical" + }, + "virtual": { + "$ref": "#/definitions/v1JobStatisticsJobNodeMemoryVirtual" + } + }, + "required": [ + "virtual", + "physical" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeMemoryPhysical": { + "properties": { + "average": { + "description": "The average physical memory utilization of the job on this node, in KB.", + "type": "number" + }, + "current": { + "description": "The current physical memory utilization of the job on this node, in KB.", + "type": "number" + }, + "maximum": { + "description": "The maximum physical memory utilization of the job on this node, in KB.", + "type": "number" + }, + "minimum": { + "description": "The minimum physical memory utilization of the job on this node, in KB.", + "type": "number" + } + }, + "required": [ + "current", + "minimum", + "maximum" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeMemoryVirtual": { + "properties": { + "average": { + "description": "The average virtual memory utilization of the job on this node, in KB.", + "type": "number" + }, + "current": { + "description": "The current virtual memory utilization of the job on this node, in KB.", + "type": "number" + }, + "maximum": { + "description": "The maximum virtual memory utilization of the job on this node, in KB.", + "type": "number" + }, + "minimum": { + "description": "The minimum virtual memory utilization of the job on this node, in KB.", + "type": "number" + } + }, + "required": [ + "current", + "minimum", + "maximum" + ], + "type": "object" + }, + "v1JobStatisticsJobNodeWorker": { + "properties": { + "stw": { + "description": "The sleep-to-work ratio of this worker; how much time it spends sleeping compared to working.", + "type": "number" + }, + "task": { + "description": "A representation of the task the worker is currently processing; not intended to be read by humans.", + "type": "string" + }, + "task_result": { + "description": "A representation of the most recent task result produced by the worker; not intended to be read by humans.", + "type": "string" + }, + "worker": { + "description": "The worker ID.", + "type": "integer" + } + }, + "required": [ + "worker" + ], + "type": "object" + }, + "v1JobType": { + "properties": { + "allow_multiple_instances": { + "description": "Whether multiple instances of this job type may run simultaneously.", + "type": "boolean" + }, + "description": { + "description": "Brief description of the job type.", + "type": "string" + }, + "enabled": { + "description": "Whether the job type is enabled and able to run.", + "type": "boolean" + }, + "exclusion_set": { + "description": "The set(s) of mutually-exclusive job types to which this job belongs. No job in this set may run with any other job in this set. Obsolete; this value will always be an empty string, as exclusion sets are no longer a job type property.", + "type": "string" + }, + "hidden": { + "description": "Whether this job type is normally visible in the UI.", + "type": "boolean" + }, + "id": { + "description": "Job type ID.", + "type": "string" + }, + "policy": { + "description": "Default impact policy of this job type.", + "type": "string" + }, + "priority": { + "description": "Default priority of this job type; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which this job type is queued, if any.", + "type": "string" + } + }, + "required": [ + "priority", + "description", + "schedule", + "enabled", + "exclusion_set", + "policy", + "hidden", + "allow_multiple_instances", + "id" + ], + "type": "object" + }, + "v1JobTypeExtended": { + "properties": { + "enabled": { + "description": "Whether the job type is enabled and able to run.", + "type": "boolean" + }, + "policy": { + "description": "Default impact policy of this job type.", + "type": "string" + }, + "priority": { + "description": "Default priority of this job type; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which this job type is queued, if any.", + "type": "string" + } + }, + "type": "object" + }, + "v1JobTypes": { + "additionalProperties": false, + "properties": { + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "types": { + "items": { + "$ref": "#/definitions/v1JobType" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1JobTypesExtended": { + "additionalProperties": false, + "properties": { + "types": { + "items": { + "$ref": "#/definitions/v1JobType" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1LicenseLicense": { + "properties": { + "key": { + "description": "Install a new license key and enable associated services.", + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "v1LicenseLicenseExtended": { + "description": "Information about an application license.", + "properties": { + "duration": { + "description": "Total duration in seconds for temporary licenses.", + "type": "integer" + }, + "expiration": { + "description": "Unix epoch time the license will expire.", + "type": "integer" + }, + "id": { + "description": "Unique identifier for the license.", + "type": "string" + }, + "name": { + "description": "Name of the licensed feature.", + "type": "string" + }, + "status": { + "description": "Current status of the license.", + "enum": [ + "Activated", + "Evaluation", + "Expired", + "Inactive", + "Unknown" + ], + "type": "string" + } + }, + "required": [ + "duration", + "status", + "expiration", + "name", + "id" + ], + "type": "object" + }, + "v1LicenseLicenses": { + "additionalProperties": false, + "properties": { + "licenses": { + "items": { + "$ref": "#/definitions/v1LicenseLicenseExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1MappingIdentities": { + "description": "Specifies the properties for the identity mapping entry.", + "properties": { + "source": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "targets": { + "items": { + "$ref": "#/definitions/v1MappingIdentitiesTarget" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "source", + "targets" + ], + "type": "object" + }, + "v1MappingIdentitiesExtended": { + "additionalProperties": false, + "properties": { + "identities": { + "items": { + "$ref": "#/definitions/v1MappingIdentity" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1MappingIdentitiesTarget": { + "description": "Specifies the target identity mappings.", + "properties": { + "on_disk": { + "description": "Identity is preferred on-disk.", + "type": "boolean" + }, + "target": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": { + "description": "Origin of identity mapping.", + "enum": [ + "auto", + "external", + "manual" + ], + "type": "string" + } + }, + "required": [ + "target" + ], + "type": "object" + }, + "v1MappingIdentity": { + "description": "Specifies properties for the identity mapping entry.", + "properties": { + "id": { + "description": "Specifies the identity mapping entry id.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "targets": { + "items": { + "$ref": "#/definitions/v1MappingIdentityTarget" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "source", + "id", + "targets" + ], + "type": "object" + }, + "v1MappingIdentityTarget": { + "description": "Specifies the target identity mappings.", + "properties": { + "on_disk": { + "description": "If true, the identity is preferred on-disk.", + "type": "boolean" + }, + "target": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": { + "description": "Specifies the origin of the identity mapping.", + "enum": [ + "auto", + "external", + "manual" + ], + "type": "string" + } + }, + "required": [ + "target" + ], + "type": "object" + }, + "v1MappingUsersLookup": { + "properties": { + "mapping": { + "description": "Lookup a user access token.", + "items": { + "$ref": "#/definitions/v1MappingUsersLookupMappingItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1MappingUsersLookupMappingItem": { + "properties": { + "groups": { + "items": { + "$ref": "#/definitions/v1MappingUsersLookupMappingItemGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "object_history": { + "items": { + "$ref": "#/definitions/v1AuthGroupObjectHistoryItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "privileges": { + "items": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "$ref": "#/definitions/v1MappingUsersLookupMappingItemUser" + }, + "zid": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "zone": { + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1MappingUsersLookupMappingItemGroup": { + "description": "Specifies the configuration properties for a user.", + "properties": { + "dn": { + "description": "Specifies the distinguished name for the user.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "dns_domain": { + "description": "Specifies the DNS domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain": { + "description": "Specifies the domain that the object is part of.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email": { + "description": "Specifies an email address.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "If true, the authenticated user is enabled.", + "type": "boolean" + }, + "expired": { + "description": "If true, the authenticated auth user is expired.", + "type": "boolean" + }, + "expiry": { + "description": "Specifies the Epoch time at which the authenticated user will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gecos": { + "description": "Specifies the GECOS value, which is usually the full name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generated_gid": { + "description": "If true, indicates that the GID was generated.", + "type": "boolean" + }, + "generated_uid": { + "description": "If true, indicates that the UID was generated.", + "type": "boolean" + }, + "generated_upn": { + "description": "If true, indicates that the UPN was generated.", + "type": "boolean" + }, + "gid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "home_directory": { + "description": "Specifies the home directory for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the user or group ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "locked": { + "description": "If true, the account is locked out.", + "type": "boolean" + }, + "max_password_age": { + "description": "Specifies the maximum time in seconds allowed before the password expires.", + "type": "integer" + }, + "member_of": { + "description": "Specifies the groups that this user or group are members of.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "object_history": { + "items": { + "$ref": "#/definitions/v1AuthGroupObjectHistoryItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "on_disk_group_identity": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "on_disk_user_identity": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "password_expired": { + "description": "If true, the password has expired.", + "type": "boolean" + }, + "password_expires": { + "description": "If true, the password is allowed to expire.", + "type": "boolean" + }, + "password_expiry": { + "description": "Specifies the time in Epoch seconds the password will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "password_last_set": { + "description": "Specifies the last time the password was set.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "primary_group_sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "prompt_password_change": { + "description": "If true, prompts the user to change their password on next login.", + "type": "boolean" + }, + "provider": { + "description": "Specifies the authentication provider that the object belongs to.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sam_account_name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell": { + "description": "Specifies the path to the shell for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": { + "description": "Specifies the object type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "upn": { + "description": "Specifies the user principal name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_can_change_password": { + "description": "If true, the user password can be changed.", + "type": "boolean" + } + }, + "required": [ + "domain", + "sam_account_name", + "dns_domain", + "id", + "provider", + "type", + "dn", + "sid", + "name", + "member_of" + ], + "type": "object" + }, + "v1MappingUsersLookupMappingItemUser": { + "description": "Specifies the configuration properties for a user.", + "properties": { + "dn": { + "description": "Specifies the distinguished name for the user.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "dns_domain": { + "description": "Specifies the DNS domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain": { + "description": "Specifies the domain that the object is part of.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email": { + "description": "Specifies an email address.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "True, if the authenticated user is enabled.", + "type": "boolean" + }, + "expired": { + "description": "True, if the authenticated user has expired.", + "type": "boolean" + }, + "expiry": { + "description": "Specifies the Unix Epoch time at which the authenticated user will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gecos": { + "description": "Specifies the GECOS value, which is usually the full name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generated_gid": { + "description": "True, if the GID was generated.", + "type": "boolean" + }, + "generated_uid": { + "description": "True, if the UID was generated.", + "type": "boolean" + }, + "generated_upn": { + "description": "True, if the UPN was generated.", + "type": "boolean" + }, + "gid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "home_directory": { + "description": "Specifies a home directory for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the user or group ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "locked": { + "description": "If true, indicates that the account is locked.", + "type": "boolean" + }, + "max_password_age": { + "description": "Specifies the maximum time in seconds allowed before the password expires.", + "type": "integer" + }, + "member_of": { + "description": "Specifies the groups that this user or group are members of.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "object_history": { + "items": { + "$ref": "#/definitions/v1AuthGroupObjectHistoryItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "on_disk_group_identity": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "on_disk_user_identity": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "password_expired": { + "description": "If true, the password has expired.", + "type": "boolean" + }, + "password_expires": { + "description": "If true, the password is allowed to expire.", + "type": "boolean" + }, + "password_expiry": { + "description": "Specifies the time in Unix Epoch seconds that the password will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "password_last_set": { + "description": "Specifies the last time the password was set.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "primary_group_sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "prompt_password_change": { + "description": "Prompts the user to change their password at the next login.", + "type": "boolean" + }, + "provider": { + "description": "Specifies the authentication provider that the object belongs to.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sam_account_name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell": { + "description": "Specifies a path to the shell for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": { + "description": "Specifies the object type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "upn": { + "description": "Specifies a principal name for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_can_change_password": { + "description": "Specifies whether the password for the user can be changed.", + "type": "boolean" + } + }, + "required": [ + "domain", + "generated_gid", + "on_disk_group_identity", + "uid", + "password_expires", + "sam_account_name", + "dns_domain", + "password_expired", + "id", + "generated_upn", + "password_last_set", + "gid", + "provider", + "max_password_age", + "type", + "email", + "dn", + "shell", + "sid", + "expiry", + "on_disk_user_identity", + "password_expiry", + "user_can_change_password", + "expired", + "upn", + "locked", + "name", + "member_of", + "enabled", + "primary_group_sid", + "gecos", + "generated_uid", + "home_directory", + "prompt_password_change" + ], + "type": "object" + }, + "v1MappingUsersRules": { + "properties": { + "rules": { + "$ref": "#/definitions/v1MappingUsersRulesRules" + } + }, + "type": "object" + }, + "v1MappingUsersRulesRule": { + "properties": { + "operator": { + "description": "Specifies the operator to make rules on specified users or groups.", + "enum": [ + "append", + "insert", + "replace", + "trim", + "union" + ], + "type": "string" + }, + "options": { + "$ref": "#/definitions/v1MappingUsersRulesRuleOptions" + }, + "user1": { + "$ref": "#/definitions/v1MappingUsersRulesRuleUser2" + }, + "user2": { + "$ref": "#/definitions/v1MappingUsersRulesRuleUser2" + } + }, + "required": [ + "user1" + ], + "type": "object" + }, + "v1MappingUsersRulesRuleOptions": { + "description": "Specifies the properties for user mapping rules.", + "properties": { + "break": { + "description": "If true, and the rule was applied successfully, stop processing further.", + "type": "boolean" + }, + "default_user": { + "$ref": "#/definitions/v1MappingUsersRulesRuleUser2" + }, + "group": { + "description": "If true, the primary GID and primary group SID should be copied to the existing credential.", + "type": "boolean" + }, + "groups": { + "description": "If true, all additional identifiers should be copied to the existing credential.", + "type": "boolean" + }, + "user": { + "description": "If true, the primary UID and primary user SID should be copied to the existing credential.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1MappingUsersRulesRuleUser2": { + "properties": { + "domain": { + "description": "Specifies the domain of the user that is being mapped.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user": { + "description": "Specifies the name of the user that is being mapped.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "user" + ], + "type": "object" + }, + "v1MappingUsersRulesRules": { + "description": "Specifies the properties for user mapping rules.", + "properties": { + "parameters": { + "$ref": "#/definitions/v1MappingUsersRulesRulesParameters" + }, + "rules": { + "description": "Specifies the list of user mapping rules.", + "items": { + "$ref": "#/definitions/v1MappingUsersRulesRule" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_AUTH_RULES" + }, + "v1MappingUsersRulesRulesParameters": { + "description": "Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.", + "properties": { + "default_unix_user": { + "$ref": "#/definitions/v1MappingUsersRulesRuleUser2" + } + }, + "type": "object" + }, + "v1NfsCheck": { + "properties": { + "id": { + "description": "The ID of the export.", + "type": "integer" + }, + "message": { + "description": "The message about the export.", + "type": "string" + } + }, + "required": [ + "message", + "id" + ], + "type": "object" + }, + "v1NfsCheckExtended": { + "description": "Validation information about NFS exports.", + "properties": { + "checks": { + "items": { + "$ref": "#/definitions/v1NfsCheck" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1NfsExport": { + "description": "NFS export configuration values.", + "properties": { + "all_dirs": { + "description": "If true, all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "The block size returned by the NFS STATFS procedure.", + "type": "integer" + }, + "can_set_time": { + "description": "If true, the client may set file times using the NFS SETATTR request. This option is advisory and the server always behaves as if it is true.", + "type": "boolean" + }, + "clients": { + "description": "Clients that have access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "commit_asynchronous": { + "description": "If true, allows NFS commit requests to execute asynchronously.", + "type": "boolean" + }, + "description": { + "description": "A human readable description of the export.", + "type": "string" + }, + "directory_transfer_size": { + "description": "The preferred size for directory read operations. This option is advisory.", + "type": "integer" + }, + "encoding": { + "description": "The character encoding of clients connecting to the export.", + "type": "string" + }, + "map_all": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "map_full": { + "description": "If true, user mappings queries the OneFS user database. If false, only local authentication is queried.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "If true, incoming UIDs are mapped to users in the OneFS user database. If false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_retry": { + "description": "Determines whether lookups for users specified in map_all or map_root are retried if the look fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "max_file_size": { + "description": "The maximum file size in the export.", + "type": "integer" + }, + "paths": { + "description": "The paths under /ifs that are exported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_only": { + "description": "If true, the export is read-only.", + "type": "boolean" + }, + "read_only_clients": { + "description": "Clients that have read only access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_multiple": { + "description": "The preferred multiple size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_write_clients": { + "description": "Clients that have read and write access to the export, even if the export is read-only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readdirplus": { + "description": "If true, readdirplus requests are enabled.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that will be prefetched when a readdirplus request is processed.", + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "root_clients": { + "description": "Clients that have root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "security_flavors": { + "description": "The authentication flavors that are supported for this export.", + "items": { + "description": "The security type.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "If true, allows setattr operations to execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Use this snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "If true, paths reachable by symlinks are exported.", + "type": "boolean" + }, + "time_delta": { + "description": "The resolution of all time values that are returned to clients.", + "type": "number" + }, + "write_datasync_action": { + "description": "The action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "The stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "The action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "The stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_multiple": { + "description": "The preferred multiple size for NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "write_unstable_action": { + "description": "The action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "The stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + } + }, + "required": [ + "paths" + ], + "type": "object", + "x-privilege": "ISI_PRIV_NFS_EXPORTS" + }, + "v1NfsExportExtended": { + "description": "NFS export configuration values.", + "properties": { + "all_dirs": { + "description": "If true, all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "The block size returned by the NFS STATFS procedure.", + "type": "integer" + }, + "can_set_time": { + "description": "If true, the client may set file times using the NFS SETATTR request. This option is advisory and the server always behaves as if it is true.", + "type": "boolean" + }, + "clients": { + "description": "Clients that have access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "commit_asynchronous": { + "description": "If true, allows NFS commit requests to execute asynchronously.", + "type": "boolean" + }, + "conflicting_paths": { + "description": "Paths that conflict with another export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "A human readable description of the export.", + "type": "string" + }, + "directory_transfer_size": { + "description": "The preferred size for directory read operations. This option is advisory.", + "type": "integer" + }, + "encoding": { + "description": "The character encoding of clients connecting to the export.", + "type": "string" + }, + "id": { + "description": "Unique ID for the export.", + "type": "integer" + }, + "map_all": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "map_full": { + "description": "If true, user mappings queries the OneFS user database. If false, only local authentication is queried.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "If true, incoming UIDs are mapped to users in the OneFS user database. If false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_retry": { + "description": "Determines whether lookups for users specified in map_all or map_root are retried if the look fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "max_file_size": { + "description": "The maximum file size in the export.", + "type": "integer" + }, + "paths": { + "description": "The paths under /ifs that are exported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_only": { + "description": "If true, the export is read-only.", + "type": "boolean" + }, + "read_only_clients": { + "description": "Clients that have read only access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_multiple": { + "description": "The preferred multiple size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_write_clients": { + "description": "Clients that have read and write access to the export, even if the export is read-only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readdirplus": { + "description": "If true, readdirplus requests are enabled.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that will be prefetched when a readdirplus request is processed.", + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "root_clients": { + "description": "Clients that have root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "security_flavors": { + "description": "The authentication flavors that are supported for this export.", + "items": { + "description": "The security type.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "If true, allows setattr operations to execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Use this snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "If true, paths reachable by symlinks are exported.", + "type": "boolean" + }, + "time_delta": { + "description": "The resolution of all time values that are returned to clients.", + "type": "number" + }, + "unresolved_clients": { + "description": "Clients that cannot be resolved.", + "items": { + "type": "string" + }, + "type": "array" + }, + "write_datasync_action": { + "description": "The action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "The stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "The action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "The stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_multiple": { + "description": "The preferred multiple size for NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "write_unstable_action": { + "description": "The action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "The stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + }, + "v1NfsExportExtendedExtended": { + "description": "NFS export configuration values.", + "properties": { + "all_dirs": { + "description": "If true, all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "The block size returned by the NFS STATFS procedure.", + "type": "integer" + }, + "can_set_time": { + "description": "If true, the client may set file times using the NFS SETATTR request. This option is advisory and the server always behaves as if it is true.", + "type": "boolean" + }, + "clients": { + "description": "Clients that have access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "commit_asynchronous": { + "description": "If true, allows NFS commit requests to execute asynchronously.", + "type": "boolean" + }, + "description": { + "description": "A human readable description of the export.", + "type": "string" + }, + "directory_transfer_size": { + "description": "The preferred size for directory read operations. This option is advisory.", + "type": "integer" + }, + "encoding": { + "description": "The character encoding of clients connecting to the export.", + "type": "string" + }, + "map_all": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "map_full": { + "description": "If true, user mappings queries the OneFS user database. If false, only local authentication is queried.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "If true, incoming UIDs are mapped to users in the OneFS user database. If false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_retry": { + "description": "Determines whether lookups for users specified in map_all or map_root are retried if the look fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "max_file_size": { + "description": "The maximum file size in the export.", + "type": "integer" + }, + "paths": { + "description": "The paths under /ifs that are exported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_only": { + "description": "If true, the export is read-only.", + "type": "boolean" + }, + "read_only_clients": { + "description": "Clients that have read only access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_multiple": { + "description": "The preferred multiple size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_write_clients": { + "description": "Clients that have read and write access to the export, even if the export is read-only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readdirplus": { + "description": "If true, readdirplus requests are enabled.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that will be prefetched when a readdirplus request is processed.", + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "root_clients": { + "description": "Clients that have root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "security_flavors": { + "description": "The authentication flavors that are supported for this export.", + "items": { + "description": "The security type.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "If true, allows setattr operations to execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Use this snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "If true, paths reachable by symlinks are exported.", + "type": "boolean" + }, + "time_delta": { + "description": "The resolution of all time values that are returned to clients.", + "type": "number" + }, + "write_datasync_action": { + "description": "The action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "The stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "The action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "The stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_multiple": { + "description": "The preferred multiple size for NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "write_unstable_action": { + "description": "The action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "The stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + }, + "v1NfsExportMapAll": { + "description": "The user and groups that non-root clients are mapped to.", + "properties": { + "groups": { + "items": { + "type": "string" + }, + "type": "array" + }, + "user": { + "description": "User name.", + "type": "string" + } + }, + "type": "object" + }, + "v1NfsExports": { + "additionalProperties": false, + "properties": { + "digest": { + "description": "An identifier for a set of exports.", + "type": "string" + }, + "exports": { + "items": { + "$ref": "#/definitions/v1NfsExportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_NFS_EXPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1NfsExportsExtended": { + "additionalProperties": false, + "properties": { + "exports": { + "items": { + "$ref": "#/definitions/v1NfsExportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1NfsExportsSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v1NfsExportsSummarySummary" + } + }, + "type": "object" + }, + "v1NfsExportsSummarySummary": { + "description": "The summary of a collection of objects.", + "properties": { + "count": { + "description": "The count of objects in the collection", + "type": "integer" + } + }, + "required": [ + "count" + ], + "type": "object" + }, + "v1NfsNlmLocks": { + "additionalProperties": false, + "properties": { + "locks": { + "items": { + "$ref": "#/definitions/v1NfsNlmLocksLock" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1NfsNlmLocksLock": { + "description": "Information for an NLM lock on NFS.", + "properties": { + "client": { + "description": "The client host name.", + "type": "string" + }, + "client_id": { + "description": "The client ID.", + "type": "string" + }, + "created": { + "description": "Time of lock creation.", + "type": "integer" + }, + "id": { + "description": "The lock ID.", + "type": "string" + }, + "lin": { + "description": "The LIN in ifs that is locked.", + "type": "string" + }, + "lock_type": { + "description": "The type of lock.", + "type": "string" + }, + "path": { + "description": "The path in ifs that is locked.", + "type": "string" + }, + "range": { + "description": "The byte range within the file that is locked.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1NfsNlmSessions": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "sessions": { + "items": { + "$ref": "#/definitions/v1NfsNlmSessionsSession" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1NfsNlmSessionsSession": { + "properties": { + "client": { + "description": "The client that has the session.", + "type": "string" + }, + "id": { + "description": "The session ID.", + "type": "string" + } + }, + "type": "object" + }, + "v1NfsNlmWaiters": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "waiters": { + "items": { + "$ref": "#/definitions/v1NfsNlmLocksLock" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1NfsSettingsExport": { + "description": "Default NFS export configuration values.", + "properties": { + "settings": { + "$ref": "#/definitions/v1NfsSettingsExportSettings" + } + }, + "type": "object" + }, + "v1NfsSettingsExportSettings": { + "description": "NFS export configuration values.", + "properties": { + "all_dirs": { + "description": "If true, all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "The block size returned by the NFS STATFS procedure.", + "type": "integer" + }, + "can_set_time": { + "description": "If true, the client may set file times using the NFS SETATTR request. This option is advisory and the server always behaves as if it is true.", + "type": "boolean" + }, + "commit_asynchronous": { + "description": "If true, allows NFS commit requests to execute asynchronously.", + "type": "boolean" + }, + "directory_transfer_size": { + "description": "The preferred size for directory read operations. This option is advisory.", + "type": "integer" + }, + "encoding": { + "description": "The character encoding of clients connecting to the export.", + "type": "string" + }, + "map_all": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "map_full": { + "description": "If true, user mappings queries the OneFS user database. If false, only local authentication is queried.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "If true, incoming UIDs are mapped to users in the OneFS user database. If false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_retry": { + "description": "Determines whether lookups for users specified in map_all or map_root are retried if the look fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v1NfsExportMapAll" + }, + "max_file_size": { + "description": "The maximum file size in the export.", + "type": "integer" + }, + "read_only": { + "description": "If true, the export is read-only.", + "type": "boolean" + }, + "read_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_multiple": { + "description": "The preferred multiple size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "read_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "readdirplus": { + "description": "If true, readdirplus requests are enabled.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that will be prefetched when a readdirplus request is processed.", + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "security_flavors": { + "description": "The authentication flavors that are supported for this export.", + "items": { + "description": "The security type.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "If true, allows setattr operations to execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Use this snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "If true, paths reachable by symlinks are exported.", + "type": "boolean" + }, + "time_delta": { + "description": "The resolution of all time values that are returned to clients.", + "type": "number" + }, + "write_datasync_action": { + "description": "The action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "The stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "The action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "The stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "The maximum buffer size that clients should use on NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_multiple": { + "description": "The preferred multiple size for NFS write requests. This option is advisory.", + "type": "integer" + }, + "write_transfer_size": { + "description": "The optimal size for NFS read requests. This option is advisory.", + "type": "integer" + }, + "write_unstable_action": { + "description": "The action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "The stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + }, + "v1ProvidersAds": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v1ProvidersAdsAdsItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersAdsAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "forest": { + "description": "Specifies the Active Directory forest.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname": { + "description": "Specifies the fully qualified hostname stored in the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_account": { + "description": "Specifies the SAM account name of the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "netbios_domain": { + "description": "Specifies the NetBIOS domain name associated with the machine account.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "primary_domain": { + "description": "Specifies the AD domain to which the provider is joined.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "site": { + "description": "Specifies the site for the Active Directory.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "system": { + "description": "If set to true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersAdsAdsItemExtended": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "forest": { + "description": "Specifies the Active Directory forest.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname": { + "description": "Specifies the fully qualified hostname stored in the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_account": { + "description": "Specifies the SAM account name of the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "netbios_domain": { + "description": "Specifies the NetBIOS domain name associated with the machine account.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "primary_domain": { + "description": "Specifies the AD domain to which the provider is joined.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "site": { + "description": "Specifies the site for the Active Directory.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "system": { + "description": "If set to true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1ProvidersAdsExtended": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v1ProvidersAdsAdsItemExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersAdsIdParams": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_controller": { + "description": "Specifies the domain controller to which the authentication service should send requests", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "reset_schannel": { + "description": "Resets the secure channel to the primary domain.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1ProvidersAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "account": { + "description": "Specifies the machine account name when creating a SAM account with Active Directory.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "dns_domain": { + "description": "Specifies the DNS search domain. Set this parameter if the DNS search domain has a unique name or address.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "kerberos_hdfs_spn": { + "description": "Determines if connecting through HDFS with Kerberos.", + "type": "boolean" + }, + "kerberos_nfs_spn": { + "description": "Determines if connecting through NFS with Kerberos.", + "type": "boolean" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "organizational_unit": { + "description": "Specifies the organizational unit.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the password used during domain join.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "description": "Specifies the user name that has permission to join a machine to the given domain.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "user", + "password", + "name" + ], + "type": "object" + }, + "v1ProvidersFile": { + "additionalProperties": false, + "properties": { + "file": { + "items": { + "$ref": "#/definitions/v1ProvidersFileFileItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersFileFileItem": { + "description": "Specifies the properties for an authentication file provider", + "properties": { + "authentication": { + "description": "Enables authentication and identity mapping through the authentication provider.", + "type": "boolean" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "Enables the file provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "Enables the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "Enables the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which domains are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_file": { + "description": "Specifies the location of the file that contains information about the group.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "id": { + "description": "Specifies the file provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "modifiable_groups": { + "description": "Specifies the groups that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "modifiable_users": { + "description": "Specifies the users that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the file provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_file": { + "description": "Specifies the path to a netgroups replacement file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "password_file": { + "description": "Specifies the location of the file containing information about users.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "restrict_modifiable": { + "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups.", + "type": "boolean" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_groups": { + "description": "Specifies a group that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_users": { + "description": "Specifies a user that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersFileIdParams": { + "description": "Specifies the properties for an authentication file provider", + "properties": { + "authentication": { + "description": "Enables authentication and identity mapping through the authentication provider.", + "type": "boolean" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "Enables the file provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "Enables the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "Enables the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which domains are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_file": { + "description": "Specifies the location of the file that contains information about the group.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "modifiable_groups": { + "description": "Specifies the groups that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "modifiable_users": { + "description": "Specifies the users that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the file provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_file": { + "description": "Specifies the path to a netgroups replacement file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "password_file": { + "description": "Specifies the location of the file containing information about users.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "restrict_modifiable": { + "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_groups": { + "description": "Specifies a group that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_users": { + "description": "Specifies a user that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersFileItem": { + "description": "Specifies the properties for an authentication file provider", + "properties": { + "authentication": { + "description": "Enables authentication and identity mapping through the authentication provider.", + "type": "boolean" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "Enables the file provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "Enables the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "Enables the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which domains are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_file": { + "description": "Specifies the location of the file that contains information about the group.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "modifiable_groups": { + "description": "Specifies the groups that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "modifiable_users": { + "description": "Specifies the users that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the file provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_file": { + "description": "Specifies the path to a netgroups replacement file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "password_file": { + "description": "Specifies the location of the file containing information about users.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "restrict_modifiable": { + "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_groups": { + "description": "Specifies a group that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_users": { + "description": "Specifies a user that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "password_file", + "group_file", + "name" + ], + "type": "object" + }, + "v1ProvidersKrb5": { + "additionalProperties": false, + "properties": { + "krb5": { + "items": { + "$ref": "#/definitions/v1ProvidersKrb5Krb5Item" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersKrb5Extended": { + "additionalProperties": false, + "properties": { + "krb5": { + "items": { + "$ref": "#/definitions/v1ProvidersKrb5Krb5ItemExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersKrb5IdParams": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPNs.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the Kerberos provider password.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersKrb5Item": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPN.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the Kerberos provider password.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "realm" + ], + "type": "object" + }, + "v1ProvidersKrb5ItemKeytabEntry": { + "description": "Krb5 SPN Key info", + "properties": { + "encryption": { + "description": "Specifies the encryption types.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "kvno": { + "description": "Specifies the version number of the SPN key.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "spn": { + "description": "Specifies the Service Principal Name (SPN).", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "timestamp": { + "description": "Specifies the time the SPN key was created.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1ProvidersKrb5Krb5Item": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "id": { + "description": "Specifies the Kerberos provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPNs.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the Kerberos provider password.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "recommended_spns": { + "description": "Specifies the recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed", + "type": "boolean" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersKrb5Krb5ItemExtended": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "id": { + "description": "Specifies the Kerberos provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPNs.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "recommended_spns": { + "description": "Specifies the recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed", + "type": "boolean" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersLdap": { + "additionalProperties": false, + "properties": { + "ldap": { + "items": { + "$ref": "#/definitions/v1ProvidersLdapLdapItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersLdapIdParams": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "required": [ + "base_dn", + "server_uris", + "name" + ], + "type": "object" + }, + "v1ProvidersLdapLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersLocal": { + "additionalProperties": false, + "properties": { + "local": { + "items": { + "$ref": "#/definitions/v1ProvidersLocalLocalItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersLocalIdParams": { + "description": "Specifies the properties for a local authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "lockout_duration": { + "description": "Specifies the length of time in seconds that an account will be inaccessible after multiple failed login attempts.", + "maximum": 2592000, + "minimum": 0, + "type": "integer" + }, + "lockout_threshold": { + "description": "Specifies the number of failed login attempts necessary before an account is locked.", + "maximum": 50, + "minimum": 0, + "type": "integer" + }, + "lockout_window": { + "description": "Specifies the duration of time in seconds in which the number of failed attempts set in the 'lockout_threshold' parameter must be made before an account is locked.", + "maximum": 2592000, + "minimum": 0, + "type": "integer" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "machine_name": { + "description": "Specifies the domain for this provider through which users and groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "max_password_age": { + "description": "Specifies the maximum password age in seconds.", + "maximum": 86313600, + "minimum": 0, + "type": "integer" + }, + "min_password_age": { + "description": "Specifies the minimum password age in seconds.", + "maximum": 86313600, + "minimum": 0, + "type": "integer" + }, + "min_password_length": { + "description": "Specifies the minimum password length.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Specifies the local provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_complexity": { + "description": "Specifies the conditions required for a password.", + "items": { + "enum": [ + "lowercase", + "uppercase", + "numeric", + "symbol", + "repeat" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "password_history_length": { + "description": "Specifies the number of previous passwords to store.", + "maximum": 24, + "minimum": 0, + "type": "integer" + }, + "password_prompt_time": { + "description": "Specifies the time in seconds remaining before a user will be prompted for a password change.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1ProvidersLocalLocalItem": { + "description": "Specifies the properties for a local authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "id": { + "description": "Specifies the local provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lockout_duration": { + "description": "Specifies the length of time in seconds that an account will be inaccessible after multiple failed login attempts.", + "maximum": 2592000, + "minimum": 0, + "type": "integer" + }, + "lockout_threshold": { + "description": "Specifies the number of failed login attempts necessary before an account is locked.", + "maximum": 50, + "minimum": 0, + "type": "integer" + }, + "lockout_window": { + "description": "Specifies the duration of time in seconds in which the number of failed attempts set in the 'lockout_threshold' parameter must be made before an account is locked.", + "maximum": 2592000, + "minimum": 0, + "type": "integer" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "machine_name": { + "description": "Specifies the domain for this provider through which users and groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "max_password_age": { + "description": "Specifies the maximum password age in seconds.", + "maximum": 86313600, + "minimum": 0, + "type": "integer" + }, + "min_password_age": { + "description": "Specifies the minimum password age in seconds.", + "maximum": 86313600, + "minimum": 0, + "type": "integer" + }, + "min_password_length": { + "description": "Specifies the minimum password length.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Specifies the local provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_complexity": { + "description": "Specifies the conditions required for a password.", + "items": { + "enum": [ + "lowercase", + "uppercase", + "numeric", + "symbol", + "repeat" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "password_history_length": { + "description": "Specifies the number of previous passwords to store.", + "maximum": 24, + "minimum": 0, + "type": "integer" + }, + "password_prompt_time": { + "description": "Specifies the time in seconds remaining before a user will be prompted for a password change.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1ProvidersNis": { + "additionalProperties": false, + "properties": { + "nis": { + "items": { + "$ref": "#/definitions/v1ProvidersNisNisItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersNisIdParams": { + "description": "Specifies the properties for an NIS authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "If true, enables the NIS provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname_lookup": { + "description": "If true, enables host name look ups.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the NIS provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nis_domain": { + "description": "Specifies the NIS domain name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "request_timeout": { + "description": "Specifies the request timeout interval in seconds.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "retry_time": { + "description": "Specifies the timeout period in seconds after which a request will be retried.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "servers": { + "description": "Adds an NIS server for this provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ypmatch_using_tcp": { + "description": "If true, specifies TCP for YP Match operations.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1ProvidersNisItem": { + "description": "Specifies the properties for an NIS authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "If true, enables the NIS provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname_lookup": { + "description": "If true, enables host name look ups.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the NIS provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nis_domain": { + "description": "Specifies the NIS domain name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "request_timeout": { + "description": "Specifies the request timeout interval in seconds.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "retry_time": { + "description": "Specifies the timeout period in seconds after which a request will be retried.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "servers": { + "description": "Adds an NIS server for this provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ypmatch_using_tcp": { + "description": "If true, specifies TCP for YP Match operations.", + "type": "boolean" + } + }, + "required": [ + "servers", + "nis_domain", + "name" + ], + "type": "object" + }, + "v1ProvidersNisNisItem": { + "description": "Specifies the properties for an NIS authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "If true, enables the NIS provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname_lookup": { + "description": "If true, enables host name look ups.", + "type": "boolean" + }, + "id": { + "description": "Specifies the NIS provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the NIS provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nis_domain": { + "description": "Specifies the NIS domain name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "request_timeout": { + "description": "Specifies the request timeout interval in seconds.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "retry_time": { + "description": "Specifies the timeout period in seconds after which a request will be retried.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "servers": { + "description": "Adds an NIS server for this provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ypmatch_using_tcp": { + "description": "If true, specifies TCP for YP Match operations.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1ProvidersSummary": { + "additionalProperties": false, + "properties": { + "provider_instances": { + "items": { + "$ref": "#/definitions/v1ProvidersSummaryProviderInstance" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ProvidersSummaryProviderInstance": { + "description": "Specifies the summary information for an authentication provider.", + "properties": { + "active_server": { + "description": "Specifies the server through which the provider serves authentication requests. Null if no server is set or is not applicable for that provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "connections": { + "items": { + "$ref": "#/definitions/v1ProvidersSummaryProviderInstanceConnection" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "forest": { + "description": "Specifies the Active Directory forest. Null if not applicable.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "site": { + "description": "Specifies the Active Directory site name. Null if not applicable.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Indicates the status of the provider.", + "enum": [ + "offline", + "active", + "online", + "initializing", + "joining", + "disabled" + ], + "type": "string" + }, + "type": { + "description": "Specifies the type of provider.", + "enum": [ + "file", + "ldap", + "local", + "nis", + "ads", + "krb5", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v1ProvidersSummaryProviderInstanceConnection": { + "properties": { + "address": { + "description": "Specifies the IP address of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_used": { + "description": "Specifies the last time the server was contacted.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "server": { + "description": "Specifies the fully qualified domain name of the server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1QuotaNotification": { + "properties": { + "action_alert": { + "description": "Send alert when rule matches.", + "type": "boolean" + }, + "action_email_address": { + "description": "Email a specific email address when rule matches.", + "maxLength": 1023, + "minLength": 0, + "type": "string" + }, + "action_email_owner": { + "description": "Email quota domain owner when rule matches.", + "type": "boolean" + }, + "condition": { + "description": "The condition detected.", + "enum": [ + "exceeded", + "denied", + "violated", + "expired" + ], + "maxLength": 8, + "minLength": 6, + "type": "string" + }, + "email_template": { + "description": "Path of optional /ifs template file used for email actions.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "holdoff": { + "description": "Time to wait between detections for rules triggered by user actions.", + "maximum": 2147483646, + "type": "integer" + }, + "schedule": { + "description": "Schedule for rules that repeatedly notify.", + "type": "string" + }, + "threshold": { + "description": "The quota threshold detected.", + "enum": [ + "hard", + "soft", + "advisory" + ], + "maxLength": 8, + "minLength": 4, + "type": "string" + } + }, + "required": [ + "threshold", + "condition" + ], + "type": "object" + }, + "v1QuotaNotificationExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1QuotaNotification" + }, + { + "properties": { + "id": { + "description": "The system ID given to the rule.", + "maxLength": 17, + "minLength": 11, + "pattern": "^[a-z]+-[a-z]+", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + } + ] + }, + "v1QuotaNotifications": { + "additionalProperties": false, + "properties": { + "notifications": { + "items": { + "$ref": "#/definitions/v1QuotaNotificationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1QuotaQuota": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise an accounting quota.", + "type": "boolean" + }, + "force": { + "description": "Force creation of quotas on the root of /ifs.", + "type": "boolean" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "thresholds": { + "$ref": "#/definitions/v1QuotaQuotaThresholds" + }, + "thresholds_include_overhead": { + "description": "If true, thresholds apply to data plus filesystem overhead required to store the data (i.e. 'physical' usage).This option is deprecated. Use latest option 'thresholds_on' to select the usage on which thresholds to apply.", + "type": "boolean" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-user", + "default-group" + ], + "type": "string" + } + }, + "required": [ + "include_snapshots", + "thresholds_include_overhead", + "path", + "type" + ], + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "v1QuotaQuotaExtended": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise a accounting quota.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the quota.", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "linked": { + "description": "For user, group and directory quotas, true if the quota is linked and controlled by a parent default-* quota. Linked quotas cannot be modified until they are unlinked.", + "type": "boolean" + }, + "notifications": { + "description": "Summary of notifications: 'custom' indicates one or more notification rules available from the notifications sub-resource; 'default' indicates system default rules are used; 'disabled' indicates that no notifications will be used for this quota.; 'badmap' indicates that notification rule has problem in rule map.", + "enum": [ + "custom", + "default", + "disabled", + "badmap" + ], + "maxLength": 8, + "minLength": 6, + "type": "string" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ready": { + "description": "True if the accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "thresholds": { + "$ref": "#/definitions/v1QuotaQuotaThresholdsExtended" + }, + "thresholds_include_overhead": { + "description": "If true, thresholds apply to data plus filesystem overhead required to store the data (i.e. 'physical' usage).", + "type": "boolean" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-user", + "default-group" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v1QuotaQuotaUsage" + } + }, + "required": [ + "enforced", + "include_snapshots", + "container", + "usage", + "thresholds", + "linked", + "notifications", + "persona", + "thresholds_include_overhead", + "ready", + "path", + "type", + "id" + ], + "type": "object" + }, + "v1QuotaQuotaExtendedExtended": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise an accounting quota.", + "type": "boolean" + }, + "force": { + "description": "Force creation of quotas on the root of /ifs.", + "type": "boolean" + }, + "linked": { + "description": "If false and the quota is linked, attempt to unlink.", + "type": "boolean" + }, + "thresholds": { + "$ref": "#/definitions/v1QuotaQuotaThresholds" + }, + "thresholds_include_overhead": { + "description": "If true, thresholds apply to data plus filesystem overhead required to store the data (i.e. 'physical' usage).This option is deprecated. Use latest option 'thresholds_on' to select the usage on which thresholds to apply.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "v1QuotaQuotaThresholds": { + "properties": { + "advisory": { + "description": "Usage bytes at which notifications will be sent but writes will not be denied.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "hard": { + "description": "Usage bytes at which further writes will be denied.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "soft": { + "description": "Usage bytes at which notifications will be sent and soft grace time will be started.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "soft_grace": { + "description": "Time in seconds after which the soft threshold has been hit before writes will be denied.", + "maximum": 1073741823, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v1QuotaQuotaThresholdsExtended": { + "properties": { + "advisory": { + "description": "Usage bytes at which notifications will be sent but writes will not be denied.", + "minimum": 1, + "type": "integer" + }, + "advisory_exceeded": { + "description": "True if the advisory threshold has been hit.", + "type": "boolean" + }, + "advisory_last_exceeded": { + "description": "Time at which advisory threshold was hit.", + "type": "integer" + }, + "hard": { + "description": "Usage bytes at which further writes will be denied.", + "minimum": 1, + "type": "integer" + }, + "hard_exceeded": { + "description": "True if the hard threshold has been hit.", + "type": "boolean" + }, + "hard_last_exceeded": { + "description": "Time at which hard threshold was hit.", + "type": "integer" + }, + "soft": { + "description": "Usage bytes at which notifications will be sent and soft grace time will be started.", + "minimum": 1, + "type": "integer" + }, + "soft_exceeded": { + "description": "True if the soft threshold has been hit.", + "type": "boolean" + }, + "soft_grace": { + "description": "Time in seconds after which the soft threshold has been hit before writes will be denied.", + "minimum": 1, + "type": "integer" + }, + "soft_last_exceeded": { + "description": "Time at which soft threshold was hit", + "type": "integer" + } + }, + "required": [ + "advisory", + "soft_last_exceeded", + "hard_last_exceeded", + "soft_exceeded", + "hard_exceeded", + "hard", + "advisory_last_exceeded", + "advisory_exceeded", + "soft_grace", + "soft" + ], + "type": "object" + }, + "v1QuotaQuotaUsage": { + "properties": { + "inodes": { + "description": "Number of inodes (filesystem entities) used by governed data.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "logical": { + "description": "Apparent bytes used by governed data.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "physical": { + "description": "Bytes used for governed data and filesystem overhead.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "logical", + "inodes", + "physical" + ], + "type": "object" + }, + "v1QuotaQuotas": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v1QuotaQuotaExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1QuotaQuotasExtended": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v1QuotaQuotaExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1QuotaQuotasSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v1QuotaQuotasSummarySummary" + } + }, + "type": "object" + }, + "v1QuotaQuotasSummarySummary": { + "properties": { + "count": { + "description": "Total number of quotas.", + "type": "integer" + }, + "default_group_quotas_count": { + "description": "Total number of default-group quotas.", + "type": "integer" + }, + "default_user_quotas_count": { + "description": "Total number of default-user quotas.", + "type": "integer" + }, + "directory_quotas_count": { + "description": "Total number of directory quotas.", + "type": "integer" + }, + "group_quotas_count": { + "description": "Total number of -group quotas.", + "type": "integer" + }, + "linked_quotas_count": { + "description": "Total number of user and group totals that are linked.", + "type": "integer" + }, + "user_quotas_count": { + "description": "Total number of user quotas.", + "type": "integer" + } + }, + "required": [ + "count", + "directory_quotas_count", + "user_quotas_count", + "default_group_quotas_count", + "group_quotas_count", + "default_user_quotas_count", + "linked_quotas_count" + ], + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_SUMMARY" + }, + "v1QuotaReport": { + "properties": { + "generated": { + "description": "Whether report was manually requested (live) or scheduled.", + "enum": [ + "manual", + "scheduled" + ], + "type": "string" + }, + "id": { + "description": "The system ID given to the report.", + "type": "string" + }, + "time": { + "description": "Unix epoch time the report was taken.", + "type": "integer" + }, + "type": { + "description": "Whether this is a summary or detail report.", + "enum": [ + "summary", + "detail" + ], + "type": "string" + } + }, + "required": [ + "generated", + "type", + "id", + "time" + ], + "type": "object" + }, + "v1QuotaReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1QuotaReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1QuotaReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1QuotaReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1QuotasQidNotification": { + "properties": { + "action_alert": { + "description": "Send alert when rule matches.", + "type": "boolean" + }, + "action_email_address": { + "description": "Email a specific email address when rule matches.", + "maxLength": 1023, + "minLength": 0, + "type": "string" + }, + "action_email_owner": { + "description": "Email quota domain owner when rule matches.", + "type": "boolean" + }, + "email_template": { + "description": "Path of optional /ifs template file used for email actions.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "holdoff": { + "description": "Time to wait between detections for rules triggered by user actions.", + "maximum": 2147483646, + "type": "integer" + }, + "schedule": { + "description": "Schedule for rules that repeatedly notify.", + "type": "string" + } + }, + "type": "object" + }, + "v1QuotasQidNotifications": { + "additionalProperties": false, + "properties": { + "notifications": { + "items": { + "$ref": "#/definitions/v1QuotaNotificationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ReportSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v1ReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v1ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1ReportsReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v1ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1ReportsReportSubreportsSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v1ReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v1ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1RoleMembers": { + "additionalProperties": false, + "properties": { + "members": { + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1RolePrivileges": { + "additionalProperties": false, + "properties": { + "privileges": { + "items": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SettingsAccessTime": { + "properties": { + "settings": { + "$ref": "#/definitions/v1SettingsAccessTimeSettings" + } + }, + "type": "object" + }, + "v1SettingsAccessTimeExtended": { + "properties": { + "enabled": { + "description": "Enable access time tracking.", + "type": "boolean" + }, + "precision": { + "description": "Access time tracked on each cluster file accurate to this number of seconds.", + "maximum": 1576800000, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SettingsAccessTimeSettings": { + "properties": { + "enabled": { + "description": "Enable access time tracking.", + "type": "boolean" + }, + "precision": { + "description": "Access time tracked in seconds for each cluster file if enabled.", + "type": "integer" + } + }, + "required": [ + "enabled", + "precision" + ], + "type": "object" + }, + "v1SettingsCharacterEncodings": { + "properties": { + "settings": { + "$ref": "#/definitions/v1SettingsCharacterEncodingsSettings" + } + }, + "type": "object" + }, + "v1SettingsCharacterEncodingsExtended": { + "properties": { + "current-encoding": { + "description": "Current character encoding.", + "type": "string" + } + }, + "type": "object" + }, + "v1SettingsCharacterEncodingsSettings": { + "properties": { + "current-encoding": { + "description": "Current character encoding.", + "type": "string" + }, + "default-encoding": { + "description": "Default character encoding.", + "type": "string" + }, + "encodings": { + "description": "A list of supported encoding values.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "default-encoding", + "encodings", + "current-encoding" + ], + "type": "object" + }, + "v1SettingsGlobal": { + "properties": { + "global_settings": { + "$ref": "#/definitions/v1SettingsGlobalGlobalSettings" + } + }, + "type": "object" + }, + "v1SettingsGlobalGlobalSettings": { + "description": "Specifies the properties for global authentication settings.", + "properties": { + "alloc_retries": { + "description": "Specifies the number of times to retry an ID allocation before failing.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gid_range_enabled": { + "description": "If true, allocates GIDs from a fixed range.", + "type": "boolean" + }, + "gid_range_max": { + "description": "Specifies the ending number for a fixed range from which GIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gid_range_min": { + "description": "Specifies the starting number for a fixed range from which GIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gid_range_next": { + "description": "Specifies the next GID to allocate.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "group_uid": { + "description": "Specifies the user iD for a group when requested by the kernel.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "load_providers": { + "description": "Specifies which providers are loaded by the authentication daemon (lsassd).", + "items": { + "enum": [ + "ActiveDirectory", + "Local", + "Nss", + "File", + "Nis", + "Ldap", + "Krb5" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "min_mapped_rid": { + "description": "Starts the RID in the local domain to map a UID and a GID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "null_gid": { + "description": "Specifies an alternative GID when the kernel is unable to retrieve a GID for a persona.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "null_uid": { + "description": "Specifies an alternative UID when the kernel is unable to retrieve a UID for a persona.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "on_disk_identity": { + "description": "Specifies the type of identity that is stored on disk.", + "enum": [ + "native", + "unix", + "sid" + ], + "type": "string" + }, + "rpc_block_time": { + "description": "Specifies the minimum amount of time in milliseconds to wait before performing an oprestart.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "rpc_max_requests": { + "description": "Specifies the maximum number of outstanding RPC requests.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "rpc_timeout": { + "description": "Specifies the maximum amount of time in seconds to wait for an idmap response.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "send_ntlmv2": { + "description": "If true, sends NTLMv2 responses.", + "type": "boolean" + }, + "space_replacement": { + "description": "Specifies the space replacement character.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system_gid_threshold": { + "description": "Specifies the minimum GID to attempt to look up in the idmap database.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "system_uid_threshold": { + "description": "Specifies the minimum UID to attempt to look up in the idmap database.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid_range_enabled": { + "description": "If true, allocates UIDs from a fixed range.", + "type": "boolean" + }, + "uid_range_max": { + "description": "Specifies the ending number for a fixed range from which UIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid_range_min": { + "description": "Specifies the starting number for a fixed range from which UIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid_range_next": { + "description": "Specifies the next UID to allocate.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unknown_gid": { + "description": "Specifies the GID for the unknown (anonymous) group.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unknown_uid": { + "description": "Specifies the UID for the unknown (anonymous) user.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_object_cache_size": { + "description": "Specifies the maximum size (in bytes) of the security object cache in the authentication daemon.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "workgroup": { + "description": "Specifies the NetBIOS workgroup or domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1SettingsKrb5Defaults": { + "properties": { + "krb5_settings": { + "$ref": "#/definitions/v1SettingsKrb5DefaultsKrb5Settings" + } + }, + "type": "object" + }, + "v1SettingsKrb5DefaultsKrb5Settings": { + "description": "Specifies the properties for the global Kerberos authentication settings.", + "properties": { + "allow_weak_crypto": { + "description": "If true, allow the use of DES encryption", + "type": "boolean" + }, + "always_send_preauth": { + "description": "If true, always attempts to preauthenticate to the domain controller.", + "type": "boolean" + }, + "default_realm": { + "description": "Specifies the realm for unqualified names.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "dns_lookup_kdc": { + "description": "If true, find KDCs through the DNS.", + "type": "boolean" + }, + "dns_lookup_realm": { + "description": "If true, find realm names through the DNS.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1SettingsKrb5Domain": { + "description": "Specifies the Kerberos settings for domain-realm mappings.", + "properties": { + "domain": { + "description": "Specifies the name of the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "domain", + "realm" + ], + "type": "object" + }, + "v1SettingsKrb5DomainExtended": { + "description": "Specifies the Kerberos settings for domain-realm mappings.", + "properties": { + "realm": { + "description": "Specifies the name of the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1SettingsKrb5Domains": { + "additionalProperties": false, + "properties": { + "domain": { + "items": { + "$ref": "#/definitions/v1SettingsKrb5DomainsDomainItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SettingsKrb5DomainsDomainItem": { + "description": "Specifies the Kerberos settings for domain-realm mappings.", + "properties": { + "domain": { + "description": "Specifies the name of the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "ID of the domain", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1SettingsKrb5Realm": { + "description": "Specifies the Kerberos settings for realm access.", + "properties": { + "admin_server": { + "description": "Specifies the administrative server hostname.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "default_domain": { + "description": "Specifies the default domain mapped to the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "is_default_realm": { + "description": "If true, indicates that the realm is the default.", + "type": "boolean" + }, + "kdc": { + "description": "Specifies the list of KDC hostnames.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "realm": { + "description": "Specifies the name of the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "realm" + ], + "type": "object" + }, + "v1SettingsKrb5RealmExtended": { + "description": "Specifies the Kerberos settings for realm access.", + "properties": { + "admin_server": { + "description": "Specifies the administrative server hostname.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "default_domain": { + "description": "Specifies the default domain mapped to the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "is_default_realm": { + "description": "If true, indicates that the realm is the default.", + "type": "boolean" + }, + "kdc": { + "description": "Specifies the list of KDC hostnames.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SettingsKrb5Realms": { + "additionalProperties": false, + "properties": { + "realm": { + "items": { + "$ref": "#/definitions/v1SettingsKrb5RealmsRealmItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SettingsKrb5RealmsRealmItem": { + "description": "Specifies the Kerberos settings for realm access.", + "properties": { + "admin_server": { + "description": "Specifies the administrative server hostname.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "default_domain": { + "description": "Specifies the default domain mapped to the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "ID of realm", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "is_default_realm": { + "description": "If true, indicates that the realm is the default.", + "type": "boolean" + }, + "is_joined": { + "description": "If true, indicates that the realm is joined.", + "type": "boolean" + }, + "kdc": { + "description": "Specifies the list of KDC hostnames.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "realm": { + "description": "Specifies the name of the realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1SettingsMapping": { + "properties": { + "mapping_settings": { + "$ref": "#/definitions/v1SettingsMappingMappingSettings" + } + }, + "type": "object" + }, + "v1SettingsMappingCreateParams": { + "properties": { + "domain": { + "description": "The FQDN of the source domain to map.", + "type": "string" + }, + "id": { + "type": "string" + }, + "mapping": { + "description": "The FQDN of destination domain to map to.", + "type": "string" + }, + "type": { + "description": "The authentication provider type.", + "enum": [ + "ad", + "local", + "nis", + "ldap" + ], + "type": "string" + } + }, + "required": [ + "domain", + "type", + "mapping" + ], + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_SETTINGS_MAPPINGS" + }, + "v1SettingsMappingExtended": { + "properties": { + "domain": { + "description": "The FQDN of the source domain to map.", + "type": "string" + }, + "id": { + "description": "The system ID given to the mapping.", + "type": "string" + }, + "mapping": { + "description": "The FQDN of destination domain to map to.", + "type": "string" + }, + "type": { + "description": "The authentication provider type.", + "enum": [ + "ad", + "local", + "nis", + "ldap" + ], + "type": "string" + } + }, + "required": [ + "domain", + "type", + "id", + "mapping" + ], + "type": "object" + }, + "v1SettingsMappingExtendedExtended": { + "properties": { + "mapping": { + "description": "The FQDN of destination domain to map to.", + "type": "string" + } + }, + "required": [ + "mapping" + ], + "type": "object" + }, + "v1SettingsMappingMappingSettings": { + "description": "Specifies the properties for global authentication setting.", + "properties": { + "cache_entry_expiry": { + "description": "Specifies the cache expiry in seconds of the idmapper.", + "maximum": 15552000, + "minimum": 0, + "type": "integer" + }, + "gid_range_enabled": { + "description": "If true, allocates GIDs from a fixed range.", + "type": "boolean" + }, + "gid_range_max": { + "description": "Specifies the ending number for a fixed range from which GIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gid_range_min": { + "description": "Specifies the starting number for a fixed range from which GIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gid_range_next": { + "description": "Specifies the next GID to allocate.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid_range_enabled": { + "description": "If true, allocates UIDs from a fixed range.", + "type": "boolean" + }, + "uid_range_max": { + "description": "Specifies the ending number for a fixed range from which UIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid_range_min": { + "description": "Specifies the starting number for a fixed range from which UIDs are allocated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid_range_next": { + "description": "Specifies the next UID to allocate.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SettingsMappings": { + "additionalProperties": false, + "properties": { + "mappings": { + "items": { + "$ref": "#/definitions/v1SettingsMappingExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_SETTINGS_MAPPINGS" + } + }, + "type": "object" + }, + "v1SettingsMappingsExtended": { + "additionalProperties": false, + "properties": { + "mappings": { + "items": { + "$ref": "#/definitions/v1SettingsMappingExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SettingsNotifications": { + "additionalProperties": false, + "properties": { + "notifications": { + "items": { + "$ref": "#/definitions/v1QuotaNotificationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_SETTINGS_NOTIFICATIONS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SettingsReports": { + "properties": { + "settings": { + "$ref": "#/definitions/v1SettingsReportsSettings" + } + }, + "type": "object" + }, + "v1SettingsReportsExtended": { + "properties": { + "live_dir": { + "description": "The directory on /ifs where manual or live reports will be placed.", + "type": "string" + }, + "live_retain": { + "description": "The number of manual reports to keep.", + "minimum": 1, + "type": "integer" + }, + "schedule": { + "description": "The isidate schedule used to generate reports.", + "type": "string" + }, + "scheduled_dir": { + "description": "The directory on /ifs where schedule reports will be placed.", + "type": "string" + }, + "scheduled_retain": { + "description": "The number of scheduled reports to keep.", + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_SETTINGS_REPORTS" + }, + "v1SettingsReportsSettings": { + "properties": { + "live_dir": { + "description": "The directory on /ifs where manual or live reports will be placed.", + "type": "string" + }, + "live_retain": { + "description": "The number of manual reports to keep.", + "minimum": 1, + "type": "integer" + }, + "schedule": { + "description": "The isidate schedule used to generate reports.", + "type": "string" + }, + "scheduled_dir": { + "description": "The directory on /ifs where schedule reports will be placed.", + "type": "string" + }, + "scheduled_retain": { + "description": "The number of scheduled reports to keep.", + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "live_retain", + "live_dir", + "scheduled_retain", + "scheduled_dir", + "schedule" + ], + "type": "object", + "x-privilege": "ISI_PRIV_QUOTA_SETTINGS_REPORTS" + }, + "v1SmbOpenfile": { + "properties": { + "file": { + "description": "Path of file within /ifs.", + "type": "string" + }, + "id": { + "description": "The file ID.", + "type": "integer" + }, + "locks": { + "description": "Number of locks user holds on file.", + "type": "integer" + }, + "permissions": { + "description": "The user's permissions on file.", + "items": { + "enum": [ + "read", + "write", + "create" + ], + "type": "string" + }, + "type": "array" + }, + "user": { + "description": "User holding file open.", + "minLength": 0, + "type": "string" + } + }, + "required": [ + "locks", + "user", + "id", + "file", + "permissions" + ], + "type": "object" + }, + "v1SmbOpenfiles": { + "additionalProperties": false, + "properties": { + "openfiles": { + "items": { + "$ref": "#/definitions/v1SmbOpenfile" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SmbSession": { + "properties": { + "active_time": { + "description": "Number of seconds since session start.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "client_type": { + "description": "Client type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "computer": { + "description": "Client internet address.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "encryption": { + "description": "True if session is encrypted.", + "type": "boolean" + }, + "guest_login": { + "description": "True for guest logins.", + "type": "boolean" + }, + "id": { + "description": "The session ID.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "idle_time": { + "description": "Number of seconds since last client operation.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "openfiles": { + "description": "Number of files open by client.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "user": { + "description": "Local user name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "active_time", + "computer", + "encryption", + "idle_time", + "client_type", + "guest_login", + "openfiles", + "id", + "user" + ], + "type": "object" + }, + "v1SmbSessions": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "sessions": { + "items": { + "$ref": "#/definitions/v1SmbSession" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMB_SESSIONS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SmbSettingsGlobal": { + "properties": { + "settings": { + "$ref": "#/definitions/v1SmbSettingsGlobalSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v1SmbSettingsGlobalSettings": { + "properties": { + "access_based_share_enum": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "audit_fileshare": { + "description": "Specify level of file share audit events to log.", + "enum": [ + "all", + "success", + "failure", + "none" + ], + "type": "string" + }, + "audit_global_sacl": { + "description": "Specifies a list of permissions to audit.", + "items": { + "$ref": "#/definitions/v1SmbSettingsGlobalSettingsAuditGlobalSaclItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "audit_logon": { + "description": "Specify the level of logon audit events to log.", + "enum": [ + "all", + "success", + "failure", + "none" + ], + "type": "string" + }, + "dot_snap_accessible_child": { + "description": "Allow access to .snapshot directories in share subdirectories.", + "type": "boolean" + }, + "dot_snap_accessible_root": { + "description": "Allow access to the .snapshot directory in the root of the share.", + "type": "boolean" + }, + "dot_snap_visible_child": { + "description": "Show .snapshot directories in share subdirectories.", + "type": "boolean" + }, + "dot_snap_visible_root": { + "description": "Show the .snapshot directory in the root of a share.", + "type": "boolean" + }, + "enable_security_signatures": { + "description": "Indicates whether the server supports signed SMB packets.", + "type": "boolean" + }, + "guest_user": { + "description": "Specifies the fully-qualified user to use for guest access.", + "type": "string" + }, + "ignore_eas": { + "description": "Specify whether to ignore EAs on files.", + "type": "boolean" + }, + "onefs_cpu_multiplier": { + "description": "Specify the number of OneFS driver worker threads per CPU.", + "maximum": 4, + "minimum": 1, + "type": "integer" + }, + "onefs_num_workers": { + "description": "Set the maximum number of OneFS driver worker threads.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "require_security_signatures": { + "description": "Indicates whether the server requires signed SMB packets.", + "type": "boolean" + }, + "server_string": { + "description": "Provides a description of the server.", + "type": "string" + }, + "service": { + "description": "Specify whether service is enabled.", + "type": "boolean" + }, + "srv_cpu_multiplier": { + "description": "Specify the number of SRV service worker threads per CPU.", + "maximum": 8, + "minimum": 1, + "type": "integer" + }, + "srv_num_workers": { + "description": "Set the maximum number of SRV service worker threads.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "support_multichannel": { + "description": "Support multichannel.", + "type": "boolean" + }, + "support_netbios": { + "description": "Support NetBIOS.", + "type": "boolean" + }, + "support_smb2": { + "description": "Support the SMB2 protocol on the server.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_GLOBAL" + }, + "v1SmbSettingsGlobalSettingsAuditGlobalSaclItem": { + "description": "Specifies properties for a SACL Access Control Entry.", + "properties": { + "flags": { + "description": "Determines if audit is performed on success or failure.", + "enum": [ + "successful", + "failed" + ], + "type": "string" + }, + "permission": { + "description": "Specifies the array of filesystem rights that are governed.", + "items": { + "description": "Specifies filesystem access permissions.", + "enum": [ + "generic_all", + "generic_read", + "generic_write", + "generic_exec", + "std_delete", + "std_read_dac", + "std_write_dac", + "std_write_owner", + "std_synchronize", + "std_required", + "list", + "add_file", + "add_subdir", + "delete_child", + "traverse", + "dir_read_attr", + "dir_write_attr", + "dir_read_ext_attr", + "dir_write_ext_attr", + "dir_gen_read", + "dir_gen_write", + "dir_gen_execute", + "dir_gen_all", + "file_read", + "file_write", + "append", + "execute", + "file_read_attr", + "file_write_attr", + "file_read_ext_attr", + "file_write_ext_attr", + "file_gen_read", + "file_gen_write", + "file_gen_execute", + "file_gen_all", + "modify", + "object_inherit", + "container_inherit", + "no_prop_inherit", + "inherit_only", + "inherited_ace" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "flags", + "permission" + ], + "type": "object" + }, + "v1SmbSettingsShare": { + "properties": { + "settings": { + "$ref": "#/definitions/v1SmbSettingsShareSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v1SmbSettingsShareSettings": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "change_notify": { + "description": "Specify level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Set the create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "directory_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "type": "string" + }, + "type": "array" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "type": "string" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Allow oplock requests.", + "type": "boolean" + }, + "sparse_file": { + "description": "Specifies whether sparse file is supported or not.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone in which to update settings", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_SHARE" + }, + "v1SmbShare": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_path": { + "description": "Create path if does not exist.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "type": "integer" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "type": "string" + }, + "type": "array" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Share name.", + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "sparse_file": { + "description": "Specifies whether sparse file is supported or not.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share", + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "v1SmbShareExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "type": "integer" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Share ID.", + "minimum": 0, + "type": "string" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Share name.", + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "sparse_file": { + "description": "Specifies whether sparse file is supported or not.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zid": { + "description": "Numeric ID of the access zone which contains this SMB share", + "type": "integer" + } + }, + "required": [ + "path", + "id", + "zid", + "name" + ], + "type": "object" + }, + "v1SmbShareExtendedExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "type": "integer" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "type": "string" + }, + "type": "array" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Share name.", + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "sparse_file": { + "description": "Specifies whether sparse file is supported or not.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share", + "type": "string" + } + }, + "type": "object" + }, + "v1SmbSharePermission": { + "description": "Specifies properties for an Access Control Entry.", + "properties": { + "permission": { + "description": "Specifies the file system rights that are allowed or denied.", + "enum": [ + "full", + "change", + "read" + ], + "type": "string" + }, + "permission_type": { + "description": "Determines whether the permission is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "type": "string" + }, + "trustee": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + "required": [ + "permission_type", + "trustee", + "permission" + ], + "type": "object" + }, + "v1SmbShares": { + "additionalProperties": false, + "properties": { + "digest": { + "description": "An identifier for a set of shares.", + "type": "string" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "shares": { + "items": { + "$ref": "#/definitions/v1SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v1SmbSharesExtended": { + "additionalProperties": false, + "properties": { + "shares": { + "items": { + "$ref": "#/definitions/v1SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v1SmbSharesSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v1SmbSharesSummarySummary" + } + }, + "type": "object" + }, + "v1SmbSharesSummarySummary": { + "properties": { + "count": { + "description": "Total number of shares.", + "type": "integer" + } + }, + "required": [ + "count" + ], + "type": "object" + }, + "v1SnapshotAlias": { + "properties": { + "name": { + "description": "The user or system supplied snapshot name.", + "type": "string" + }, + "target": { + "description": "Snapshot name target for the alias.", + "type": "string" + } + }, + "required": [ + "name", + "target" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_ALIAS" + }, + "v1SnapshotAliasExtended": { + "properties": { + "created": { + "description": "The Unix Epoch time the snapshot alias was created.", + "type": "integer" + }, + "id": { + "description": "The system ID given to the snapshot alias.", + "type": "integer" + }, + "name": { + "description": "The user or system supplied snapshot alias name.", + "type": "string" + }, + "target_id": { + "description": "The ID of the snapshot pointed to.", + "type": "integer" + }, + "target_name": { + "description": "The name of the snapshot pointed to.", + "type": "string" + } + }, + "required": [ + "target_name", + "target_id", + "id", + "name", + "created" + ], + "type": "object" + }, + "v1SnapshotAliasExtendedExtended": { + "properties": { + "name": { + "description": "The user or system supplied snapshot alias name.", + "type": "string" + }, + "target": { + "description": "Target snapshot for this snapshot alias.", + "type": "string" + } + }, + "type": "object" + }, + "v1SnapshotAliases": { + "properties": { + "aliases": { + "items": { + "$ref": "#/definitions/v1SnapshotAliasExtended" + }, + "type": "array", + "x-privilege": "ISI_PRIV_SNAPSHOT_ALIAS" + }, + "resume": { + "description": "Resume token value to use in subsequent calls for continuation.", + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotAliasesExtended": { + "properties": { + "aliases": { + "items": { + "$ref": "#/definitions/v1SnapshotAliasExtended" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1SnapshotChangelist": { + "properties": { + "id": { + "description": "The system ID given to the changelist.", + "type": "string" + }, + "job_id": { + "description": "The ID of the job which created the changelist.", + "type": "integer" + }, + "num_entries": { + "description": "Number of LIN entries in changelist.", + "type": "integer" + }, + "root_path": { + "description": "Root path of all LINs in changelist.", + "type": "string" + }, + "snap1": { + "description": "The lower snapid used to compute the changelist.", + "type": "integer" + }, + "snap2": { + "description": "The higher snapid used to compute the changelist.", + "type": "integer" + }, + "status": { + "description": "Status of changelist.", + "type": "string" + } + }, + "required": [ + "snap1", + "status", + "snap2", + "job_id", + "root_path", + "id" + ], + "type": "object" + }, + "v1SnapshotChangelists": { + "additionalProperties": false, + "properties": { + "changelists": { + "items": { + "$ref": "#/definitions/v1SnapshotChangelist" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotLock": { + "properties": { + "comment": { + "description": "Free form comment.", + "type": "string" + }, + "expires": { + "description": "The Unix Epoch time the snapshot lock will expire and be eligible for automatic deletion.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_LOCKS" + }, + "v1SnapshotLockExtended": { + "properties": { + "comment": { + "description": "User supplied lock comment.", + "type": "string" + }, + "count": { + "description": "Recursive lock count.", + "type": "integer" + }, + "expires": { + "description": "The Unix Epoch time the snapshot lock will expire and be eligible for automatic deletion.", + "type": "integer" + }, + "id": { + "description": "System generated lock ID.", + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotLocks": { + "properties": { + "locks": { + "items": { + "$ref": "#/definitions/v1SnapshotLockExtended" + }, + "type": "array", + "x-privilege": "ISI_PRIV_SNAPSHOT_LOCKS" + }, + "resume": { + "description": "Resume token value to use in subsequent calls for continuation.", + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotPending": { + "properties": { + "pending": { + "items": { + "$ref": "#/definitions/v1SnapshotPendingPendingItem" + }, + "type": "array", + "x-privilege": "ISI_PRIV_SNAPSHOT_PENDING" + }, + "resume": { + "description": "Resume token value to use in subsequent calls for continuation.", + "type": "string" + } + }, + "type": "object" + }, + "v1SnapshotPendingPendingItem": { + "properties": { + "id": { + "description": "The system supplied unique ID used for sorting and paging.", + "type": "string" + }, + "path": { + "description": "The /ifs path that will snapshotted.", + "type": "string" + }, + "schedule": { + "description": "The name of the schedule used to create this snapshot.", + "type": "string" + }, + "snapshot": { + "description": "The system snapshot name formed from the schedule formate.", + "type": "string" + }, + "time": { + "description": "The Unix Epoch time the snapshot will be created.", + "type": "integer" + } + }, + "required": [ + "path", + "time", + "snapshot", + "id", + "schedule" + ], + "type": "object" + }, + "v1SnapshotRepstate": { + "properties": { + "id": { + "description": "The system ID given to the repstate.", + "type": "string" + }, + "snap1": { + "description": "The lower snapid used to compute the repstate.", + "type": "integer" + }, + "snap2": { + "description": "The higher snapid used to compute the repstate.", + "type": "integer" + } + }, + "required": [ + "snap1", + "snap2", + "id" + ], + "type": "object" + }, + "v1SnapshotRepstates": { + "additionalProperties": false, + "properties": { + "repstates": { + "items": { + "$ref": "#/definitions/v1SnapshotRepstate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotSchedule": { + "properties": { + "alias": { + "description": "Alias name to create for each snapshot.", + "type": "string" + }, + "duration": { + "description": "Time in seconds added to creation time to construction expiration time.", + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The schedule name.", + "type": "string" + }, + "path": { + "description": "The /ifs path snapshotted.", + "type": "string" + }, + "pattern": { + "description": "Pattern expanded with strftime to create snapshot names.", + "type": "string" + }, + "schedule": { + "description": "The isidate compatible natural language description of the schedule.", + "type": "string" + } + }, + "required": [ + "name", + "schedule", + "pattern", + "path" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_SCHEDULES" + }, + "v1SnapshotScheduleExtended": { + "properties": { + "alias": { + "description": "Alias name to create for each snapshot.", + "type": "string" + }, + "duration": { + "description": "Time in seconds added to creation time to construction expiration time.", + "type": "integer" + }, + "id": { + "description": "The system ID given to the schedule.", + "type": "integer" + }, + "name": { + "description": "The schedule name.", + "type": "string" + }, + "next_run": { + "description": "Unix Epoch time of next snapshot to be created.", + "type": "integer" + }, + "next_snapshot": { + "description": "Formatted name (see pattern) of next snapshot to be created.", + "type": "string" + }, + "path": { + "description": "The /ifs path snapshotted.", + "type": "string" + }, + "pattern": { + "description": "Pattern expanded with strftime to create snapshot names.", + "type": "string" + }, + "schedule": { + "description": "The isidate compatible natural language description of the schedule.", + "type": "string" + } + }, + "type": "object" + }, + "v1SnapshotScheduleExtendedExtended": { + "properties": { + "alias": { + "description": "Alias name to create for each snapshot.", + "type": "string" + }, + "duration": { + "description": "Time in seconds added to creation time to construction expiration time.", + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The schedule name.", + "type": "string" + }, + "path": { + "description": "The /ifs path snapshotted.", + "type": "string" + }, + "pattern": { + "description": "Pattern expanded with strftime to create snapshot names.", + "type": "string" + }, + "schedule": { + "description": "The isidate compatible natural language description of the schedule.", + "type": "string" + } + }, + "type": "object" + }, + "v1SnapshotScheduleExtendedExtendedExtended": { + "properties": { + "alias": { + "description": "Alias name to create for each snapshot.", + "type": "string" + }, + "duration": { + "description": "Time in seconds added to creation time to construction expiration time.", + "type": "integer" + }, + "id": { + "description": "The system ID given to the schedule.", + "type": "integer" + }, + "name": { + "description": "The schedule name.", + "type": "string" + }, + "next_run": { + "description": "Unix Epoch time of next snapshot to be created.", + "type": "integer" + }, + "next_snapshot": { + "description": "Formatted name (see pattern) of next snapshot to be created.", + "type": "string" + }, + "path": { + "description": "The /ifs path snapshotted.", + "type": "string" + }, + "pattern": { + "description": "Pattern expanded with strftime to create snapshot name.", + "type": "string" + }, + "schedule": { + "description": "The isidate compatible natural language description of the schedule.", + "type": "string" + } + }, + "type": "object" + }, + "v1SnapshotSchedules": { + "properties": { + "resume": { + "description": "Resume token value to use in subsequent calls for continuation.", + "type": "string" + }, + "schedules": { + "items": { + "$ref": "#/definitions/v1SnapshotScheduleExtended" + }, + "type": "array", + "x-privilege": "ISI_PRIV_SNAPSHOT_SCHEDULES" + }, + "total": { + "description": "Total number of items available.", + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotSchedulesExtended": { + "properties": { + "schedules": { + "items": { + "$ref": "#/definitions/v1SnapshotScheduleExtendedExtendedExtended" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1SnapshotSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v1SnapshotSettingsSettings" + } + }, + "type": "object" + }, + "v1SnapshotSettingsExtended": { + "properties": { + "autocreate": { + "description": "True if the scheduled snapshot creation services is on.", + "type": "boolean" + }, + "autodelete": { + "description": "True if the scheduled snapshot deletion services is on.", + "type": "boolean" + }, + "global_visible_accessible": { + "description": "Global switch for other accessible and visible settings.", + "type": "boolean" + }, + "local_root_accessible": { + "description": "True if root .snapshot directory is accessible locally.", + "type": "boolean" + }, + "local_root_visible": { + "description": "True if root .snapshot directory is visible locally.", + "type": "boolean" + }, + "local_subdir_accessible": { + "description": "True if sub-directory .snapshot directory is accessible locally.", + "type": "boolean" + }, + "nfs_root_accessible": { + "description": "True if root .snapshot directory is accessible over NFS.", + "type": "boolean" + }, + "nfs_root_visible": { + "description": "True if root .snapshot directory is visible over NFS.", + "type": "boolean" + }, + "nfs_subdir_accessible": { + "description": "True if sub-directory .snapshot directory is accessible over NFS.", + "type": "boolean" + }, + "reserve": { + "description": "Percentage of space to reserve for snapshots.", + "type": "number" + }, + "service": { + "description": "True if the system allows snapshot creation.", + "type": "boolean" + }, + "smb_root_accessible": { + "description": "True if root .snapshot directory is accessible over SMB.", + "type": "boolean" + }, + "smb_root_visible": { + "description": "True if root .snapshot directory is visible over SMB.", + "type": "boolean" + }, + "smb_subdir_accessible": { + "description": "True if sub-directory .snapshot directory is accessible over SMB.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_SETTING" + }, + "v1SnapshotSettingsSettings": { + "properties": { + "autocreate": { + "description": "True if the scheduled snapshot creation services is on.", + "type": "boolean" + }, + "autodelete": { + "description": "True if the scheduled snapshot deletion services is on.", + "type": "boolean" + }, + "global_visible_accessible": { + "description": "Global switch for other accessible and visible settings.", + "type": "boolean" + }, + "local_root_accessible": { + "description": "True if root .snapshot directory is accessible locally.", + "type": "boolean" + }, + "local_root_visible": { + "description": "True if root .snapshot directory is visible locally.", + "type": "boolean" + }, + "local_subdir_accessible": { + "description": "True if sub-directory .snapshot directory is accessible locally.", + "type": "boolean" + }, + "nfs_root_accessible": { + "description": "True if root .snapshot directory is accessible over NFS.", + "type": "boolean" + }, + "nfs_root_visible": { + "description": "True if root .snapshot directory is visible over NFS.", + "type": "boolean" + }, + "nfs_subdir_accessible": { + "description": "True if sub-directory .snapshot directory is accessible over NFS.", + "type": "boolean" + }, + "reserve": { + "description": "Percentage of space to reserve for snapshots.", + "type": "number" + }, + "service": { + "description": "True if the system allows snapshot creation.", + "type": "boolean" + }, + "smb_root_accessible": { + "description": "True if root .snapshot directory is accessible over SMB.", + "type": "boolean" + }, + "smb_root_visible": { + "description": "True if root .snapshot directory is visible over SMB.", + "type": "boolean" + }, + "smb_subdir_accessible": { + "description": "True if sub-directory .snapshot directory is accessible over SMB.", + "type": "boolean" + } + }, + "required": [ + "nfs_root_visible", + "smb_root_visible", + "local_root_visible", + "autodelete", + "reserve", + "smb_subdir_accessible", + "local_root_accessible", + "autocreate", + "service", + "nfs_root_accessible", + "nfs_subdir_accessible", + "smb_root_accessible", + "global_visible_accessible", + "local_subdir_accessible" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_SETTING" + }, + "v1SnapshotSnapshot": { + "properties": { + "alias": { + "description": "Alias name to create for this snapshot. If null, remove any alias.", + "minLength": 0, + "type": "string" + }, + "expires": { + "description": "The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.", + "maximum": 2147483646, + "type": "integer" + }, + "name": { + "description": "The user or system supplied snapshot name. This will be null for snapshots pending delete.", + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The /ifs path snapshotted.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_SNAPSHOTMANAGEMENT" + }, + "v1SnapshotSnapshotExtended": { + "properties": { + "alias": { + "description": "The name of the alias, none for real snapshots.", + "minLength": 0, + "type": "string" + }, + "created": { + "description": "The Unix Epoch time the snapshot was created.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "expires": { + "description": "The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.", + "maximum": 2147483646, + "type": "integer" + }, + "has_locks": { + "description": "True if the snapshot has one or more locks present see, see the locks subresource of a snapshot for a list of locks.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the snapshot. This is useful for tracking the status of delete pending snapshots.", + "maximum": 2147483646, + "type": "integer" + }, + "name": { + "description": "The user or system supplied snapshot name. This will be null for snapshots pending delete.", + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The /ifs path snapshotted.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "pct_filesystem": { + "description": "Percentage of /ifs used for storing this snapshot.", + "type": "number" + }, + "pct_reserve": { + "description": "Percentage of configured snapshot reserved used for storing this snapshot.", + "type": "number" + }, + "schedule": { + "description": "The name of the schedule used to create this snapshot, if applicable.", + "minLength": 0, + "type": "string" + }, + "shadow_bytes": { + "description": "The amount of shadow bytes referred to by this snapshot.", + "maximum": 2147483646, + "type": "integer" + }, + "size": { + "description": "The amount of storage in bytes used to store this snapshot.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "Snapshot state.", + "enum": [ + "active", + "deleting" + ], + "minLength": 0, + "type": "string" + }, + "target_id": { + "description": "The ID of the snapshot pointed to if this is an alias. 18446744073709551615 (max uint64) is returned for an alias to the live filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_name": { + "description": "The name of the snapshot pointed to if this is an alias.", + "minLength": 0, + "type": "string" + } + }, + "required": [ + "pct_reserve", + "shadow_bytes", + "name", + "created", + "target_name", + "expires", + "target_id", + "schedule", + "state", + "has_locks", + "path", + "pct_filesystem", + "id", + "size" + ], + "type": "object" + }, + "v1SnapshotSnapshotExtendedExtended": { + "properties": { + "alias": { + "description": "Alias name to create for this snapshot. If null, remove any alias.", + "minLength": 0, + "type": "string" + }, + "expires": { + "description": "The Unix Epoch time the snapshot will expire and be eligible for automatic deletion.", + "maximum": 2147483646, + "type": "integer" + }, + "name": { + "description": "The user or system supplied snapshot name. This will be null for snapshots pending delete.", + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1SnapshotSnapshots": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "snapshots": { + "items": { + "$ref": "#/definitions/v1SnapshotSnapshotExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SNAPSHOT_SNAPSHOTMANAGEMENT" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotSnapshotsExtended": { + "additionalProperties": false, + "properties": { + "snapshots": { + "items": { + "$ref": "#/definitions/Createv1SnapshotSnapshotResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SnapshotSnapshotsSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v1SnapshotSnapshotsSummarySummary" + } + }, + "type": "object" + }, + "v1SnapshotSnapshotsSummarySummary": { + "properties": { + "active_count": { + "description": "Total number of active snapshots.", + "type": "integer" + }, + "active_size": { + "description": "Sum of sizes of active snapshots.", + "type": "integer" + }, + "aliases_count": { + "description": "Total number of snapshot aliases.", + "type": "integer" + }, + "count": { + "description": "Total number of snapshots.", + "type": "integer" + }, + "deleting_count": { + "description": "Total number of delete-pending snapshots.", + "type": "integer" + }, + "deleting_size": { + "description": "Sum of sizes of delete-pending snapshots.", + "type": "integer" + }, + "shadow_bytes": { + "description": "Sum of shadow bytes of all snapshots.", + "type": "integer" + }, + "size": { + "description": "Sum of sizes in bytes of all snapshots.", + "type": "integer" + } + }, + "required": [ + "count", + "aliases_count", + "shadow_bytes", + "deleting_size", + "active_size", + "deleting_count", + "active_count", + "size" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SNAPSHOT_SUMMARY" + }, + "v1SnapshotsSidLock": { + "properties": { + "expires": { + "description": "The Unix Epoch time the snapshot lock will expire and be eligible for automatic deletion.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v1SnapshotsSidLocks": { + "properties": { + "locks": { + "items": { + "$ref": "#/definitions/v1SnapshotLockExtended" + }, + "type": "array" + } + }, + "type": "object" + }, + "v1StatisticsCurrent": { + "additionalProperties": false, + "properties": { + "stats": { + "items": { + "$ref": "#/definitions/v1StatisticsCurrentStat" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1StatisticsCurrentStat": { + "properties": { + "devid": { + "description": "Devid of node of statistic or 0 for cluster scoped statistics.", + "type": "integer" + }, + "error": { + "description": "Key specific error string, if applicable.", + "type": "string" + }, + "error_code": { + "description": "Key specific error number, if applicable.", + "type": "integer" + }, + "key": { + "description": "Key name of statistic.", + "type": "string" + }, + "time": { + "description": "Unix Epoch time in seconds that statistic was collected.", + "type": "integer" + }, + "value": { + "description": "Key dependent value.", + "type": "string" + } + }, + "required": [ + "error", + "devid", + "value", + "key", + "time", + "error_code" + ], + "type": "object" + }, + "v1StatisticsHistory": { + "additionalProperties": false, + "properties": { + "stats": { + "items": { + "$ref": "#/definitions/v1StatisticsHistoryStat" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1StatisticsHistoryStat": { + "properties": { + "devid": { + "description": "Devid of node of statistic or 0 for cluster scoped statistics.", + "type": "integer" + }, + "error": { + "description": "Key specific error string, if applicable.", + "type": "string" + }, + "error_code": { + "description": "Key specific error number, if applicable.", + "type": "integer" + }, + "key": { + "description": "Key name of statistic.", + "type": "string" + }, + "resolution": { + "description": "The interval for which these results were figured (averaged against.)", + "type": "integer" + }, + "values": { + "description": "Time-series values.", + "items": { + "$ref": "#/definitions/v1StatisticsHistoryStatValue" + }, + "type": "array" + } + }, + "required": [ + "error_code", + "devid", + "values", + "key", + "error", + "resolution" + ], + "type": "object" + }, + "v1StatisticsHistoryStatValue": { + "properties": { + "time": { + "description": "Unix Epoch time in seconds that statistic was collected.", + "type": "integer" + }, + "value": { + "description": "Key dependent value.", + "type": "string" + } + }, + "required": [ + "value", + "time" + ], + "type": "object" + }, + "v1StatisticsKey": { + "properties": { + "aggregation_type": { + "description": "Type of aggregation used in down-sampling.", + "enum": [ + "last", + "min", + "max", + "avg", + "sum", + "custom" + ], + "type": "string" + }, + "base_name": { + "description": "Name of key this keys is derived from, if any.", + "type": "string" + }, + "default_cache_time": { + "description": "Default time in seconds system will used cached values.", + "type": "integer" + }, + "description": { + "description": "Description of statistics key.", + "type": "string" + }, + "key": { + "description": "Key name.", + "type": "string" + }, + "policies": { + "description": "List of effective history policies for key.", + "items": { + "$ref": "#/definitions/v1StatisticsKeyPolicy" + }, + "type": "array" + }, + "policy_cache_time": { + "description": "Configured time in seconds system will used cached values.", + "type": "integer" + }, + "real_name": { + "description": "Name of real key if this is an alias.", + "type": "string" + }, + "scope": { + "description": "Scope of key.", + "enum": [ + "cluster", + "node" + ], + "type": "string" + }, + "type": { + "description": "Data type of key values.", + "type": "string" + }, + "units": { + "description": "Units of key values.", + "type": "string" + } + }, + "required": [ + "policies", + "base_name", + "policy_cache_time", + "default_cache_time", + "description", + "real_name", + "key", + "units", + "scope", + "type", + "aggregation_type" + ], + "type": "object" + }, + "v1StatisticsKeyPolicy": { + "properties": { + "interval": { + "description": "Time between samples in seconds.", + "type": "integer" + }, + "persistent": { + "description": "If true, history is persisted.", + "type": "boolean" + }, + "retention": { + "description": "Time in seconds to keep data.", + "type": "integer" + } + }, + "required": [ + "interval", + "persistent", + "retention" + ], + "type": "object" + }, + "v1StatisticsKeys": { + "additionalProperties": false, + "properties": { + "keys": { + "items": { + "$ref": "#/definitions/v1StatisticsKey" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1StatisticsKeysExtended": { + "additionalProperties": false, + "properties": { + "keys": { + "items": { + "$ref": "#/definitions/v1StatisticsKey" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1StatisticsProtocol": { + "properties": { + "name": { + "description": "Abbreviated name of protocol.", + "type": "string" + }, + "type": { + "description": "External protocols are customer facing, internal protocols expose metrics for internal OneFS systems.", + "enum": [ + "external", + "internal" + ], + "type": "string" + } + }, + "required": [ + "type", + "name" + ], + "type": "object" + }, + "v1StatisticsProtocols": { + "properties": { + "protocols": { + "items": { + "$ref": "#/definitions/v1StatisticsProtocol" + }, + "type": "array" + } + }, + "required": [ + "protocols" + ], + "type": "object" + }, + "v1StoragepoolNodepool": { + "properties": { + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "lnns": { + "description": "The node membership change requested for this node pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The node pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "protection_policy": { + "description": "The node pool protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "tier": { + "description": "The name or ID of the node pool's tier, if it is in a tier.", + "type": "string" + } + }, + "required": [ + "name", + "lnns" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "v1StoragepoolNodepoolExtended": { + "properties": { + "can_disable_l3": { + "description": "Indicates if disabling L3 is possible.", + "type": "boolean" + }, + "can_enable_l3": { + "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the node pool.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "l3_status": { + "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", + "enum": [ + "l3", + "storage", + "migrating" + ], + "type": "string" + }, + "lnns": { + "description": "The nodes that are part of this node pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "manual": { + "description": "Whether or not the node pool is manually managed.", + "type": "boolean" + }, + "name": { + "description": "The node pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "protection_policy": { + "description": "The underlying protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "tier": { + "description": "The name (if named) or system ID of the node pool's tier, if it is in a tier. Otherwise null.", + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v1StoragepoolNodepoolUsage" + } + }, + "required": [ + "name", + "lnns", + "l3_status", + "manual", + "can_enable_l3", + "l3", + "can_disable_l3", + "tier", + "id" + ], + "type": "object" + }, + "v1StoragepoolNodepoolExtendedExtended": { + "properties": { + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "lnns": { + "description": "The node membership change requested for this node pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The node pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "protection_policy": { + "description": "The node pool protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "tier": { + "description": "The name or ID of the node pool's tier, if it is in a tier.", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "v1StoragepoolNodepoolUsage": { + "description": "Total pool usage.", + "properties": { + "avail_bytes": { + "description": "Available free bytes remaining in the pool when virtual hot spare is taken into account.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "avail_hdd_bytes": { + "description": "Available free bytes remaining in the pool on HDD drives when virtual hot spare is taken into account.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "avail_ssd_bytes": { + "description": "Available free bytes remaining in the pool on SSD drives when virtual hot spare is taken into account.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "balanced": { + "description": "Whether or not the pool usage is currently balanced.", + "type": "boolean" + }, + "free_bytes": { + "description": "Free bytes remaining in the pool.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "free_hdd_bytes": { + "description": "Free bytes remaining in the pool on HDD drives.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "free_ssd_bytes": { + "description": "Free bytes remaining in the pool on SSD drives.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "pct_used": { + "description": "Percentage of usable space in the pool which is used.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "pct_used_hdd": { + "description": "Percentage of usable space on HDD drives in the pool which is used.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "pct_used_ssd": { + "description": "Percentage of usable space on SSD drives in the pool which is used.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "total_bytes": { + "description": "Total bytes in the pool.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "total_hdd_bytes": { + "description": "Total bytes in the pool on HDD drives.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "total_ssd_bytes": { + "description": "Total bytes in the pool on SSD drives.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "usable_bytes": { + "description": "Total bytes in the pool drives when virtual hot spare is taken into account.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "usable_hdd_bytes": { + "description": "Total bytes in the pool on HDD drives when virtual hot spare is taken into account.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "usable_ssd_bytes": { + "description": "Total bytes in the pool on SSD drives when virtual hot spare is taken into account.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "used_bytes": { + "description": "Used bytes in the pool.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "used_hdd_bytes": { + "description": "Used bytes in the pool on HDD drives.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "used_ssd_bytes": { + "description": "Used bytes in the pool on SSD drives.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "virtual_hot_spare_bytes": { + "description": "Bytes reserved for virtual hot spare in the pool.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "used_hdd_bytes", + "avail_bytes", + "usable_ssd_bytes", + "pct_used_hdd", + "avail_hdd_bytes", + "pct_used_ssd", + "avail_ssd_bytes", + "free_hdd_bytes", + "free_bytes", + "total_ssd_bytes", + "total_bytes", + "pct_used", + "balanced", + "free_ssd_bytes", + "usable_bytes", + "usable_hdd_bytes", + "used_ssd_bytes", + "total_hdd_bytes" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_POOLDETAILS_USAGE" + }, + "v1StoragepoolNodepools": { + "additionalProperties": false, + "properties": { + "nodepools": { + "items": { + "$ref": "#/definitions/v1StoragepoolNodepoolExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1StoragepoolNodepoolsExtended": { + "additionalProperties": false, + "properties": { + "nodepools": { + "items": { + "$ref": "#/definitions/v1StoragepoolNodepoolExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1StoragepoolSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v1StoragepoolSettingsSettings" + } + }, + "type": "object" + }, + "v1StoragepoolSettingsExtended": { + "additionalProperties": false, + "properties": { + "automatically_manage_io_optimization": { + "description": "Automatically manage IO optimization settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "automatically_manage_protection": { + "description": "Automatically manage protection settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "global_namespace_acceleration_enabled": { + "description": "Optimize namespace operations by storing metadata on SSDs.", + "type": "boolean" + }, + "protect_directories_one_level_higher": { + "description": "Automatically add additional protection level to all directories.", + "type": "boolean" + }, + "spillover_enabled": { + "description": "Spill writes into other pools as needed.", + "type": "boolean" + }, + "spillover_target": { + "$ref": "#/definitions/v1StoragepoolSettingsSpilloverTarget" + }, + "ssd_l3_cache_default_enabled": { + "description": "The L3 Cache default enabled state. This specifies whether L3 Cache should be enabled on new node pools", + "type": "boolean" + }, + "virtual_hot_spare_deny_writes": { + "description": "Deny writes into reserved virtual hot spare space.", + "type": "boolean" + }, + "virtual_hot_spare_hide_spare": { + "description": "Hide reserved virtual hot spare space from free space counts.", + "type": "boolean" + }, + "virtual_hot_spare_limit_drives": { + "description": "The number of drives to reserve for the virtual hot spare, from 0-4.", + "maximum": 4, + "minimum": 0, + "type": "integer" + }, + "virtual_hot_spare_limit_percent": { + "description": "The percent space to reserve for the virtual hot spare, from 0-20.", + "maximum": 20, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_SETTINGS" + }, + "v1StoragepoolSettingsSettings": { + "additionalProperties": false, + "properties": { + "automatically_manage_io_optimization": { + "description": "Automatically manage IO optimization settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "automatically_manage_protection": { + "description": "Automatically manage protection settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "global_namespace_acceleration_enabled": { + "description": "Optimize namespace operations by storing metadata on SSDs.", + "type": "boolean" + }, + "global_namespace_acceleration_state": { + "description": "Whether or not namespace operation optimizations are currently in effect.", + "enum": [ + "honored", + "inactive" + ], + "type": "string" + }, + "protect_directories_one_level_higher": { + "description": "Automatically add additional protection level to all directories.", + "type": "boolean" + }, + "spillover_enabled": { + "description": "Spill writes into other pools as needed.", + "type": "boolean" + }, + "spillover_target": { + "$ref": "#/definitions/v1StoragepoolSettingsSettingsSpilloverTarget" + }, + "ssd_l3_cache_default_enabled": { + "description": "The L3 Cache default enabled state. This specifies whether L3 Cache should be enabled on new node pools.", + "type": "boolean" + }, + "virtual_hot_spare_deny_writes": { + "description": "Deny writes into reserved virtual hot spare space.", + "type": "boolean" + }, + "virtual_hot_spare_hide_spare": { + "description": "Hide reserved virtual hot spare space from free space counts.", + "type": "boolean" + }, + "virtual_hot_spare_limit_drives": { + "description": "The number of drives to reserve for the virtual hot spare, from 0-4.", + "maximum": 4, + "minimum": 0, + "type": "integer" + }, + "virtual_hot_spare_limit_percent": { + "description": "The percent space to reserve for the virtual hot spare, from 0-20.", + "maximum": 20, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "virtual_hot_spare_deny_writes", + "virtual_hot_spare_hide_spare", + "spillover_target", + "global_namespace_acceleration_enabled", + "virtual_hot_spare_limit_percent", + "virtual_hot_spare_limit_drives", + "automatically_manage_io_optimization", + "spillover_enabled", + "ssd_l3_cache_default_enabled", + "automatically_manage_protection", + "global_namespace_acceleration_state", + "protect_directories_one_level_higher" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_SETTINGS" + }, + "v1StoragepoolSettingsSettingsSpilloverTarget": { + "description": "Target pool for spilled writes.", + "properties": { + "id": { + "description": "Target pool ID if target specified, otherwise null.", + "type": "integer" + }, + "name": { + "description": "Target pool name if target specified, otherwise null.", + "type": "string" + }, + "type": { + "description": "Type of target pool.", + "enum": [ + "tier", + "nodepool", + "anywhere", + "invalid" + ], + "type": "string" + } + }, + "required": [ + "type", + "id", + "name" + ], + "type": "object" + }, + "v1StoragepoolSettingsSpilloverTarget": { + "description": "Target pool for spilled writes.", + "properties": { + "name_or_id": { + "description": "Target pool ID if target specified, otherwise null.", + "type": "string" + }, + "type": { + "description": "Type of target pool.", + "enum": [ + "storagepool", + "anywhere" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v1StoragepoolStatus": { + "properties": { + "unhealthy": { + "description": "Disk pools which are currently unhealthy.", + "items": { + "$ref": "#/definitions/v1StoragepoolStatusUnhealthyItem" + }, + "type": "array" + }, + "unprovisioned": { + "description": "Drives which are not currently provisioned into a disk pool.", + "items": { + "$ref": "#/definitions/v1StoragepoolStatusUnprovisionedItem" + }, + "type": "array" + } + }, + "required": [ + "unprovisioned", + "unhealthy" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STATUS" + }, + "v1StoragepoolStatusUnhealthyItem": { + "properties": { + "affected": { + "description": "The affected nodes and/or drives.", + "items": { + "$ref": "#/definitions/v1StoragepoolStatusUnhealthyItemAffectedItem" + }, + "type": "array" + }, + "diskpool": { + "$ref": "#/definitions/v1StoragepoolStatusUnhealthyItemDiskpool" + }, + "health_flags": { + "description": "An array of containing any health issues with this pool. If the pool is healthy, the list is empty.", + "items": { + "enum": [ + "underprovisioned", + "missing_drives", + "devices_down", + "devices_smartfailed", + "waiting_repair" + ], + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "affected" + ], + "type": "object" + }, + "v1StoragepoolStatusUnhealthyItemAffectedItem": { + "properties": { + "device": { + "$ref": "#/definitions/v1StoragepoolStatusUnprovisionedItem" + }, + "down": { + "description": "Whether or not the device is currently down.", + "type": "boolean" + }, + "restriping": { + "description": "Whether or not the device is currently being repaired.", + "type": "boolean" + }, + "smartfailed": { + "description": "Whether or not the device is currently smartfailed.", + "type": "boolean" + }, + "type": { + "description": "The type of affected device.", + "enum": [ + "node", + "drive" + ], + "type": "string" + } + }, + "required": [ + "device", + "down", + "restriping", + "type", + "smartfailed" + ], + "type": "object" + }, + "v1StoragepoolStatusUnhealthyItemDiskpool": { + "properties": { + "drives": { + "description": "The drives that are part of this disk pool.", + "items": { + "$ref": "#/definitions/v1StoragepoolStatusUnprovisionedItem" + }, + "type": "array" + }, + "id": { + "description": "The system ID given to the disk pool.", + "type": "integer" + }, + "name": { + "description": "The disk pool name.", + "type": "string" + }, + "nodepool_id": { + "description": "The system ID of the disk pool's node pool, if it is in a node pool.", + "type": "integer" + }, + "protection_policy": { + "description": "The protection policy for the disk pool.", + "type": "string" + }, + "ssd_drives": { + "description": "The SSDs that are part of this disk pool.", + "items": { + "$ref": "#/definitions/v1StoragepoolStatusUnprovisionedItem" + }, + "type": "array" + } + }, + "required": [ + "ssd_drives", + "name", + "drives", + "protection_policy", + "nodepool_id", + "id" + ], + "type": "object" + }, + "v1StoragepoolStatusUnprovisionedItem": { + "properties": { + "bay": { + "description": "The drive bay number.", + "type": "integer" + }, + "lnn": { + "description": "The node the drive is on.", + "type": "integer" + } + }, + "required": [ + "lnn", + "bay" + ], + "type": "object" + }, + "v1StoragepoolStoragepool": { + "properties": { + "can_disable_l3": { + "description": "Indicates if disabling L3 is possible.", + "type": "boolean" + }, + "can_enable_l3": { + "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives.", + "type": "boolean" + }, + "children": { + "description": "The names or IDs of the pool's children.", + "items": { + "type": "string" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "The system ID given to the pool.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "l3_status": { + "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", + "enum": [ + "l3", + "storage", + "migrating" + ], + "type": "string" + }, + "lnns": { + "description": "The nodes that are part of this pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "manual": { + "description": "Whether or not the node pool is manually managed.", + "type": "boolean" + }, + "name": { + "description": "The pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "protection_policy": { + "description": "The underlying protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The pool type.", + "enum": [ + "tier", + "nodepool" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v1StoragepoolNodepoolUsage" + } + }, + "required": [ + "name", + "lnns", + "type", + "id" + ], + "type": "object" + }, + "v1StoragepoolStoragepools": { + "additionalProperties": false, + "properties": { + "storagepools": { + "items": { + "$ref": "#/definitions/v1StoragepoolStoragepool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_POOLDETAILS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1StoragepoolTier": { + "properties": { + "children": { + "description": "The names or IDs of the tier's children.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The tier name.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_TIERS" + }, + "v1StoragepoolTierExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1StoragepoolTier" + }, + { + "properties": { + "id": { + "description": "The system ID given to the tier.", + "type": "integer" + }, + "lnns": { + "description": "The nodes that are part of this tier.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "type": "array" + }, + "usage": { + "$ref": "#/definitions/v1StoragepoolNodepoolUsage" + } + }, + "required": [ + "lnns", + "id" + ], + "type": "object" + } + ] + }, + "v1StoragepoolTierExtendedExtended": { + "properties": { + "children": { + "description": "The names or IDs of the tier's children.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The tier name.", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_TIERS" + }, + "v1StoragepoolTiers": { + "additionalProperties": false, + "properties": { + "tiers": { + "items": { + "$ref": "#/definitions/v1StoragepoolTierExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_TIERS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1StoragepoolTiersExtended": { + "additionalProperties": false, + "properties": { + "tiers": { + "items": { + "$ref": "#/definitions/v1StoragepoolTierExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1StoragepoolUnprovisioned": { + "properties": { + "unprovisioned": { + "$ref": "#/definitions/v1StoragepoolUnprovisionedUnprovisioned" + } + }, + "type": "object" + }, + "v1StoragepoolUnprovisionedUnprovisioned": { + "properties": { + "drives": { + "description": "A list of unprovisioned drives that do not belong to an unprovisioned node.", + "items": { + "$ref": "#/definitions/v1StoragepoolStatusUnprovisionedItem" + }, + "type": "array" + }, + "lnns": { + "description": "A list of lnns whose drives are all unprovisioned", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "type": "array" + } + }, + "required": [ + "drives", + "lnns" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_UNPROVISIONED" + }, + "v1SyncJob": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test" + ], + "type": "string" + }, + "id": { + "description": "The ID or Name of the policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "log_level": { + "description": "Only valid for allow_write, and allow_write_revert; specify the desired logging level, will be stored in the logs for isi_migrate, defaults to 'info'.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "source_snapshot": { + "description": "An optional snapshot to copy/sync from.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "Only valid for allow_write, and allow_write_revert; specify the desired workers per node, defaults to 3.", + "type": "integer" + } + }, + "required": [ + "id" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_JOBS" + }, + "v1SyncJobExtended": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "workers": { + "description": "A list of workers for this job.", + "items": { + "$ref": "#/definitions/v1SyncJobWorker" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "workers", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v1SyncJobExtendedExtended": { + "properties": { + "state": { + "description": "The state of the job.", + "enum": [ + "canceled", + "running", + "paused" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "v1SyncJobPhase": { + "properties": { + "end_time": { + "description": "The time the job ended this phase.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phase": { + "description": "The phase that the job was in.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "start_time": { + "description": "The time the job began this phase.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SyncJobPolicy": { + "description": "The policy associated with this job, or null if there is currently no policy associated with this job (this can happen if the job is newly created and not yet fully populated in the underlying database).", + "properties": { + "action": { + "description": "The action to be taken by the job.", + "enum": [ + "none", + "copy", + "move", + "remove", + "sync", + "allow_write", + "allow_write_revert", + "resync_prep", + "resync_prep_domain_mark", + "resync_prep_restore", + "resync_prep_finalize", + "resync_prep_commit", + "snap_revert_domain_mark", + "synciq_domain_mark", + "worm_domain_mark" + ], + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1SyncJobPolicyFileMatchingPattern": { + "description": "A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties. Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.", + "properties": { + "or_criteria": { + "description": "An array containing objects with \"and_criteria\" properties, each set of and_criteria will be logically OR'ed together to create the full file matching pattern.", + "items": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPatternOrCriteriaItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SyncJobPolicyFileMatchingPatternOrCriteriaItem": { + "properties": { + "and_criteria": { + "description": "An array containing individual file criterion objects each describing one criterion. These are logically AND'ed together to form a set of criteria.", + "items": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPatternOrCriteriaItemAndCriteriaItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SyncJobPolicyFileMatchingPatternOrCriteriaItemAndCriteriaItem": { + "description": "An object describing one criterion for finding a matching file, for example \"size is greater than or equal to 10KB\". Note: For time types (accessed_*, birth_*, and changed_*), operator is not required (it is implicitly ==). For the value, you can use a relative date and time, such as \"two weeks ago\", or specific date and time, such as \"January 1, 2012.\" Time settings are based on a 24-hour clock.", + "properties": { + "attribute_exists": { + "description": "For \"custom_attribute\" type criteria. The file will match as long as the attribute named by \"field\" exists. Default is true.", + "type": "boolean" + }, + "case_sensitive": { + "description": "If true, the value comparison will be case sensitive. Default is true.", + "type": "boolean" + }, + "field": { + "description": "The name of the file attribute to match on (only required if this is a custom_attribute type criterion). Default is an empty string \"\".", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "operator": { + "description": "How to compare the specified attribute of each file to the specified value.", + "enum": [ + "==", + "!=", + ">", + ">=", + "<", + "<=", + "!" + ], + "type": "string" + }, + "type": { + "description": "The type of this criterion, that is, which file attribute to match on.", + "enum": [ + "name", + "path", + "accessed_time", + "accessed_before", + "accessed_after", + "birth_time", + "birth_before", + "birth_after", + "changed_time", + "changed_before", + "changed_after", + "size", + "file_type", + "posix_regex_name", + "user_name", + "user_id", + "group_name", + "group_id", + "no_user", + "no_group" + ], + "type": "string" + }, + "value": { + "description": "The value to compare the specified attribute of each file to.", + "type": "string" + }, + "whole_word": { + "description": "If true, the attribute must match the entire word. Default is true.", + "type": "boolean" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v1SyncJobWorker": { + "properties": { + "connected": { + "description": "Whether there is a connection between the source and target.", + "type": "boolean" + }, + "last_split": { + "description": "The last time a network split occurred.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_work": { + "description": "The last time the worker performed work.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lin": { + "description": "The LIN being worked on.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "process_id": { + "description": "The process ID of the worker.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "The source host for this worker.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_host": { + "description": "The target host for this worker.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "worker_id": { + "description": "The ID of the worker.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SyncJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v1SyncJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_JOBS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SyncJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v1SyncJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SyncPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v1SyncPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_POLICIES" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SyncPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v1SyncPolicyExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SyncPolicy": { + "description": "Specifies the properties of a policy.", + "properties": { + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "target_host", + "name", + "target_path", + "action" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_POLICIES" + }, + "v1SyncPolicyExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "password_set": { + "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET.", + "type": "boolean" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "last_success", + "id", + "target_host", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v1SyncPolicyExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "enum": [ + false + ], + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v1SyncPolicyExtendedExtendedExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1SyncPolicyExtended" + }, + { + "description": "Specifies the properties of a policy.", + "properties": { + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "password_set": { + "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET.", + "type": "boolean" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "next_run", + "disable_stf", + "changelist", + "disable_fofb", + "restrict_target_network", + "disable_file_split", + "source_snapshot_archive", + "log_removed_files", + "log_level", + "report_max_count", + "force_interface", + "workers_per_node", + "target_detect_modifications", + "target_compare_initial_sync", + "source_network", + "target_snapshot_archive", + "report_max_age", + "description", + "password_set", + "source_snapshot_expiration", + "has_sync_state", + "target_snapshot_alias", + "last_started", + "target_snapshot_expiration", + "expected_dataloss", + "last_job_state", + "check_integrity", + "file_matching_pattern", + "target_snapshot_pattern", + "action", + "source_snapshot_pattern", + "conflicted", + "source_include_directories", + "source_exclude_directories" + ], + "type": "object" + } + ] + }, + "v1SyncPolicySourceNetwork": { + "description": "Restricts replication policies on the local cluster to running on the specified subnet and pool.", + "properties": { + "pool": { + "description": "The pool to restrict replication policies to.", + "type": "string" + }, + "subnet": { + "description": "The subnet to restrict replication policies to.", + "type": "string" + } + }, + "required": [ + "subnet", + "pool" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_POLICY_SOURCENETWORK" + }, + "v1SyncReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncReportPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v1SyncReportPolicy": { + "properties": { + "action": { + "description": "The action to be taken by the job.", + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v1SyncReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1SyncReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SyncReportsRotate": { + "description": "Force rotation of reports.", + "properties": { + "message": { + "description": "A message about the status of the task.", + "type": "string" + }, + "running": { + "description": "Whether this task is running or not.", + "type": "boolean" + } + }, + "required": [ + "message", + "running" + ], + "type": "object" + }, + "v1SyncRule": { + "description": "A rule limiting the bandwidth, file operations, or cpu usage for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, or processing percentage used for cpu.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + }, + "type": { + "description": "The type of system resource this rule limits.", + "enum": [ + "bandwidth", + "file_count", + "cpu" + ], + "type": "string" + } + }, + "required": [ + "limit", + "type" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_RULES" + }, + "v1SyncRuleExtended": { + "description": "A rule limiting the bandwidth, file operations, or cpu usage for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this performance rule.", + "type": "string" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, or processing percentage used for cpu.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + }, + "type": { + "description": "The type of system resource this rule limits.", + "enum": [ + "bandwidth", + "file_count", + "cpu" + ], + "type": "string" + } + }, + "type": "object" + }, + "v1SyncRuleExtendedExtended": { + "description": "A rule limiting the bandwidth, file operations, or cpu usage for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, or processing percentage used for cpu.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + } + }, + "type": "object" + }, + "v1SyncRuleExtendedExtendedExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1SyncRuleExtended" + }, + { + "description": "A rule limiting the bandwidth, file operations, or cpu usage for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this performance rule.", + "type": "string" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, or processing percentage used for cpu.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + }, + "type": { + "description": "The type of system resource this rule limits.", + "enum": [ + "bandwidth", + "file_count", + "cpu" + ], + "type": "string" + } + }, + "required": [ + "description", + "schedule", + "enabled", + "limit", + "type", + "id" + ], + "type": "object" + } + ] + }, + "v1SyncRuleSchedule": { + "description": "A schedule defining when during a week this performance rule is in effect. If unspecified or null, the schedule will always be in effect.", + "properties": { + "begin": { + "description": "Start time (inclusive) for this schedule, during its specified days. Format is \"hh:mm\" (24h format hour, and minute). A null value indicates the beginning of the day (\"00:00\").", + "type": "string" + }, + "end": { + "description": "End time (inclusive) for this schedule, during its specified days. Format is \"hh:mm\" (three-letter weekday name abbreviation, 24h format hour, and minute). A null value indicates the end of the day (\"23:59\").", + "type": "string" + }, + "friday": { + "description": "If true, this rule is in effect on Friday. If false, or unspecified, it is not.", + "type": "boolean" + }, + "monday": { + "description": "If true, this rule is in effect on Monday. If false, or unspecified, it is not.", + "type": "boolean" + }, + "saturday": { + "description": "If true, this rule is in effect on Saturday. If false, or unspecified, it is not.", + "type": "boolean" + }, + "sunday": { + "description": "If true, this rule is in effect on Sunday. If false, or unspecified, it is not.", + "type": "boolean" + }, + "thursday": { + "description": "If true, this rule is in effect on Thursday. If false, or unspecified, it is not.", + "type": "boolean" + }, + "tuesday": { + "description": "If true, this rule is in effect on Tuesday. If false, or unspecified, it is not.", + "type": "boolean" + }, + "wednesday": { + "description": "If true, this rule is in effect on Wednesday. If false, or unspecified, it is not.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1SyncRules": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "rules": { + "items": { + "$ref": "#/definitions/v1SyncRuleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_RULES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "rules", + "total", + "resume" + ], + "type": "object" + }, + "v1SyncRulesExtended": { + "additionalProperties": false, + "properties": { + "rules": { + "items": { + "$ref": "#/definitions/v1SyncRuleExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1SyncSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v1SyncSettingsSettings" + } + }, + "type": "object" + }, + "v1SyncSettingsExtended": { + "description": "Global SyncIQ settings.", + "properties": { + "burst_memory_constraint": { + "description": "The per-worker burst socket memory constraint, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "burst_socket_buffer_size": { + "description": "The per-worker burst socket buffer coalesced data, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS" + }, + "v1SyncSettingsSettings": { + "description": "Global SyncIQ settings.", + "properties": { + "burst_memory_constraint": { + "description": "The per-worker burst socket memory constraint, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "burst_socket_buffer_size": { + "description": "The per-worker burst socket buffer coalesced data, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "report_email", + "service", + "source_network", + "burst_memory_constraint", + "burst_socket_buffer_size", + "restrict_target_network", + "force_interface", + "report_max_count", + "report_max_age" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS" + }, + "v1TargetPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v7ServiceTargetPoliciesPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_TARGET_POLICIES" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1TargetReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v1TargetReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_TARGET_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1TargetReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v1TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1TargetReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v1ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1WormDomain": { + "properties": { + "autocommit_offset": { + "description": "Specifies the autocommit time period for the domain in seconds. After a file is in the domain without being modified for the specified time period, the file is automatically committed. If this parameter is set to null, there is no autocommit time, and files must be committed manually.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_retention": { + "description": "Specifies the default amount of time, in seconds, that a file in this domain will be protected for. The default retention period is applied if no retention date is manually set on the file. This parameter can also be set to 'forever', 'use_min' (which applies the 'min_retention' option), or 'use_max' (which applies the 'max_retention' option).", + "enum": [ + "use_min", + "use_max", + "forever" + ], + "type": "string" + }, + "max_retention": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "enum": [ + "forever" + ], + "type": "string" + }, + "min_retention": { + "description": "Specifies the minimum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a shorter retention period. If this parameter is set to null, this minimum value is not enforced. This parameter can also be set to 'forever'.", + "enum": [ + "forever" + ], + "type": "string" + }, + "override_date": { + "description": "Specifies the override retention date for the domain. If this date is later than the retention date for any committed file, the file will remain protected until the override retention date.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "Specifies the root path of this domain. Files in this directory and all sub-directories will be protected.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "privileged_delete": { + "description": "When this value is set to 'on', files in this domain can be deleted through the privileged delete feature. If this value is set to 'disabled', privileged file deletes are permanently disabled and cannot be turned on again.", + "enum": [ + "on", + "off", + "disabled" + ], + "type": "string" + }, + "type": { + "description": "Specifies whether the domain is an enterprise domain or a compliance domain. Compliance domains can not be created on enterprise clusters. Enterprise and compliance domains can be created on compliance clusters.", + "enum": [ + "enterprise", + "compliance", + "compliance (legacy)" + ], + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object" + }, + "v1WormDomainExtended": { + "properties": { + "autocommit_offset": { + "description": "Specifies the autocommit time period for the domain in seconds. After a file is in the domain without being modified for the specified time period, the file is automatically committed. If this parameter is set to null, there is no autocommit time, and files must be committed manually.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_retention": { + "description": "Specifies the default amount of time, in seconds, that a file in this domain will be protected for. The default retention period is applied if no retention date is manually set on the file. This parameter can also be set to 'forever', 'use_min' (which applies the 'min_retention' option), or 'use_max' (which applies the 'max_retention' option).", + "enum": [ + "use_min", + "use_max", + "forever" + ], + "type": "string" + }, + "max_retention": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "enum": [ + "forever" + ], + "type": "string" + }, + "min_retention": { + "description": "Specifies the minimum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a shorter retention period. If this parameter is set to null, this minimum value is not enforced. This parameter can also be set to 'forever'.", + "enum": [ + "forever" + ], + "type": "string" + }, + "override_date": { + "description": "Specifies the override retention date for the domain. If this date is later than the retention date for any committed file, the file will remain protected until the override retention date.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "privileged_delete": { + "description": "When this value is set to 'on', files in this domain can be deleted through the privileged delete feature. If this value is set to 'disabled', privileged file deletes are permanently disabled and cannot be turned on again.", + "enum": [ + "on", + "off", + "disabled" + ], + "type": "string" + }, + "type": { + "description": "Specifies whether the domain is an enterprise domain or a compliance domain. Compliance domains can not be created on enterprise clusters. Enterprise and compliance domains can be created on compliance clusters.", + "enum": [ + "enterprise", + "compliance", + "compliance (legacy)" + ], + "type": "string" + } + }, + "type": "object" + }, + "v1WormDomains": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/Createv1WormDomainResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v1WormDomainsExtended": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/Createv1WormDomainResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1WormSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v1WormSettingsSettings" + } + }, + "type": "object" + }, + "v1WormSettingsExtended": { + "description": "Specifies global SmartLock (WORM) settings.", + "properties": { + "cdate": { + "$ref": "#/definitions/Empty" + } + }, + "type": "object" + }, + "v1WormSettingsSettings": { + "description": "Specifies global SmartLock (WORM) settings.", + "properties": { + "cdate": { + "description": "Specifies the current time of the SmartLock compliance clock in Unix Epoch seconds. If the compliance clock is not set, this value is null. A PUT request will set the compliance clock date to the current system time. The cluster must be in compliance mode to set the compliance clock.", + "type": "integer" + } + }, + "type": "object" + }, + "v1Zone": { + "description": "Specifies properties for access zones.", + "properties": { + "all_auth_providers": { + "description": "Enables all available authentication providers.", + "type": "boolean" + }, + "alternate_system_provider": { + "description": "Specifies an alternate system provider.", + "type": "string" + }, + "audit_failure": { + "description": "Specifies a list of failed operations to audit.", + "items": { + "type": "string" + }, + "type": "array" + }, + "audit_success": { + "description": "Specifies a list of successful operations to audit.", + "items": { + "type": "string" + }, + "type": "array" + }, + "auth_providers": { + "description": "Specifies the list of authentication providers available on this access zone.", + "items": { + "type": "string" + }, + "type": "array" + }, + "create_path": { + "description": "Determines if a path is created when a path does not exist.", + "type": "boolean" + }, + "hdfs_ambari_namenode": { + "description": "Specifies the SmartConnect name of the cluster that will be used for the HDFS service.", + "type": "string" + }, + "hdfs_ambari_server": { + "description": "Specifies the valid hostname, FQDN, IPv4, or IPv6 string of the Ambari server.", + "type": "string" + }, + "hdfs_authentication": { + "description": "Specifies the authentication type for HDFS protocol.", + "enum": [ + "all", + "simple_only", + "kerberos_only" + ], + "type": "string" + }, + "hdfs_root_directory": { + "description": "Specifies the root directory for the HDFS protocol.", + "type": "string" + }, + "home_directory_umask": { + "description": "Specifies the permissions set on automatically created user home directories.", + "type": "integer" + }, + "ifs_restricted": { + "description": "Specifies a list of users and groups that have read and write access to /ifs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "map_untrusted": { + "description": "Maps untrusted domains to this NetBIOS domain during authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the access zone name.", + "type": "string" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name.", + "type": "string" + }, + "path": { + "description": "Specifies the access zone base directory path.", + "type": "string" + }, + "protocol_audit_enabled": { + "description": "Determines if I/O auditing is enabled on this access zone.", + "type": "boolean" + }, + "skeleton_directory": { + "description": "Specifies the skeleton directory that is used for user home directories.", + "type": "string" + }, + "syslog_audit_events": { + "description": "Specifies a list of audit operations to forward to the syslog.", + "items": { + "type": "string" + }, + "type": "array" + }, + "syslog_forwarding_enabled": { + "description": "Determines if access zone events are forwarded to the syslog.", + "type": "boolean" + }, + "system_provider": { + "description": "Specifies the system provider for the access zone.", + "type": "string" + }, + "user_mapping_rules": { + "description": "Specifies the current ID mapping rules.", + "items": { + "type": "string" + }, + "type": "array" + }, + "webhdfs_enabled": { + "description": "True if WebHDFS is enabled on this access zone.", + "type": "boolean" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v1ZoneExtended": { + "description": "Specifies properties for access zones.", + "properties": { + "all_auth_providers": { + "description": "Enables all available authentication providers.", + "type": "boolean" + }, + "alternate_system_provider": { + "description": "Specifies an alternate system provider.", + "type": "string" + }, + "audit_failure": { + "description": "Specifies a list of failed operations to audit.", + "items": { + "type": "string" + }, + "type": "array" + }, + "audit_success": { + "description": "Specifies a list of successful operations to audit.", + "items": { + "type": "string" + }, + "type": "array" + }, + "auth_providers": { + "description": "Specifies the list of authentication providers available on this access zone.", + "items": { + "type": "string" + }, + "type": "array" + }, + "create_path": { + "description": "Determines if a path is created when a path does not exist.", + "type": "boolean" + }, + "hdfs_ambari_namenode": { + "description": "Specifies the SmartConnect name of the cluster that will be used for the HDFS service.", + "type": "string" + }, + "hdfs_ambari_server": { + "description": "Specifies the valid hostname, FQDN, IPv4, or IPv6 string of the Ambari server.", + "type": "string" + }, + "hdfs_authentication": { + "description": "Specifies the authentication type for HDFS protocol.", + "enum": [ + "all", + "simple_only", + "kerberos_only" + ], + "type": "string" + }, + "hdfs_keytab": { + "description": "Specifies the Kerberos keytab for HDFS authentication.", + "type": "string" + }, + "hdfs_root_directory": { + "description": "Specifies the root directory for the HDFS protocol.", + "type": "string" + }, + "home_directory_umask": { + "description": "Specifies the permissions set on automatically created user home directories.", + "type": "integer" + }, + "id": { + "description": "Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method", + "type": "string" + }, + "ifs_restricted": { + "description": "Specifies a list of users and groups that have read and write access to /ifs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "map_untrusted": { + "description": "Maps untrusted domains to this NetBIOS domain during authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the access zone name.", + "type": "string" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name.", + "type": "string" + }, + "path": { + "description": "Specifies the access zone base directory path.", + "type": "string" + }, + "protocol_audit_enabled": { + "description": "Determines if I/O auditing is enabled on this access zone.", + "type": "boolean" + }, + "skeleton_directory": { + "description": "Specifies the skeleton directory that is used for user home directories.", + "type": "string" + }, + "syslog_audit_events": { + "description": "Specifies a list of audit operations to forward to the syslog.", + "items": { + "type": "string" + }, + "type": "array" + }, + "syslog_forwarding_enabled": { + "description": "Determines if access zone events are forwarded to the syslog.", + "type": "boolean" + }, + "system": { + "description": "True if the access zone is built-in.", + "type": "boolean" + }, + "system_provider": { + "description": "Specifies the system provider for the access zone.", + "type": "string" + }, + "user_mapping_rules": { + "description": "Specifies the current ID mapping rules.", + "items": { + "type": "string" + }, + "type": "array" + }, + "webhdfs_enabled": { + "description": "True if WebHDFS is enabled on this access zone.", + "type": "boolean" + }, + "zone_id": { + "description": "Specifies the access zone ID on the system.", + "type": "integer" + } + }, + "type": "object" + }, + "v1ZoneExtendedExtended": { + "description": "Specifies properties for access zones.", + "properties": { + "all_auth_providers": { + "description": "Enables all available authentication providers.", + "type": "boolean" + }, + "alternate_system_provider": { + "description": "Specifies an alternate system provider.", + "type": "string" + }, + "audit_failure": { + "description": "Specifies a list of failed operations to audit.", + "items": { + "type": "string" + }, + "type": "array" + }, + "audit_success": { + "description": "Specifies a list of successful operations to audit.", + "items": { + "type": "string" + }, + "type": "array" + }, + "auth_providers": { + "description": "Specifies the list of authentication providers available on this access zone.", + "items": { + "type": "string" + }, + "type": "array" + }, + "create_path": { + "description": "Determines if a path is created when a path does not exist.", + "type": "boolean" + }, + "hdfs_ambari_namenode": { + "description": "Specifies the SmartConnect name of the cluster that will be used for the HDFS service.", + "type": "string" + }, + "hdfs_ambari_server": { + "description": "Specifies the valid hostname, FQDN, IPv4, or IPv6 string of the Ambari server.", + "type": "string" + }, + "hdfs_authentication": { + "description": "Specifies the authentication type for HDFS protocol.", + "enum": [ + "all", + "simple_only", + "kerberos_only" + ], + "type": "string" + }, + "hdfs_root_directory": { + "description": "Specifies the root directory for the HDFS protocol.", + "type": "string" + }, + "home_directory_umask": { + "description": "Specifies the permissions set on automatically created user home directories.", + "type": "integer" + }, + "ifs_restricted": { + "description": "Specifies a list of users and groups that have read and write access to /ifs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "map_untrusted": { + "description": "Maps untrusted domains to this NetBIOS domain during authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the access zone name.", + "type": "string" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name.", + "type": "string" + }, + "path": { + "description": "Specifies the access zone base directory path.", + "type": "string" + }, + "protocol_audit_enabled": { + "description": "Determines if I/O auditing is enabled on this access zone.", + "type": "boolean" + }, + "skeleton_directory": { + "description": "Specifies the skeleton directory that is used for user home directories.", + "type": "string" + }, + "syslog_audit_events": { + "description": "Specifies a list of audit operations to forward to the syslog.", + "items": { + "type": "string" + }, + "type": "array" + }, + "syslog_forwarding_enabled": { + "description": "Determines if access zone events are forwarded to the syslog.", + "type": "boolean" + }, + "system_provider": { + "description": "Specifies the system provider for the access zone.", + "type": "string" + }, + "user_mapping_rules": { + "description": "Specifies the current ID mapping rules.", + "items": { + "type": "string" + }, + "type": "array" + }, + "webhdfs_enabled": { + "description": "True if WebHDFS is enabled on this access zone.", + "type": "boolean" + } + }, + "type": "object" + }, + "v1Zones": { + "additionalProperties": false, + "properties": { + "zones": { + "items": { + "$ref": "#/definitions/v1ZoneExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v1ZonesSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v1ZonesSummarySummary" + } + }, + "type": "object" + }, + "v1ZonesSummaryExtended": { + "properties": { + "summary": { + "$ref": "#/definitions/v1ZonesSummarySummaryExtended" + } + }, + "type": "object" + }, + "v1ZonesSummarySummary": { + "description": "The summary of a collection of objects.", + "properties": { + "count": { + "description": "The count of objects in the collection", + "type": "integer" + }, + "list": { + "description": "List of zone names", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "count" + ], + "type": "object" + }, + "v1ZonesSummarySummaryExtended": { + "description": "The summary of a collection of objects.", + "properties": { + "path": { + "description": "The zone base path", + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object" + }, + "v2NfsAlias": { + "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", + "properties": { + "health": { + "description": "Specifies whether the alias is usable.", + "enum": [ + "good", + "illegal file type", + "illegal path", + "name conflict", + "not exported", + "path not found", + "unknown" + ], + "type": "string" + }, + "name": { + "description": "Specifies the name by which the alias can be referenced.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "path": { + "description": "Specifies the path to which the alias points.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the alias is valid.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_NFS_ALIASES" + }, + "v2NfsAliasExtended": { + "description": "Specifies properties for NFS aliases, which are names for physical paths in the file system.", + "properties": { + "health": { + "description": "Specifies whether the alias is usable.", + "enum": [ + "good", + "illegal file type", + "illegal path", + "name conflict", + "not exported", + "path not found", + "unknown" + ], + "type": "string" + }, + "name": { + "description": "Specifies the name by which the alias can be referenced.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "path": { + "description": "Specifies the path to which the alias points.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the alias is valid.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v2NfsAliases": { + "additionalProperties": false, + "properties": { + "aliases": { + "items": { + "$ref": "#/definitions/v15NfsAliasExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v2NfsExport": { + "description": "Specifies configuration values for NFS exports.", + "properties": { + "all_dirs": { + "description": "True if all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "Specifies the block size returned by the NFS statfs procedure.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "can_set_time": { + "description": "True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_insensitive": { + "description": "True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_preserving": { + "description": "True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "chown_restricted": { + "description": "True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "clients": { + "description": "Specifies the clients with root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "commit_asynchronous": { + "description": "True if NFS commit requests execute asynchronously.", + "type": "boolean" + }, + "description": { + "description": "Specifies the user-defined string that is used to identify the export.", + "type": "string" + }, + "directory_transfer_size": { + "description": "Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encoding": { + "description": "Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified.", + "type": "string" + }, + "link_max": { + "description": "Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "map_all": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_failure": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_full": { + "description": "True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_non_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_retry": { + "description": "Determines whether searches for users specified in 'map_all', 'map_root' or 'map_nonroot' are retried if the search fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "max_file_size": { + "description": "Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "integer" + }, + "name_max_size": { + "description": "Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "no_truncate": { + "description": "True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "paths": { + "description": "Specifies the paths under /ifs that are exported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_only": { + "description": "True if the export is set to read-only.", + "type": "boolean" + }, + "read_only_clients": { + "description": "Specifies the clients with read-only access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_size": { + "description": "Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_write_clients": { + "description": "Specifies the clients with both read and write access to the export, even when the export is set to read-only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readdirplus": { + "description": "True if 'readdirplus' requests are enabled. Enabling this property might improve network performance and is only available for NFSv3.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that are prefetched when a 'readdirplus' request is processed. (Deprecated.)", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "root_clients": { + "description": "Clients that have root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "security_flavors": { + "description": "Specifies the authentication types that are supported for this export.", + "items": { + "description": "Specifies the authentication types that are supported for this export.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "True if set attribute operations execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Specifies the snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "type": "boolean" + }, + "time_delta": { + "description": "Specifies the resolution of all time values that are returned to the clients", + "type": "number" + }, + "write_datasync_action": { + "description": "Specifies the action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "Specifies the action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_size": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_unstable_action": { + "description": "Specifies the action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the export is valid.", + "type": "string" + } + }, + "required": [ + "paths" + ], + "type": "object", + "x-privilege": "ISI_PRIV_NFS_EXPORTS" + }, + "v2NfsExportExtended": { + "description": "Specifies configuration values for NFS exports.", + "properties": { + "all_dirs": { + "description": "True if all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "Specifies the block size returned by the NFS statfs procedure.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "can_set_time": { + "description": "True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_insensitive": { + "description": "True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_preserving": { + "description": "True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "chown_restricted": { + "description": "True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "clients": { + "description": "Specifies the clients with root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "commit_asynchronous": { + "description": "True if NFS commit requests execute asynchronously.", + "type": "boolean" + }, + "conflicting_paths": { + "description": "Reports the paths that conflict with another export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Specifies the user-defined string that is used to identify the export.", + "type": "string" + }, + "directory_transfer_size": { + "description": "Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encoding": { + "description": "Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified.", + "type": "string" + }, + "id": { + "description": "Specifies the system-assigned ID for the export. This ID is returned when an export is created through the POST method.", + "type": "integer" + }, + "link_max": { + "description": "Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "map_all": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_failure": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_full": { + "description": "True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_non_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_retry": { + "description": "Determines whether searches for users specified in 'map_all', 'map_root' or 'map_nonroot' are retried if the search fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "max_file_size": { + "description": "Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "integer" + }, + "name_max_size": { + "description": "Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "no_truncate": { + "description": "True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "paths": { + "description": "Specifies the paths under /ifs that are exported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_only": { + "description": "True if the export is set to read-only.", + "type": "boolean" + }, + "read_only_clients": { + "description": "Specifies the clients with read-only access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_size": { + "description": "Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_write_clients": { + "description": "Specifies the clients with both read and write access to the export, even when the export is set to read-only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readdirplus": { + "description": "True if 'readdirplus' requests are enabled. Enabling this property might improve network performance and is only available for NFSv3.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that are prefetched when a 'readdirplus' request is processed. (Deprecated.)", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "root_clients": { + "description": "Clients that have root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "security_flavors": { + "description": "Specifies the authentication types that are supported for this export.", + "items": { + "description": "Specifies the authentication types that are supported for this export.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "True if set attribute operations execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Specifies the snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "type": "boolean" + }, + "time_delta": { + "description": "Specifies the resolution of all time values that are returned to the clients", + "type": "number" + }, + "unresolved_clients": { + "description": "Reports clients that cannot be resolved.", + "items": { + "type": "string" + }, + "type": "array" + }, + "write_datasync_action": { + "description": "Specifies the action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "Specifies the action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_size": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_unstable_action": { + "description": "Specifies the action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the export is valid.", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + }, + "v2NfsExportExtendedExtended": { + "description": "Specifies configuration values for NFS exports.", + "properties": { + "all_dirs": { + "description": "True if all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "Specifies the block size returned by the NFS statfs procedure.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "can_set_time": { + "description": "True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_insensitive": { + "description": "True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_preserving": { + "description": "True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "chown_restricted": { + "description": "True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "clients": { + "description": "Specifies the clients with root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "commit_asynchronous": { + "description": "True if NFS commit requests execute asynchronously.", + "type": "boolean" + }, + "description": { + "description": "Specifies the user-defined string that is used to identify the export.", + "type": "string" + }, + "directory_transfer_size": { + "description": "Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encoding": { + "description": "Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified.", + "type": "string" + }, + "link_max": { + "description": "Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "map_all": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_failure": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_full": { + "description": "True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_non_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_retry": { + "description": "Determines whether searches for users specified in 'map_all', 'map_root' or 'map_nonroot' are retried if the search fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "max_file_size": { + "description": "Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "integer" + }, + "name_max_size": { + "description": "Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "no_truncate": { + "description": "True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "paths": { + "description": "Specifies the paths under /ifs that are exported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_only": { + "description": "True if the export is set to read-only.", + "type": "boolean" + }, + "read_only_clients": { + "description": "Specifies the clients with read-only access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "read_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_size": { + "description": "Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_write_clients": { + "description": "Specifies the clients with both read and write access to the export, even when the export is set to read-only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readdirplus": { + "description": "True if 'readdirplus' requests are enabled. Enabling this property might improve network performance and is only available for NFSv3.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that are prefetched when a 'readdirplus' request is processed. (Deprecated.)", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "root_clients": { + "description": "Clients that have root access to the export.", + "items": { + "type": "string" + }, + "type": "array" + }, + "security_flavors": { + "description": "Specifies the authentication types that are supported for this export.", + "items": { + "description": "Specifies the authentication types that are supported for this export.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "True if set attribute operations execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Specifies the snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "type": "boolean" + }, + "time_delta": { + "description": "Specifies the resolution of all time values that are returned to the clients", + "type": "number" + }, + "write_datasync_action": { + "description": "Specifies the action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "Specifies the action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_size": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_unstable_action": { + "description": "Specifies the action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the export is valid.", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + }, + "v2NfsExportMapAll": { + "description": "Specifies the users and groups to which non-root and root clients are mapped.", + "properties": { + "enabled": { + "description": "True if the user mapping is applied.", + "type": "boolean" + }, + "primary_group": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "secondary_groups": { + "description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID.", + "items": { + "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", + "properties": { + "id": { + "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", + "maxLength": 261, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the persona name, which must be combined with a type.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-nullable": true + }, + "type": { + "description": "Specifies the type of persona, which must be combined with a name.", + "enum": [ + "user", + "group", + "wellknown" + ], + "type": "string", + "x-nullable": true + } + }, + "type": "object" + }, + "type": "array" + }, + "user": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + "type": "object" + }, + "v2NfsExports": { + "additionalProperties": false, + "properties": { + "digest": { + "description": "An identifier for a set of exports.", + "type": "string" + }, + "exports": { + "items": { + "$ref": "#/definitions/v2NfsExportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_NFS_EXPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v2NfsExportsExtended": { + "additionalProperties": false, + "properties": { + "exports": { + "items": { + "$ref": "#/definitions/v2NfsExportExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v2NfsNlmLocks": { + "additionalProperties": false, + "properties": { + "locks": { + "items": { + "$ref": "#/definitions/v2NfsNlmLocksLock" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v2NfsNlmLocksLock": { + "description": "Information for an NLM lock on NFS.", + "properties": { + "client": { + "description": "Specifies the client host name and IP address.", + "type": "string" + }, + "client_id": { + "description": "Specifies the client ID.", + "type": "string" + }, + "created": { + "description": "Specifies the UNIX EPoch time that the lock was created.", + "type": "integer" + }, + "id": { + "description": "Specifies the system-assigned ID given to the lock. This value is returned when the lock is created with the POST method.", + "type": "string" + }, + "lin": { + "description": "Specifies the LIN in /ifs that is locked.", + "type": "string" + }, + "lock_type": { + "description": "Specifies the lock type.", + "type": "string" + }, + "path": { + "description": "Specifies the path under /ifs that is locked.", + "type": "string" + }, + "range": { + "description": "Specifies the byte range within the locked file.", + "items": { + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "v2NfsNlmSessions": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "sessions": { + "items": { + "$ref": "#/definitions/v2NfsNlmSessionsSession" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v2NfsNlmSessionsSession": { + "properties": { + "client": { + "description": "Specifies the client host name and IP address.", + "type": "string" + }, + "id": { + "description": "Specifies the system-assigned ID for the session.", + "type": "string" + } + }, + "type": "object" + }, + "v2NfsNlmWaiters": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "waiters": { + "items": { + "$ref": "#/definitions/v2NfsNlmLocksLock" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v2NfsSettingsExport": { + "description": "Default NFS export configuration values.", + "properties": { + "settings": { + "$ref": "#/definitions/v2NfsSettingsExportSettings" + } + }, + "type": "object" + }, + "v2NfsSettingsExportSettings": { + "description": "Specifies configuration values for NFS exports.", + "properties": { + "all_dirs": { + "description": "True if all directories under the specified paths are mountable.", + "type": "boolean" + }, + "block_size": { + "description": "Specifies the block size returned by the NFS statfs procedure.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "can_set_time": { + "description": "True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_insensitive": { + "description": "True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "case_preserving": { + "description": "True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "chown_restricted": { + "description": "True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "commit_asynchronous": { + "description": "True if NFS commit requests execute asynchronously.", + "type": "boolean" + }, + "directory_transfer_size": { + "description": "Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encoding": { + "description": "Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified.", + "type": "string" + }, + "link_max": { + "description": "Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "map_all": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_failure": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_full": { + "description": "True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication.", + "type": "boolean" + }, + "map_lookup_uid": { + "description": "True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations.", + "type": "boolean" + }, + "map_non_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "map_retry": { + "description": "Determines whether searches for users specified in 'map_all', 'map_root' or 'map_nonroot' are retried if the search fails.", + "type": "boolean" + }, + "map_root": { + "$ref": "#/definitions/v2NfsExportMapAll" + }, + "max_file_size": { + "description": "Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "integer" + }, + "name_max_size": { + "description": "Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "no_truncate": { + "description": "True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements.", + "type": "boolean" + }, + "read_only": { + "description": "True if the export is set to read-only.", + "type": "boolean" + }, + "read_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "read_transfer_size": { + "description": "Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "readdirplus": { + "description": "True if 'readdirplus' requests are enabled. Enabling this property might improve network performance and is only available for NFSv3.", + "type": "boolean" + }, + "readdirplus_prefetch": { + "description": "Sets the number of directory entries that are prefetched when a 'readdirplus' request is processed. (Deprecated.)", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "return_32bit_file_ids": { + "description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values (may require remount).", + "type": "boolean" + }, + "security_flavors": { + "description": "Specifies the authentication types that are supported for this export.", + "items": { + "description": "Specifies the authentication types that are supported for this export.", + "enum": [ + "unix", + "krb5", + "krb5i", + "krb5p" + ], + "type": "string" + }, + "type": "array" + }, + "setattr_asynchronous": { + "description": "True if set attribute operations execute asynchronously.", + "type": "boolean" + }, + "snapshot": { + "description": "Specifies the snapshot for all mounts.", + "type": "string" + }, + "symlinks": { + "description": "True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "type": "boolean" + }, + "time_delta": { + "description": "Specifies the resolution of all time values that are returned to the clients", + "type": "number" + }, + "write_datasync_action": { + "description": "Specifies the action to be taken when an NFSv3+ datasync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_datasync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ datasync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_action": { + "description": "Specifies the action to be taken when an NFSv3+ filesync write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_filesync_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ filesync write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_transfer_max_size": { + "description": "Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_multiple": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_transfer_size": { + "description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "write_unstable_action": { + "description": "Specifies the action to be taken when an NFSv3+ unstable write is requested.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "write_unstable_reply": { + "description": "Specifies the stability disposition returned when an NFSv3+ unstable write is processed.", + "enum": [ + "DATASYNC", + "FILESYNC", + "UNSTABLE" + ], + "type": "string" + }, + "zone": { + "description": "Specifies the zone in which the export is valid.", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_EXPORT" + }, + "v2NfsSettingsZone": { + "properties": { + "settings": { + "$ref": "#/definitions/v2NfsSettingsZoneSettings" + } + }, + "type": "object" + }, + "v2NfsSettingsZoneSettings": { + "description": "Specifies the per-zone NFS configuration settings.", + "properties": { + "nfsv4_allow_numeric_ids": { + "description": "If true, sends owners and groups as UIDs and GIDs when look up fails or if the 'nfsv4_no_name' property is set to 1.", + "type": "boolean" + }, + "nfsv4_domain": { + "description": "Specifies the domain or realm through which users and groups are associated.", + "type": "string" + }, + "nfsv4_no_domain": { + "description": "If true, sends owners and groups without a domain name.", + "type": "boolean" + }, + "nfsv4_no_domain_uids": { + "description": "If true, sends UIDs and GIDs without a domain name.", + "type": "boolean" + }, + "nfsv4_no_names": { + "description": "If true, sends owners and groups as UIDs and GIDs.", + "type": "boolean" + }, + "nfsv4_replace_domain": { + "description": "If true, replaces the owner or group domain with an NFS domain name.", + "type": "boolean" + }, + "zone": { + "description": "Specifies the access zones in which these settings apply.", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_ZONE" + }, + "v3AdsProviderDomains": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/v3AdsProviderDomainsDomain" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3AdsProviderDomainsDomain": { + "description": "Specifies properties for trusted domains of configured ADS providers.", + "properties": { + "client_site": { + "description": "The Nodes Site.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "dc_address": { + "description": "Specifies the address for the domain controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "dc_name": { + "description": "Specifies the name for the domain controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "dc_site": { + "description": "Specifies the site for the domain controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain": { + "description": "Specifies the name of the domain.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "guid": { + "description": "Specifies the globally unique ID for the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies a unique identifier for every domain returned.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name for the domain.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "sid": { + "description": "Specifies the security ID for the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Specifies the status of the domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "trust_type": { + "description": "Specifies the type of trust for this domain. Options include 'primary', 'unknown', 'external', and 'forest'.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3AntivirusPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v3AntivirusPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3AntivirusPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v3AntivirusPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3AntivirusPolicy": { + "additionalProperties": false, + "description": "An antivirus scan policy.", + "properties": { + "description": { + "description": "A description for the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the policy is enabled.", + "type": "boolean" + }, + "force_run": { + "description": "Forces the scan to run regardless of whether the files were recently scanned.", + "type": "boolean" + }, + "impact": { + "description": "The priority of the antivirus scan job. Must be a valid job engine impact policy, or null to use the default impact.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "paths": { + "description": "Paths to include in the scan.", + "items": { + "maxLength": 4096, + "minLength": 0, + "pattern": "^/ifs.*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "recursion_depth": { + "description": "The depth to recurse in directories. The default of -1 gives unlimited recursion.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "schedule": { + "description": "The schedule for running scans in isi date format. Examples include: 'every Friday' or 'every day at 4:00'. A null value means the policy is manually scheduled.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v3AntivirusPolicyExtended": { + "additionalProperties": false, + "description": "An antivirus scan policy.", + "properties": { + "description": { + "description": "A description for the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the policy is enabled.", + "type": "boolean" + }, + "force_run": { + "description": "Forces the scan to run regardless of whether the files were recently scanned.", + "type": "boolean" + }, + "id": { + "description": "A unique identifier for the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "impact": { + "description": "The priority of the antivirus scan job. Must be a valid job engine impact policy, or null to use the default impact.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_run": { + "description": "The epoch time of the last run of this policy.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "paths": { + "description": "Paths to include in the scan.", + "items": { + "maxLength": 4096, + "minLength": 0, + "pattern": "^/ifs.*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "recursion_depth": { + "description": "The depth to recurse in directories. The default of -1 gives unlimited recursion.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "schedule": { + "description": "The schedule for running scans in isi date format. Examples include: 'every Friday' or 'every day at 4:00'. A null value means the policy is manually scheduled.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3AntivirusPolicyExtendedExtended": { + "additionalProperties": false, + "description": "An antivirus scan policy.", + "properties": { + "description": { + "description": "A description for the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the policy is enabled.", + "type": "boolean" + }, + "force_run": { + "description": "Forces the scan to run regardless of whether the files were recently scanned.", + "type": "boolean" + }, + "impact": { + "description": "The priority of the antivirus scan job. Must be a valid job engine impact policy, or null to use the default impact.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "paths": { + "description": "Paths to include in the scan.", + "items": { + "maxLength": 4096, + "minLength": 0, + "pattern": "^/ifs.*", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "recursion_depth": { + "description": "The depth to recurse in directories. The default of -1 gives unlimited recursion.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "schedule": { + "description": "The schedule for running scans in isi date format. Examples include: 'every Friday' or 'every day at 4:00'. A null value means the policy is manually scheduled.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3AntivirusQuarantine": { + "additionalProperties": false, + "description": "The quarantine status of a file in /ifs.", + "properties": { + "file": { + "description": "Path of this file, starting with /ifs.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_istag": { + "description": "The ICAP Service Tag (ISTag) recorded for this file during the last scan, or null if no tag was recorded. For more information about ISTags, see https://tools.ietf.org/html/rfc3507.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_scan": { + "description": "The date and time this file was last scanned for viruses, as a UNIX timestamp. If null, the file has never been scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "quarantined": { + "description": "If true, this file is quarantined. If false, the file is not quarantined.", + "type": "boolean" + }, + "scan_result": { + "description": "The result of the last scan on this file. This string is usually one of: never_scanned, clean, quarantined, repaired, truncated, infected_no_action_taken, skipped_per_settings. However, a longer string starting with 'unknown_status' and describing the details can also appear in uncommon edge cases.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "scan_status": { + "description": "The scanning status of this file. If 'current', the file was scanned with the most up-to-date virus definitions. If 'not_current', it has either not been scanned, been modified since the last scan, or the virus definitions are not current.", + "enum": [ + "current", + "not_current" + ], + "type": "string" + } + }, + "required": [ + "scan_result", + "last_scan", + "quarantined", + "last_istag", + "file", + "scan_status" + ], + "type": "object" + }, + "v3AntivirusQuarantinePathParams": { + "additionalProperties": false, + "description": "The quarantine status of a file in /ifs.", + "properties": { + "quarantined": { + "description": "If true, this file is quarantined. If false, the file is not quarantined.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3AntivirusScanItem": { + "additionalProperties": false, + "description": "Parameters for a manual antivirus scan.", + "properties": { + "file": { + "description": "The full path of the file to scan.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "force_run": { + "description": "Forces the scan to run regardless of whether the files were recently scanned. The default value is true.", + "type": "boolean" + }, + "policy": { + "description": "The ID of the policy to use for the scan. By default, the scan will use the MANUAL policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "report_id": { + "description": "The ID for the report for this scan. A report ID will be generated if one is not provided.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + }, + "v3AntivirusServer": { + "additionalProperties": false, + "description": "An ICAP server that contains virus definitions.", + "properties": { + "description": { + "description": "A description for the server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the server is enabled.", + "type": "boolean" + }, + "url": { + "description": "The icap url for the server. This should have a format of: icap://host.domain:port/path", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "url" + ], + "type": "object" + }, + "v3AntivirusServerExtended": { + "additionalProperties": false, + "description": "An ICAP server that contains virus definitions.", + "properties": { + "definitions": { + "description": "Virus definitions on the server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "A description for the server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the server is enabled.", + "type": "boolean" + }, + "id": { + "description": "A unique identifier for the server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "The status of the server.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "url": { + "description": "The icap url for the server. This should have a format of: icap://host.domain:port/path", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v3AntivirusServerExtendedExtended": { + "additionalProperties": false, + "description": "An ICAP server that contains virus definitions.", + "properties": { + "description": { + "description": "A description for the server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "Whether the server is enabled.", + "type": "boolean" + }, + "url": { + "description": "The icap url for the server. This should have a format of: icap://host.domain:port/path", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v3AntivirusServers": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "servers": { + "items": { + "$ref": "#/definitions/v3AntivirusServerExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3AntivirusServersExtended": { + "additionalProperties": false, + "properties": { + "servers": { + "items": { + "$ref": "#/definitions/v3AntivirusServerExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3AntivirusSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v3AntivirusSettingsSettings" + } + }, + "type": "object" + }, + "v3AntivirusSettingsSettings": { + "additionalProperties": false, + "description": "Antivirus settings.", + "properties": { + "fail_open": { + "description": "Allow access when scanning fails.", + "type": "boolean" + }, + "glob_filters": { + "description": "Glob patterns for leaf filenames.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "glob_filters_enabled": { + "description": "Enable glob filters.", + "type": "boolean" + }, + "glob_filters_include": { + "description": "If true, only scan files matching a glob filter. If false, only scan files that don't match a glob filter.", + "type": "boolean" + }, + "path_prefixes": { + "description": "Paths to include in realtime scans.", + "items": { + "maxLength": 4096, + "minLength": 0, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "quarantine": { + "description": "Try to quarantine files when threats are found.", + "type": "boolean" + }, + "repair": { + "description": "Try to repair files when threats are found.", + "type": "boolean" + }, + "report_expiry": { + "description": "Amount of time in seconds until old reporting data is purged.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "scan_on_close": { + "description": "Scan files when apps close them.", + "type": "boolean" + }, + "scan_on_open": { + "description": "Scan files on access.", + "type": "boolean" + }, + "scan_size_maximum": { + "description": "Skip scanning files larger than this.", + "maximum": 2147483648, + "minimum": 0, + "type": "integer" + }, + "service": { + "description": "Whether the antivirus service is enabled.", + "type": "boolean" + }, + "truncate": { + "description": "Try to truncate files when threats are found.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3AuditSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3AuditSettingsSettings" + } + }, + "type": "object" + }, + "v3AuditSettingsSettings": { + "description": "Per-Access Zone Audit settings", + "properties": { + "audit_failure": { + "description": "Filter of protocol operations to Audit when they fail.", + "items": { + "enum": [ + "close", + "create", + "delete", + "get_security", + "logoff", + "logon", + "read", + "rename", + "set_security", + "tree_connect", + "write" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "audit_success": { + "description": "Filter of protocol operations to Audit when they succeed.", + "items": { + "enum": [ + "close", + "create", + "delete", + "get_security", + "logoff", + "logon", + "read", + "rename", + "set_security", + "tree_connect", + "write" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "syslog_audit_events": { + "description": "Filter of Audit operations to forward to syslog.", + "items": { + "enum": [ + "close", + "create", + "delete", + "get_security", + "logoff", + "logon", + "read", + "rename", + "set_security", + "tree_connect", + "write" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "syslog_forwarding_enabled": { + "description": "Enables forwarding of events to syslog.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3AuthLogLevel": { + "properties": { + "level": { + "$ref": "#/definitions/v3AuthLogLevelLevel" + } + }, + "type": "object" + }, + "v3AuthLogLevelExtended": { + "properties": { + "level": { + "description": "Valid auth logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3AuthLogLevelLevel": { + "properties": { + "lsass-level": { + "description": "Valid auth logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "type": "string" + }, + "netlogon-level": { + "description": "Valid auth logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3CloudAccess": { + "additionalProperties": false, + "properties": { + "clusters": { + "items": { + "$ref": "#/definitions/v3CloudAccessCluster" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3CloudAccessCluster": { + "description": "Accessible cloud storage information", + "properties": { + "accounts": { + "description": "A list of accounts created on the cluster with this guid", + "items": { + "type": "string" + }, + "type": "array" + }, + "current": { + "description": "Whether the guid is that of the current (local) cluster", + "type": "boolean" + }, + "guid": { + "description": "A cluster guid indicating the birth place of one or more accounts or policies on this cluster", + "type": "string" + }, + "id": { + "description": "A cluster guid indicating the birth place of one or more accounts or policies on this cluster", + "type": "string" + }, + "name": { + "description": "The name of the cluster from which the above guid originated", + "type": "string" + }, + "policies": { + "description": "A list of policies created on the cluster with this guid", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Whether the guid has access to the cloud", + "enum": [ + "permitted", + "pending enable", + "pending disable", + "not permitted" + ], + "type": "string" + }, + "synced_from": { + "description": "The name of the cluster from which the above guid was synced", + "type": "string" + } + }, + "type": "object" + }, + "v3CloudAccessExtended": { + "additionalProperties": false, + "properties": { + "clusters": { + "items": { + "$ref": "#/definitions/v3CloudAccessCluster" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3CloudAccessItem": { + "description": "Accessible cloud storage information", + "properties": { + "guid": { + "description": "A cluster guid indicating the birth place of one or more accounts or policies on this cluster", + "type": "string" + } + }, + "required": [ + "guid" + ], + "type": "object" + }, + "v3CloudJob": { + "description": "A cloud job for archiving or recalling files or restoring COI", + "properties": { + "accounts": { + "description": "The names of accounts for COI restore", + "items": { + "type": "string" + }, + "type": "array" + }, + "directories": { + "description": "Directories addressed by this job", + "items": { + "type": "string" + }, + "type": "array" + }, + "expiration_date": { + "description": "The new expiration date in seconds", + "type": "integer" + }, + "file_matching_pattern": { + "$ref": "#/definitions/Empty" + }, + "files": { + "description": "Filenames addressed by this job", + "items": { + "type": "string" + }, + "type": "array" + }, + "policy": { + "description": "The name of an existing cloudpool policy to apply to this job. (Only applicable for 'archive' jobs)", + "type": "string" + }, + "type": { + "description": "The type of cloud action to be performed by this job.", + "enum": [ + "archive", + "recall", + "local-garbage-collection", + "cloud-garbage-collection", + "cache-writeback", + "cache-on-access", + "cache-invalidation", + "restore-coi", + "upgrade-monitor", + "cache-pre-populate", + "snapshot-writeback", + "smartlink-upgrade" + ], + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v3CloudJobExtended": { + "description": "A cloud job for archiving or recalling files", + "properties": { + "completion_time": { + "description": "The time at which the job was completed (if applicable)", + "type": "integer" + }, + "create_time": { + "description": "The time at which the job was created", + "type": "integer" + }, + "description": { + "description": "A brief description of the job contents", + "type": "string" + }, + "effective_state": { + "description": "The effective state of the job (e.g,. the combination of operation_state and job_state)", + "enum": [ + "running", + "paused", + "canceled", + "completed", + "failed" + ], + "type": "string" + }, + "files": { + "$ref": "#/definitions/v3CloudJobFiles" + }, + "id": { + "description": "The job's ID", + "type": "integer" + }, + "job_engine_job": { + "$ref": "#/definitions/v3CloudJobJobEngineJob" + }, + "job_state": { + "description": "The current state of the job", + "enum": [ + "running", + "paused", + "canceled", + "completed", + "failed" + ], + "type": "string" + }, + "operation_state": { + "description": "The current state of the operation associated with the job", + "enum": [ + "running", + "paused" + ], + "type": "string" + }, + "state_change_time": { + "description": "The last time at which the job state changed", + "type": "integer" + }, + "type": { + "description": "The type of cloud action to be performed by this job.", + "enum": [ + "archive", + "recall", + "local-garbage-collection", + "cloud-garbage-collection", + "cache-writeback", + "cache-on-access", + "cache-invalidation", + "restore-coi", + "upgrade-monitor", + "cache-pre-populate", + "snapshot-writeback", + "smartlink-upgrade" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3CloudJobExtendedExtended": { + "description": "A cloud job for archiving or recalling files", + "properties": { + "all": { + "description": "Whether to apply to the given operation type or to all jobs of the given operation type", + "type": "boolean" + }, + "state": { + "description": "The desired state of the job or operation", + "enum": [ + "resume", + "pause", + "cancel" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3CloudJobFiles": { + "description": "The files and filters addressed by this job", + "properties": { + "file_matching_pattern": { + "$ref": "#/definitions/Empty" + }, + "names": { + "description": "A list of files to be addressed by this job. (Note* these are only reported when audit_level is 'high'", + "items": { + "$ref": "#/definitions/v3CloudJobFilesName" + }, + "type": "array" + }, + "total": { + "description": "The total number of files addressed by this job", + "type": "integer" + }, + "total_canceled": { + "description": "The number of canceled files", + "type": "integer" + }, + "total_failed": { + "description": "The number of files which failed", + "type": "integer" + }, + "total_pending": { + "description": "The number of files pending action", + "type": "integer" + }, + "total_processing": { + "description": "The number of files currently being processed", + "type": "integer" + }, + "total_succeeded": { + "description": "The total number of files successfully completed", + "type": "integer" + } + }, + "type": "object" + }, + "v3CloudJobFilesName": { + "properties": { + "name": { + "description": "The full path name of a file to be acted on by this job", + "type": "string" + }, + "state": { + "description": "The current state of this file", + "type": "string" + } + }, + "type": "object" + }, + "v3CloudJobJobEngineJob": { + "description": "Information about the related job engine job if there is one", + "properties": { + "id": { + "description": "ID of the related job engine job", + "type": "integer" + }, + "state": { + "description": "The state of the related job engine job", + "enum": [ + "null", + "running", + "user-paused", + "system-paused", + "policy-paused", + "waiting", + "user-canceled", + "system-canceled", + "failed", + "succeeded" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3CloudJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v3CloudJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3CloudJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v3CloudJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3CloudJobsFiles": { + "additionalProperties": false, + "properties": { + "files": { + "items": { + "$ref": "#/definitions/v3CloudJobsFilesFile" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3CloudJobsFilesFile": { + "description": "File associated with a cloud job.", + "properties": { + "id": { + "description": "ID number of the file within the job", + "minimum": 1, + "type": "integer" + }, + "name": { + "description": "File path", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "state": { + "description": "State of file.", + "enum": [ + "waiting", + "running", + "paused", + "canceled", + "completed", + "error", + "none", + "pending" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3CloudSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3CloudSettingsSettings" + } + }, + "type": "object" + }, + "v3CloudSettingsSettings": { + "properties": { + "cloud_policy_defaults": { + "$ref": "#/definitions/v3CloudSettingsSettingsCloudPolicyDefaults" + }, + "retry_coefficient_archive": { + "description": "Coefficients in the quadratic function for determining the rest period between successive archive attempts.", + "type": "string" + }, + "retry_coefficient_cache_invalidation": { + "description": "Coefficients in the quadratic function for determining the rest period between successive cache invalidation attempts.", + "type": "string" + }, + "retry_coefficient_cache_pre_populate": { + "description": "Coefficients in the quadratic function for determining the rest period between successive cache pre-populate attempts.", + "type": "string" + }, + "retry_coefficient_cloud_garbage_collection": { + "description": "Coefficients in the quadratic function for determining the rest period between successive cloud garbage collection attempts.", + "type": "string" + }, + "retry_coefficient_local_garbage_collection": { + "description": "Coefficients in the quadratic function for determining the rest period between successive local garbage collection attempts.", + "type": "string" + }, + "retry_coefficient_read_ahead": { + "description": "Coefficients in the quadratic function for determining the rest period between successive read ahead attempts.", + "type": "string" + }, + "retry_coefficient_recall": { + "description": "Coefficients in the quadratic function for determining the rest period between successive recall attempts.", + "type": "string" + }, + "retry_coefficient_smartlink_upgrade": { + "description": "Coefficients in the quadratic function for determining the rest period between successive SmartLink upgrade attempts.", + "type": "string" + }, + "retry_coefficient_upgrade": { + "description": "Coefficients in the quadratic function for determining the rest period between successive upgrade attempts.", + "type": "string" + }, + "retry_coefficient_writeback": { + "description": "Coefficients in the quadratic function for determining the rest period between successive writeback attempts.", + "type": "string" + }, + "sleep_timeout_archive": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_cache_invalidation": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_cache_pre_populate": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_cloud_garbage_collection": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_local_garbage_collection": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_read_ahead": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_recall": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_smartlink_upgrade": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_upgrade": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + }, + "sleep_timeout_writeback": { + "$ref": "#/definitions/v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_SETTINGS" + }, + "v3CloudSettingsSettingsCloudPolicyDefaults": { + "description": "The default filepool policy values for cloudpools.", + "properties": { + "archive_snapshot_files": { + "description": "Specifies if files with snapshots should be archived.", + "type": "boolean" + }, + "cache": { + "$ref": "#/definitions/v3CloudSettingsSettingsCloudPolicyDefaultsCache" + }, + "compression": { + "description": "Specifies if files should be compressed.", + "type": "boolean" + }, + "data_retention": { + "description": "Specifies the minimum amount of time archived data will be retained in the cloud after deletion.", + "type": "integer" + }, + "encryption": { + "description": "Specifies if files should be encrypted.", + "type": "boolean" + }, + "full_backup_retention": { + "description": "(Used with NDMP backups only. Not applicable to SyncIQ.) The minimum amount of time cloud files will be retained after the creation of a full NDMP backup.", + "type": "integer" + }, + "incremental_backup_retention": { + "description": "(Used with SyncIQ and NDMP backups.) The minimum amount of time cloud files will be retained after the creation of a SyncIQ backup or an incremental NDMP backup.", + "type": "integer" + }, + "writeback_frequency": { + "description": "The minimum amount of time to wait before updating cloud data with local changes.", + "type": "integer" + } + }, + "type": "object" + }, + "v3CloudSettingsSettingsCloudPolicyDefaultsCache": { + "description": "Specifies default cloudpool cache settings for new filepool policies.", + "properties": { + "expiration": { + "description": "Specifies cache expiration.", + "type": "integer" + }, + "read_ahead": { + "description": "Specifies cache read ahead type.", + "enum": [ + "partial", + "full" + ], + "type": "string" + }, + "type": { + "description": "Specifies cache type.", + "enum": [ + "cached", + "no-cache" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3CloudSettingsSettingsSleepTimeoutCloudGarbageCollection": { + "description": "Amount of time to wait between successive file cloud garbage collection operations.", + "properties": { + "recovery_with_tasks": { + "description": "Sleep timeout for a recovery thread with pending tasks", + "type": "number" + }, + "recovery_without_tasks": { + "description": "Sleep timeout for a recovery thread without pending tasks", + "type": "number" + }, + "with_tasks": { + "description": "Sleep timeout for a non-recovery thread with pending tasks", + "type": "number" + }, + "without_tasks": { + "description": "Sleep timeout for a non-recovery thread without pending tasks", + "type": "number" + } + }, + "type": "object" + }, + "v3ClusterAddNodeItem": { + "description": "Add Node information.", + "properties": { + "allow_down": { + "description": "Allow down nodes (Default false).", + "type": "boolean" + }, + "serial_number": { + "description": "Serial number of this node.", + "type": "string" + }, + "skip_hardware_version_check": { + "description": "Bypass hardware version checks (Default false).", + "type": "boolean" + } + }, + "required": [ + "serial_number" + ], + "type": "object" + }, + "v3ClusterArchiveItem": { + "description": "Start an archive of an upgrade.", + "properties": { + "clear": { + "description": "If set to true the currently running upgrade will be cleared", + "type": "boolean" + } + }, + "type": "object" + }, + "v3ClusterAssessItem": { + "description": "The settings necessary to start a pre-upgrade assessment.", + "properties": { + "install_image_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs.", + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterConfig": { + "description": "General cluster information.", + "properties": { + "description": { + "description": "Customer configurable description.", + "type": "string" + }, + "devices": { + "items": { + "$ref": "#/definitions/v3ClusterConfigDevice" + }, + "type": "array" + }, + "encoding": { + "description": "Default encoding.", + "type": "string" + }, + "guid": { + "description": "Cluster GUID.", + "type": "string" + }, + "has_quorum": { + "description": "If true, the local node is in a group with quorum: It is communicating, storing, and protecting data normally with other nodes in its group. Under normal circumstances, every node in the cluster is part of one group.", + "type": "boolean" + }, + "is_compliance": { + "description": "If true, the cluster is in compliance mode. Compliance mode clusters do not allow root access and have stricter WORM (Write Once Read Many) features for retaining data in compliance with U.S. Securities and Exchange Commission rule 17a-4.", + "type": "boolean" + }, + "is_virtual": { + "description": "true if the cluster is deployed on a desktop VMWorkstation", + "type": "boolean" + }, + "is_vonefs": { + "description": "true if this is a vOneFS cluster on an ESXi", + "type": "boolean" + }, + "join_mode": { + "description": "Node join mode: 'manual' or 'secure'.", + "type": "string" + }, + "local_devid": { + "description": "Device ID of the queried node.", + "type": "integer" + }, + "local_lnn": { + "description": "Device logical node number of the queried node.", + "type": "integer" + }, + "local_serial": { + "description": "Device serial number of the queried node.", + "type": "string" + }, + "name": { + "description": "Cluster name.", + "type": "string" + }, + "onefs_version": { + "$ref": "#/definitions/v3ClusterConfigOnefsVersion" + }, + "timezone": { + "$ref": "#/definitions/v1ClusterConfigTimezone" + }, + "upgrade_type": { + "description": "The type of the current running upgrade (rolling, simultaneous, or assessment), or null if no upgrade is currently happening.", + "enum": [ + "rolling", + "simultaneous", + "assessment" + ], + "type": "string" + } + }, + "required": [ + "local_devid", + "is_compliance", + "description", + "encoding", + "join_mode", + "local_serial", + "upgrade_type", + "devices", + "name", + "is_virtual", + "has_quorum", + "guid", + "local_lnn", + "is_vonefs" + ], + "type": "object" + }, + "v3ClusterConfigDevice": { + "properties": { + "devid": { + "description": "Device ID.", + "type": "integer" + }, + "guid": { + "description": "Device GUID.", + "type": "string" + }, + "is_up": { + "description": "If true, this node is online and communicating with the local node and every other node with the is_up property normally. If false, this node is not currently communicating with the local node or other nodes with the is_up property. It may be shut down, rebooting, disconnected from the backend network, or connected only to other nodes.", + "type": "boolean" + }, + "lnn": { + "description": "Device logical node number.", + "type": "integer" + } + }, + "required": [ + "guid", + "devid", + "lnn", + "is_up" + ], + "type": "object" + }, + "v3ClusterConfigOnefsVersion": { + "properties": { + "build": { + "description": "OneFS build string.", + "type": "string" + }, + "copyright": { + "description": "Cluster copyright information.", + "type": "string" + }, + "reldate": { + "description": "Timestamp of release date.", + "type": "integer" + }, + "release": { + "description": "Kernel release number.", + "type": "string" + }, + "revision": { + "description": "OneFS build number.", + "type": "string" + }, + "type": { + "description": "Kernel release type.", + "type": "string" + }, + "version": { + "description": "Kernel full version information.", + "type": "string" + } + }, + "required": [ + "copyright", + "reldate", + "version", + "build", + "release", + "type", + "revision" + ], + "type": "object" + }, + "v3ClusterFirmwareProgress": { + "description": "Cluster wide firmware upgrade progress info.", + "properties": { + "cluster_state": { + "description": "The different states of a firmware upgrade. One of the following values: 'committed', 'upgrading', 'error'", + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterIdentity": { + "description": "Unprivileged cluster information for display when logging in.", + "properties": { + "description": { + "description": "A description of the cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logon": { + "$ref": "#/definitions/v3ClusterIdentityLogon" + }, + "name": { + "description": "The name of the cluster.", + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterIdentityLogon": { + "description": "The information displayed when a user logs in to the cluster.", + "properties": { + "motd": { + "description": "The message of the day.", + "type": "string" + }, + "motd_header": { + "description": "The header to the message of the day.", + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterNode": { + "description": "Node information.", + "properties": { + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v3ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "hardware": { + "$ref": "#/definitions/v3ClusterNodeHardware" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "$ref": "#/definitions/v10ClusterNodePartitions" + }, + "sensors": { + "$ref": "#/definitions/v10ClusterNodeSensors" + }, + "state": { + "$ref": "#/definitions/v10ClusterNodeState" + }, + "status": { + "$ref": "#/definitions/v10ClusterNodeStatus" + } + }, + "type": "object" + }, + "v3ClusterNodeDrive": { + "description": "Drive information.", + "properties": { + "baynum": { + "description": "Numerical representation of this drive's bay.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "blocks": { + "description": "Number of blocks on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "chassis": { + "description": "The chassis number which contains this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "devname": { + "description": "This drive's device name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "firmware": { + "$ref": "#/definitions/v10ClusterNodeDriveFirmware" + }, + "handle": { + "description": "Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "interface_type": { + "description": "String representation of this drive's interface type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnum": { + "description": "This drive's logical drive number in IFS.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "locnstr": { + "description": "String representation of this drive's physical location.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logical_block_length": { + "description": "Size of a logical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "media_type": { + "description": "String representation of this drive's media type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "This drive's manufacturer and model.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "physical_block_length": { + "description": "Size of a physical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "present": { + "description": "Indicates whether this drive is physically present in the node.", + "type": "boolean" + }, + "purpose": { + "description": "This drive's purpose in the DRV state machine.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "purpose_description": { + "description": "Description of this drive's purpose.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "serial": { + "description": "Serial number for this drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ui_state": { + "description": "This drive's state as presented to the UI.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "wwn": { + "description": "The drive's 'worldwide name' from its NAA identifiers.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "x_loc": { + "description": "This drive's x-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "y_loc": { + "description": "This drive's y-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3ClusterNodeExtended": { + "description": "Node information.", + "properties": { + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v3ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "state": { + "$ref": "#/definitions/v3ClusterNodeState" + } + }, + "type": "object" + }, + "v3ClusterNodeExtendedExtended": { + "description": "The node details useful during an upgrade or assessment.", + "properties": { + "error": { + "$ref": "#/definitions/v12ClusterNodeError" + }, + "last_action": { + "description": "The last action performed to completion/failure on this node. Null if the node_state is 'committed' or 'assessing.' One of the following values: 'upgrade', 'rollback'.", + "type": "string" + }, + "last_action_result": { + "description": "Did the node pass upgrade or rollback without failing? Null if the node_state is 'committed.' One of the following values: 'pass', 'fail', null", + "type": "string" + }, + "lnn": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "node_state": { + "description": "\\e\nThe state of the node during the upgrade, rollback, or assessment. One of the following values: 'committed', 'upgraded', 'upgrading', 'rolling back', 'assessing', 'error'", + "type": "string" + }, + "onefs_version": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "progress": { + "description": "What step is the upgrade, assessment, or rollback in? To show via progress indicator. NOTE: the value is an integer between 0 and 100 (percent)", + "type": "integer" + } + }, + "type": "object" + }, + "v3ClusterNodeHardware": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_count": { + "description": "Number of chassis making up this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "flash_drive": { + "description": "Manufacturer, model, and device id of this node's flash drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "imb_version": { + "description": "Version of this node's PowerScale Management Board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 18446744073709552000, + "minimum": 0, + "type": "integer", + "format":"int64" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterNodeState": { + "description": "Node state information (reported and modifiable).", + "properties": { + "readonly": { + "$ref": "#/definitions/Empty" + }, + "servicelight": { + "$ref": "#/definitions/v3ClusterNodeStateServicelight" + }, + "smartfail": { + "$ref": "#/definitions/v3ClusterNodeStateSmartfail" + } + }, + "type": "object" + }, + "v3ClusterNodeStateServicelight": { + "description": "Node service light state.", + "properties": { + "enabled": { + "description": "The node service light state (True = on).", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "type": "object" + }, + "v3ClusterNodeStateSmartfail": { + "description": "Node smartfail state.", + "properties": { + "smartfailed": { + "description": "This node is smartfailed (soft_devs).", + "type": "boolean" + } + }, + "type": "object" + }, + "v3ClusterNodes": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3ClusterNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 4294967295, + "minimum": 0, + "type": "integer", + "format":"int64" + } + }, + "type": "object" + }, + "v3ClusterNodesAvailable": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v3ClusterNodesAvailableNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3ClusterNodesAvailableNode": { + "description": "Available Node information.", + "properties": { + "configuration_id": { + "description": "Node configuration ID.", + "type": "string" + }, + "description": { + "description": "Human-readable description giving further detail on status (may be empty)", + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "type": "string" + }, + "serial_number": { + "description": "Serial number of this node.", + "type": "string" + }, + "status": { + "description": "Availability of the node.", + "enum": [ + "available", + "waiting", + "error", + "error_permanent", + "working", + "rebooting", + "exiting" + ], + "type": "string" + }, + "version": { + "description": "OneFS build version running on the node.", + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterNodesExtended": { + "description": "View information about nodes during an upgrade, rollback, or pre-upgrade assessment.", + "properties": { + "nodes": { + "description": "List of detailed info of nodes which are part of the current upgrade", + "items": { + "$ref": "#/definitions/v3ClusterNodeExtendedExtended" + }, + "type": "array" + }, + "total": { + "description": "Total number of nodes the upgrade framework is aware of and was able to collect info for at this point.", + "type": "integer" + } + }, + "type": "object" + }, + "v3ClusterRetryLastActionItem": { + "description": "Retry the last upgrade action, in-case the previous attempt failed.", + "properties": { + "nodes": { + "description": "List of the nodes or \"all\" where the last upgrade action can be retried.", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "v3ClusterTime": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3ClusterTimeNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3ClusterTimeExtended": { + "properties": { + "time": { + "description": "The current time on the cluster as a UNIX epoch (seconds since 1/1/1970), as reported by this node.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "time" + ], + "type": "object" + }, + "v3ClusterTimeNode": { + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "time": { + "description": "The current time on the cluster as a UNIX epoch (seconds since 1/1/1970), as reported by this node.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "type": "object" + }, + "v3ClusterTimezone": { + "description": "The cluster timezone settings.", + "properties": { + "settings": { + "$ref": "#/definitions/v3ClusterTimezoneSettings" + } + }, + "type": "object" + }, + "v3ClusterTimezoneExtended": { + "description": "The cluster timezone settings.", + "properties": { + "settings": { + "$ref": "#/definitions/v3ClusterTimezoneSettingsExtended" + } + }, + "type": "object" + }, + "v3ClusterTimezoneSettings": { + "properties": { + "abbreviation": { + "description": "Timezone abbreviation.", + "type": "string" + }, + "path": { + "description": "Timezone hierarchical name.", + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterTimezoneSettingsExtended": { + "properties": { + "path": { + "description": "Timezone hierarchical name.", + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterUpgradeItem": { + "description": "The settings necessary to start an upgrade.", + "properties": { + "install_image_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "nodes_to_rolling_upgrade": { + "description": "The nodes (to be) scheduled for upgrade ordered by queue position number. Null if the cluster_state is 'partially upgraded' or upgrade_type is 'simultaneous'. One of the following values: [, , ... ], 'all', null", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + }, + "skip_optional": { + "description": "Used to indicate that the pre-upgrade check should be skipped.", + "type": "boolean" + }, + "upgrade_type": { + "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous'", + "maxLength": 128, + "minLength": 3, + "type": "string" + } + }, + "type": "object" + }, + "v3ClusterVersion": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3ClusterVersionNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3ClusterVersionNode": { + "properties": { + "build": { + "description": "OneFS build string.", + "type": "string" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "release": { + "description": "Kernel release number.", + "type": "string" + }, + "revision": { + "description": "OneFS build number.", + "type": "string" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "Kernel release type.", + "type": "string" + }, + "version": { + "description": "Kernel full version information.", + "type": "string" + } + }, + "required": [ + "version", + "build", + "release", + "type", + "revision" + ], + "type": "object" + }, + "v3DiagnosticsGather": { + "additionalProperties": false, + "properties": { + "gather": { + "$ref": "#/definitions/v3DiagnosticsGatherGather" + } + }, + "type": "object" + }, + "v3DiagnosticsGatherGather": { + "properties": { + "path": { + "type": "string" + }, + "status": { + "$ref": "#/definitions/v3DiagnosticsGatherGatherStatus" + } + }, + "type": "object" + }, + "v3DiagnosticsGatherGatherStatus": { + "properties": { + "Active_Status": { + "description": "The current status of the process", + "enum": [ + "NOT_RUNNING", + "RUNNING", + "FINISHED", + "STOPPING", + "STOPPED" + ], + "type": "string" + }, + "Last_Status": { + "description": "The previous status of the process", + "enum": [ + "NOT_RUNNING", + "RUNNING", + "FINISHED", + "STOPPING", + "STOPPED" + ], + "type": "string" + } + }, + "required": [ + "Last_Status", + "Active_Status" + ], + "type": "object" + }, + "v3DiagnosticsGatherSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v3DiagnosticsGatherSettingsSettings" + } + }, + "type": "object" + }, + "v3DiagnosticsGatherSettingsExtended": { + "properties": { + "esrs": { + "description": "Use ESRS for upload of gather.", + "type": "boolean" + }, + "ftp_upload": { + "description": "Use FTP to upload logs from the isi gather command", + "type": "boolean" + }, + "ftp_upload_host": { + "description": "Alternate FTP host to use for FTP upload.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "ftp_upload_mode": { + "description": "FTP upload mode.", + "enum": [ + "both", + "passive", + "active" + ], + "type": "string" + }, + "ftp_upload_pass": { + "description": "FTP password to use for FTP upload.", + "type": "string" + }, + "ftp_upload_path": { + "description": "Alternate FTP path to use for FTP upload.", + "maxLength": 4096, + "type": "string" + }, + "ftp_upload_proxy": { + "description": "Proxy server to use for FTP upload.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "ftp_upload_proxy_port": { + "description": "Proxy server port to use for FTP upload.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "ftp_upload_user": { + "description": "FTP user to use for FTP upload.", + "maxLength": 256, + "type": "string" + }, + "gather_mode": { + "description": "Set gather to full or incremental.", + "enum": [ + "full", + "incremental" + ], + "type": "string" + }, + "http_upload": { + "description": "Use HTTP to upload logs from the isi gather command", + "type": "boolean" + }, + "http_upload_host": { + "description": "Address of an alternate HTTP host used to upload logs", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "http_upload_path": { + "description": "Alternate path on HTTP server to use for HTTP upload.", + "maxLength": 4096, + "type": "string" + }, + "http_upload_proxy": { + "description": "Proxy server to use for HTTP upload.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "http_upload_proxy_port": { + "description": "Proxy server port to use for HTTP upload.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "upload": { + "description": "Upload gather to Dell EMC.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3DiagnosticsGatherSettingsSettings": { + "properties": { + "esrs": { + "description": "Use ESRS for upload of gather.", + "type": "boolean" + }, + "ftp_upload": { + "description": "Use FTP to upload logs from the isi gather command", + "type": "boolean" + }, + "ftp_upload_host": { + "description": "Alternate FTP host to use for FTP upload.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "ftp_upload_mode": { + "description": "FTP upload mode.", + "enum": [ + "both", + "passive", + "active" + ], + "type": "string" + }, + "ftp_upload_path": { + "description": "Alternate FTP path to use for FTP upload.", + "maxLength": 4096, + "type": "string" + }, + "ftp_upload_proxy": { + "description": "Proxy server to use for FTP upload.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "ftp_upload_proxy_port": { + "description": "Proxy server port to use for FTP upload.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "ftp_upload_user": { + "description": "FTP user to use for FTP upload.", + "maxLength": 256, + "type": "string" + }, + "gather_mode": { + "description": "Set gather to full or incremental.", + "enum": [ + "full", + "incremental" + ], + "type": "string" + }, + "http_upload": { + "description": "Use HTTP to upload logs from the isi gather command", + "type": "boolean" + }, + "http_upload_host": { + "description": "Address of an alternate HTTP host used to upload logs", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "http_upload_path": { + "description": "Alternate path on HTTP server to use for HTTP upload.", + "maxLength": 4096, + "type": "string" + }, + "http_upload_proxy": { + "description": "Proxy server to use for HTTP upload.", + "pattern": "(^$|^((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)$|^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "http_upload_proxy_port": { + "description": "Proxy server port to use for HTTP upload.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "upload": { + "description": "Upload gather to Dell EMC.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3DiagnosticsNetlogger": { + "additionalProperties": false, + "properties": { + "netlogger": { + "$ref": "#/definitions/v3DiagnosticsGatherGather" + } + }, + "type": "object" + }, + "v3DiagnosticsNetloggerSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v3DiagnosticsNetloggerSettingsSettings" + } + }, + "type": "object" + }, + "v3DiagnosticsNetloggerSettingsSettings": { + "properties": { + "clients": { + "description": "Limit packet collection to specified Client hostname/IP addresses.", + "pattern": "^$|^(((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)|([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}|[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7})(,(((([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-]{0,61})?[a-zA-Z0-9])*)|([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}|[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}))*$", + "type": "string" + }, + "count": { + "description": "The number of packet capture files to keep after they reach the duration limit. Defaults to the latest 3 files. 0 is infinite.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "Duration in minutes of each capture file", + "maximum": 255, + "minimum": 1, + "type": "integer" + }, + "interfaces": { + "description": "Limit packet collection to specified network interfaces.", + "pattern": "^[a-z0-9]*(,[a-z0-9]*)*$", + "type": "string" + }, + "nodelist": { + "description": "List of nodes specified by LNN on which to run the capture, or empty for all", + "pattern": "^$|^([0-9]{1,3}(,[0-9]{1,3})*)$", + "type": "string" + }, + "ports": { + "description": "Limit packet collection to specified TCP or UDP ports", + "pattern": "^$|^([0-9]{1,5}(,[0-9]{1,5})*)$", + "type": "string" + }, + "protocols": { + "description": "Limit packet collection to specified protocols", + "pattern": "^(ip6|ip|arp|tcp|udp)(,(ip6|ip|arp|tcp|udp))*$", + "type": "string" + }, + "snaplength": { + "description": "The maximum amount of data for each packet that is captured. Default is 320 bytes. Valid range is 64 to 9100 bytes", + "maximum": 9100, + "minimum": 64, + "type": "integer" + } + }, + "type": "object" + }, + "v3DrivesDriveFirmware": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3DrivesDriveFirmwareNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3DrivesDriveFirmwareNode": { + "description": "Information about this node's drive firmware.", + "properties": { + "drives": { + "description": "List of the firmware revisions on the drives in this node.", + "items": { + "$ref": "#/definitions/v3DrivesDriveFirmwareNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3DrivesDriveFirmwareNodeDrive": { + "description": "Drive firmware information.", + "properties": { + "baynum": { + "description": "Numerical representation of this drive's bay.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "current_firmware": { + "description": "This drive's current firmware revision", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "desired_firmware": { + "description": "This drive's desired firmware revision.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "devname": { + "description": "This drive's device name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnum": { + "description": "This drive's logical drive number in IFS.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "locnstr": { + "description": "String representation of this drive's physical location.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "This drive's manufacturer and model.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3DrivesDriveFirmwareUpdate": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3DrivesDriveFirmwareUpdateNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3DrivesDriveFirmwareUpdateItem": { + "description": "Drive firmware update information.", + "properties": { + "cluster_wide": { + "description": "Indicates whether this is a cluster wide drive firmware update or not", + "type": "boolean" + } + }, + "required": [ + "cluster_wide" + ], + "type": "object" + }, + "v3DrivesDriveFirmwareUpdateNode": { + "description": "Drive firmware update information.", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "$ref": "#/definitions/v3DrivesDriveFirmwareUpdateNodeStatus" + } + }, + "type": "object" + }, + "v3DrivesDriveFirmwareUpdateNodeStatus": { + "description": "Drive firmware update status information.", + "properties": { + "failed": { + "description": "The number of drives that did not successfully complete firmware updates update on the node.", + "type": "integer" + }, + "finish_time": { + "description": "Time when drive firmware update finished on node.", + "type": "string" + }, + "remaining": { + "description": "Number of drives remaining to be updated on node.", + "type": "integer" + }, + "start_time": { + "description": "Time when drive firmware update started on node.", + "type": "string" + }, + "status": { + "description": "Overall status of this nodes firmware updates.", + "type": "string" + }, + "updated": { + "description": "The number of drives that completed firmware updates on the node.", + "type": "integer" + } + }, + "type": "object" + }, + "v3DrivesDriveFormatItem": { + "description": "Drive purpose information.", + "properties": { + "purpose": { + "description": "The purpose to which this drive should be formatted. If not specified, defaults to 'None', which will be automatically purposed based on node configuration and drive type.", + "type": "string" + } + }, + "type": "object" + }, + "v3DrivesDrivePurposeItem": { + "description": "Drive purpose information.", + "properties": { + "purpose": { + "description": "The purpose to which this drive should be assigned. This field is required for the 'purpose' action.", + "type": "string" + } + }, + "required": [ + "purpose" + ], + "type": "object" + }, + "v3EventAlertCondition": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "channel_ids": { + "description": "Channels for alert.", + "items": { + "type": "integer" + }, + "minimum": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Unique identifier.", + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "name", + "channel_ids", + "condition" + ], + "type": "object" + }, + "v3EventAlertConditionExtended": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "channel_ids": { + "description": "Channels for alert.", + "items": { + "type": "integer" + }, + "minimum": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "minimum": 0, + "type": "integer" + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventAlertConditions": { + "additionalProperties": false, + "properties": { + "alert-conditions": { + "items": { + "$ref": "#/definitions/v3EventAlertConditionsAlert-Condition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventAlertConditionsAlert-Condition": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "channel_ids": { + "description": "Channels for alert.", + "items": { + "type": "integer" + }, + "minimum": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Unique identifier.", + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventAlertConditionsAlert-ConditionExtended": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "channel_ids": { + "description": "Channels for alert.", + "items": { + "type": "integer" + }, + "minimum": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Unique identifier.", + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventAlertConditionsExtended": { + "additionalProperties": false, + "properties": { + "alert-conditions": { + "items": { + "$ref": "#/definitions/v3EventAlertConditionsAlert-ConditionExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3EventCategories": { + "additionalProperties": false, + "properties": { + "categories": { + "items": { + "$ref": "#/definitions/v3EventCategory" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventCategoriesExtended": { + "additionalProperties": false, + "properties": { + "categories": { + "items": { + "$ref": "#/definitions/v3EventCategory" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3EventCategory": { + "description": "High level categorisation of eventgroups.", + "properties": { + "id": { + "description": "Numeric identifier of eventgroup category.", + "type": "string" + }, + "id_name": { + "description": "Name of category.", + "type": "string" + }, + "name": { + "description": "Description of category.", + "type": "string" + } + }, + "type": "object" + }, + "v3EventChannel": { + "description": "Named channel through which alerts can be delivered.", + "properties": { + "allowed_nodes": { + "description": "Nodes (LNNs) that can be masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "enabled": { + "description": "Channel is to be used or not.", + "type": "boolean" + }, + "excluded_nodes": { + "description": "Nodes (LNNs) that can NOT be the masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Channel name, may not contain /.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/v12EventChannelsParameters" + }, + "system": { + "description": "Channel is a pre-defined system channel.", + "type": "boolean" + }, + "type": { + "description": "The mechanism used by the channel.", + "enum": [ + "connectemc", + "smtp", + "snmp", + "heartbeat" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3EventChannels": { + "additionalProperties": false, + "properties": { + "channels": { + "items": { + "$ref": "#/definitions/v3EventChannel" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventChannelsExtended": { + "additionalProperties": false, + "properties": { + "channels": { + "items": { + "$ref": "#/definitions/v3EventChannel" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3EventEvent": { + "description": "Test Event Specifier.", + "properties": { + "message": { + "description": "Message for test event.", + "type": "string" + } + }, + "type": "object" + }, + "v3EventEventgroupDefinitions": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v3EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventEventgroupDefinitionsEventgroup-Definition": { + "description": "Description of an eventgroup that can occur and be detected.", + "properties": { + "category": { + "description": "ID of eventgroup category.", + "type": "string" + }, + "description": { + "description": "Human readable description - may contain value placeholders.", + "type": "string" + }, + "id": { + "description": "Unique Identifier.", + "type": "string" + }, + "name": { + "description": "Name for eventgroup.", + "type": "string" + } + }, + "type": "object" + }, + "v3EventEventgroupDefinitionsExtended": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v3EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3EventEventgroupOccurrences": { + "additionalProperties": false, + "properties": { + "eventgroups": { + "items": { + "$ref": "#/definitions/v3EventEventgroupOccurrencesEventgroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventEventgroupOccurrencesEventgroup": { + "description": "Record of an eventgroup occurrence.", + "properties": { + "causes": { + "description": "List of eventgroup IDs that may be causes of this occurrence.", + "items": { + "description": "Event Group cause as name and description.", + "items": { + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "type": "array" + }, + "channels": { + "description": "List of channels to which alerts are configured for this eventgroup.", + "items": { + "type": "string" + }, + "type": "array" + }, + "event_count": { + "description": "Number of events linked to this eventgroup.", + "type": "integer" + }, + "eventgroup_instance": { + "description": "Unique identifier of eventgroup instance.", + "type": "string" + }, + "id": { + "description": "Same as eventgroup_instance.", + "type": "string" + }, + "ignore": { + "description": "True if eventgroup is marked as 'ignore'.", + "type": "boolean" + }, + "ignore_time": { + "description": "Time eventgroup was marked as 'ignore'.", + "type": "integer" + }, + "last_event": { + "description": "Time the most recent event was added to this eventgroup.", + "type": "integer" + }, + "resolve_time": { + "description": "When the eventgroup became resolved.", + "type": "integer" + }, + "resolved": { + "description": "True if eventgroup is resolved.", + "type": "boolean" + }, + "resolver": { + "description": "'USER' if the eventgroup was marked resolved by the user. '' if eventgroup was marked resolved as a result of an event.", + "type": "string" + }, + "sequence": { + "description": "Unique sequence number assigned to the eventgroup, by order of creation.", + "type": "integer" + }, + "severity": { + "description": "Event Group severity.", + "type": "string" + }, + "specifier": { + "$ref": "#/definitions/Empty" + }, + "time_noticed": { + "description": "Time of first event linked to this eventgroup.", + "type": "integer" + } + }, + "type": "object" + }, + "v3EventEventgroupOccurrencesExtended": { + "additionalProperties": false, + "properties": { + "eventgroups": { + "items": { + "$ref": "#/definitions/v3EventEventgroupOccurrencesEventgroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3EventEventlist": { + "description": "Events linked to an eventgroup occurrence.", + "properties": { + "event_count": { + "description": "Number of events linked to this eventgroup.", + "type": "integer" + }, + "eventgroup_instance": { + "description": "Unique identifier of eventgroup instance.", + "type": "string" + }, + "events": { + "description": "List of all events linked to this eventgroup in chronological order.", + "items": { + "$ref": "#/definitions/v3EventEventlistEvent" + }, + "type": "array" + }, + "id": { + "description": "Same as eventgroup_instance.", + "type": "string" + } + }, + "type": "object" + }, + "v3EventEventlistEvent": { + "description": "Record of an event occurring on the cluster.", + "properties": { + "devid": { + "description": "The device id of the node if it is still part of the cluster otherwise None.", + "type": "integer" + }, + "ended": { + "description": "Time event was ended (eventgroup resolved).", + "type": "number" + }, + "event_id": { + "description": "Integer identifier of the event type.", + "type": "integer" + }, + "id": { + "description": "Unique identifier of event occurrence.", + "type": "string" + }, + "lnn": { + "description": "The lnn of the node if it is still part of the cluster, otherwise None.", + "type": "integer" + }, + "message": { + "description": "Human readable description.", + "type": "string" + }, + "resolve_time": { + "description": "Time the event was resolved.", + "type": "integer" + }, + "severity": { + "description": "Severity of event occurrence.", + "enum": [ + "information", + "warning", + "critical", + "emergency", + "unknown" + ], + "type": "string" + }, + "specifier": { + "$ref": "#/definitions/Empty" + }, + "time": { + "description": "Time event was detected as UNIX timestamp.", + "type": "integer" + }, + "value": { + "description": "Value of measurement associated with this event.", + "type": "number" + } + }, + "type": "object" + }, + "v3EventEventlists": { + "additionalProperties": false, + "properties": { + "eventlists": { + "items": { + "$ref": "#/definitions/v3EventEventlist" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3EventEventlistsExtended": { + "additionalProperties": false, + "properties": { + "eventlists": { + "items": { + "$ref": "#/definitions/v3EventEventlist" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3EventSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v3EventSettingsSettings" + } + }, + "type": "object" + }, + "v3EventSettingsSettings": { + "description": "Settings for CELOG system.", + "properties": { + "heartbeat_interval": { + "description": "Interval between heartbeat events. \"daily\", \"weekly\", or \"monthly\".", + "type": "string" + }, + "retention_days": { + "description": "Retention period in days.", + "type": "integer" + }, + "storage_limit": { + "description": "Storage limit in megabytes per terabyte of available storage.", + "type": "integer" + } + }, + "type": "object" + }, + "v3FileFilterSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v3FileFilterSettingsSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v3FileFilterSettingsSettings": { + "properties": { + "file_filter_extensions": { + "description": "List of file extensions to be filtered.", + "items": { + "type": "string" + }, + "type": "array" + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Indicates whether file filtering is enabled on this zone.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_FILE_FILTER_SETTINGS" + }, + "v3FsaResult": { + "properties": { + "begin_time": { + "description": "Unix Epoch time of start of results collection job.", + "type": "integer" + }, + "content_path": { + "description": "Path to results database.", + "type": "string" + }, + "delete_link": { + "description": "Resource to call with DELETE to remove results..", + "type": "string" + }, + "end_time": { + "description": "Unix Epoch time of end of results collection job.", + "type": "integer" + }, + "fsa_state": { + "description": "State of the result set.", + "enum": [ + "unknown", + "work", + "reduce", + "publish" + ], + "type": "string" + }, + "id": { + "description": "The system generated result set ID.", + "type": "integer" + }, + "job_state": { + "description": "State information about the FSA Job.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pinned": { + "description": "True if the result is pinned to prevent automatic removal.", + "type": "boolean" + }, + "properties_link": { + "description": "Resource to call to get result properties.", + "type": "string" + }, + "size": { + "description": "Size of the result set database in bytes.", + "type": "integer" + }, + "version": { + "description": "FSA version used to create result set.", + "type": "integer" + } + }, + "required": [ + "properties_link", + "job_state", + "content_path", + "fsa_state", + "delete_link", + "pinned", + "version", + "end_time", + "begin_time", + "id", + "size" + ], + "type": "object" + }, + "v3FsaResultExtended": { + "allOf": [ + { + "$ref": "#/definitions/v1FsaResultExtended" + }, + { + "properties": { + "pinned": { + "description": "True if the result is pinned to prevent automatic removal.", + "type": "boolean" + } + }, + "required": [ + "pinned" + ], + "type": "object" + } + ] + }, + "v3FsaResults": { + "additionalProperties": false, + "properties": { + "results": { + "items": { + "$ref": "#/definitions/v3FsaResult" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3FsaResultsExtended": { + "additionalProperties": false, + "properties": { + "results": { + "items": { + "$ref": "#/definitions/v3FsaResult" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3FtpSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3FtpSettingsSettings" + } + }, + "type": "object" + }, + "v3FtpSettingsSettings": { + "description": "FTP settings.", + "properties": { + "accept_timeout": { + "description": "The timeout, in seconds, for a remote client to establish a PASV style data connection.", + "maximum": 600, + "minimum": 30, + "type": "integer" + }, + "allow_anon_access": { + "description": "Controls whether anonymous logins are permitted or not.", + "type": "boolean" + }, + "allow_anon_upload": { + "description": "Controls whether anonymous users will be permitted to upload files.", + "type": "boolean" + }, + "allow_dirlists": { + "description": "If set to false, all directory list commands will return a permission denied error.", + "type": "boolean" + }, + "allow_downloads": { + "description": "If set to false, all downloads requests will return a permission denied error.", + "type": "boolean" + }, + "allow_local_access": { + "description": "Controls whether local logins are permitted or not.", + "type": "boolean" + }, + "allow_writes": { + "description": "This controls whether any FTP commands which change the filesystem are allowed or not.", + "type": "boolean" + }, + "always_chdir_homedir": { + "description": "This controls whether FTP will always initially change directories to the home directory of the user, regardless of whether it is chroot-ing.", + "type": "boolean" + }, + "anon_chown_username": { + "description": "This is the name of the user who is given ownership of anonymously uploaded files.", + "type": "string" + }, + "anon_password_list": { + "description": "A list of passwords for anonymous users.", + "items": { + "type": "string" + }, + "type": "array" + }, + "anon_root_path": { + "description": "This option represents a directory in /ifs which vsftpd will try to change into after an anonymous login.", + "type": "string" + }, + "anon_umask": { + "description": "The value that the umask for file creation is set to for anonymous users.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "ascii_mode": { + "description": "Controls whether ascii mode data transfers are honored for various types of requests.", + "enum": [ + "off", + "upload", + "download", + "both" + ], + "type": "string" + }, + "chroot_exception_list": { + "description": "A list of users that are not chrooted when logging in.", + "items": { + "type": "string" + }, + "type": "array" + }, + "chroot_local_mode": { + "description": "If set to 'all', all local users will be (by default) placed in a chroot() jail in their home directory after login. If set to 'all-with-exceptions', all local users except those listed in the chroot exception list (isi ftp chroot-exception-list) will be placed in a chroot() jail in their home directory after login. If set to 'none', no local users will be chrooted by default. If set to 'none-with-exceptions', only the local users listed in the chroot exception list (isi ftp chroot-exception-list) will be place in a chroot() jail in their home directory after login.", + "enum": [ + "all", + "none", + "all-with-exceptions", + "none-with-exceptions" + ], + "type": "string" + }, + "connect_timeout": { + "description": "The timeout, in seconds, for a remote client to respond to our PORT style data connection.", + "maximum": 600, + "minimum": 30, + "type": "integer" + }, + "data_timeout": { + "description": "The timeout, in seconds, which is roughly the maximum time we permit data transfers to stall for with no progress. If the timeout triggers, the remote client is kicked off.", + "maximum": 600, + "minimum": 30, + "type": "integer" + }, + "denied_user_list": { + "description": "A list of uses that will be denied access.", + "items": { + "type": "string" + }, + "type": "array" + }, + "dirlist_localtime": { + "description": "If enabled, display directory listings with the time in your local time zone. The default is to display GMT. The times returned by the MDTM FTP command are also affected by this option.", + "type": "boolean" + }, + "dirlist_names": { + "description": "When set to 'hide', all user and group information in directory listings will be displayed as 'ftp'. When set to 'textual', textual names are shown in the user and group fields of directory listings. When set to 'numeric', numeric IDs are show in the user and group fields of directory listings.", + "enum": [ + "numeric", + "textual", + "hide" + ], + "type": "string" + }, + "file_create_perm": { + "description": "The permissions with which uploaded files are created. Umasks are applied on top of this value.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "limit_anon_passwords": { + "description": "This field determines whether the anon_password_list is used.", + "type": "boolean" + }, + "local_root_path": { + "description": "This option represents a directory in /ifs which vsftpd will try to change into after a local login.", + "type": "string" + }, + "local_umask": { + "description": "The value that the umask for file creation is set to for local users.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "server_to_server": { + "description": "If enabled, allow server-to-server (FXP) transfers.", + "type": "boolean" + }, + "service": { + "description": "This field controls whether the FTP daemon is running.", + "type": "boolean" + }, + "session_support": { + "description": "If enabled, maintain login sessions for each user through Pluggable Authentication Modules (PAM). Disabling this option prevents the ability to do automatic home directory creation if that functionality were otherwise available.", + "type": "boolean" + }, + "session_timeout": { + "description": "The timeout, in seconds, which is roughly the maximum time we permit data transfers to stall for with no progress. If the timeout triggers, the remote client is kicked off.", + "maximum": 600, + "minimum": 30, + "type": "integer" + }, + "user_config_dir": { + "description": "Specifies the directory where per-user config overrides can be found.", + "type": "string" + } + }, + "type": "object" + }, + "v3GroupnetSubnet": { + "properties": { + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addr": { + "description": "The address that SmartConnect listens for DNS requests.", + "maxLength": 2048, + "minLength": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 2, + "type": "integer" + } + }, + "required": [ + "addr_family", + "prefixlen", + "name" + ], + "type": "object" + }, + "v3GroupnetSubnetExtended": { + "properties": { + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "base_addr": { + "description": "The base IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "groupnet": { + "description": "Name of the groupnet this subnet belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique Subnet ID.", + "maxLength": 66, + "minLength": 1, + "type": "string" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "pools": { + "description": "Name of the pools in the subnet.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addr": { + "description": "The address that SmartConnect listens for DNS requests.", + "maxLength": 2048, + "minLength": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 2, + "type": "integer" + } + }, + "type": "object" + }, + "v3GroupnetSubnets": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subnets": { + "items": { + "$ref": "#/definitions/v3GroupnetSubnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3GroupnetsGroupnetSubnet": { + "properties": { + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addr": { + "description": "The address that SmartConnect listens for DNS requests.", + "maxLength": 2048, + "minLength": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 2, + "type": "integer" + } + }, + "type": "object" + }, + "v3GroupnetsGroupnetSubnets": { + "additionalProperties": false, + "properties": { + "subnets": { + "items": { + "$ref": "#/definitions/v3GroupnetSubnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3GroupnetsGroupnetSubnetsSubnetPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3GroupnetsGroupnetSubnetsSubnetPools": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v3SubnetsSubnetPoolsPool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRule": { + "properties": { + "description": { + "description": "Description for the provisioning rule.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "iface": { + "description": "Interface name the provisioning rule applies to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Name of the provisioning rule.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "node_type": { + "description": "Node type the provisioning rule applies to.", + "enum": [ + "any", + "storage", + "accelerator", + "storage-i", + "accelerator-i", + "backup-accelerator" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRules": { + "additionalProperties": false, + "properties": { + "rules": { + "items": { + "$ref": "#/definitions/v3PoolsPoolRulesRule" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3HardeningApplyItem": { + "description": "Apply hardening on the cluster.", + "properties": { + "profile": { + "description": "Hardening profile.", + "type": "string" + }, + "report": { + "description": "Option to only generate and display a report on current cluster configuration with respect to the expected configuration required to apply hardening. If this option is set to true, hardening is not applied after the report is displayed. By default, this option is false.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3HardeningResolveItem": { + "description": "Resolve Issues found on the cluster.", + "properties": { + "profile": { + "description": "Hardening profile.", + "type": "string" + } + }, + "type": "object" + }, + "v3HardeningState": { + "properties": { + "state": { + "$ref": "#/definitions/v3HardeningStateState" + } + }, + "type": "object" + }, + "v3HardeningStateState": { + "description": "The state of hardening operation on the cluster.", + "properties": { + "issues_file": { + "description": "Full contents name of issues file, or null if no issues file is configured. This file contains all issues found when the cluster configuration is checked against expected configuration.", + "type": "string" + }, + "message": { + "description": "This contains more information and details about the operation state.", + "type": "string" + }, + "state": { + "description": "The state of the hardening operation. In case there is no operation currently going on, this will display the last state of operation.", + "enum": [ + "Disabled", + "Checking_Before_Apply", + "Issues_Found_Before_Apply", + "Applying", + "Enabled", + "Checking_Before_Revert", + "Issues_Found_Before_Revert", + "Reverting", + "Failed", + "Resolving", + "Issues_Resolved", + "No_Issues_Found", + "Resolved_failed", + "Issues_Found_In_Report", + "No_Issues_Found_In_Report", + "Other" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3HardeningStatus": { + "properties": { + "status": { + "$ref": "#/definitions/v3HardeningStatusStatus" + } + }, + "type": "object" + }, + "v3HardeningStatusStatus": { + "description": "Hardening Status of the cluster.", + "properties": { + "message": { + "description": "Status text containing cluster-level and nodewise hardening status. Also includes hardening profile if hardening is enabled on at least one node.", + "type": "string" + } + }, + "type": "object" + }, + "v3HardwareFcport": { + "properties": { + "firmware_revision": { + "description": "firmware revision of FC device", + "type": "string" + }, + "id": { + "description": "The unique display id", + "type": "string" + }, + "rate": { + "description": "Data rate in Gbps, Qlogic card does not support rates above 8", + "enum": [ + "auto", + "1", + "2", + "4", + "8", + "16", + "32" + ], + "type": "string" + }, + "state": { + "description": "State of the port", + "enum": [ + "enable", + "disable" + ], + "type": "string" + }, + "topology": { + "description": "Supported topologies, Sheba card & Qlogic card do not support ptp and nport topology respectively", + "enum": [ + "auto", + "ptp", + "loop", + "nport" + ], + "type": "string" + }, + "vendor": { + "description": "Vendor of fiber channel card", + "enum": [ + "Broadcom", + "Qlogic" + ], + "type": "string" + }, + "wwnn": { + "description": "World wide node name of the port", + "type": "string" + }, + "wwpn": { + "description": "World wide port name of the port", + "type": "string" + } + }, + "type": "object" + }, + "v3HardwareFcports": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3HardwareFcportsNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3HardwareFcportsNode": { + "description": "FC port config object representing one node on this cluster.", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "fcports": { + "description": "A list of the FC ports on this node.", + "items": { + "$ref": "#/definitions/v3HardwareFcportsNodeFcport" + }, + "type": "array" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3HardwareFcportsNodeFcport": { + "properties": { + "firmware_revision": { + "description": "firmware revision of FC device", + "type": "string" + }, + "id": { + "description": "The unique display id", + "type": "string" + }, + "port": { + "description": "Port ID", + "type": "string" + }, + "rate": { + "description": "Data rate in Gbps, Qlogic card does not support rates above 8", + "enum": [ + "auto", + "1", + "2", + "4", + "8", + "16", + "32" + ], + "type": "string" + }, + "state": { + "description": "State of the port", + "enum": [ + "enable", + "disable" + ], + "type": "string" + }, + "topology": { + "description": "Supported topologies, Sheba card & Qlogic card do not support ptp and nport topology respectively", + "enum": [ + "auto", + "ptp", + "loop", + "nport" + ], + "type": "string" + }, + "vendor": { + "description": "Vendor of fiber channel card", + "enum": [ + "Broadcom", + "Qlogic" + ], + "type": "string" + }, + "wwnn": { + "description": "World wide node name of the port", + "type": "string" + }, + "wwpn": { + "description": "World wide port name of the port", + "type": "string" + } + }, + "type": "object" + }, + "v3HardwareTapeNameParams": { + "properties": { + "name": { + "description": "The name of the device", + "type": "string" + }, + "state": { + "description": "Set the device state to close", + "enum": [ + "closed" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3HardwareTapes": { + "description": "Get list Tape and Changer devices", + "properties": { + "devices": { + "$ref": "#/definitions/v3HardwareTapesDevices" + }, + "resume": { + "description": "Resume string returned by previous query.", + "type": "string" + }, + "total": { + "description": "The number of devices", + "type": "integer" + } + }, + "type": "object" + }, + "v3HardwareTapesDevices": { + "description": "Information of Tape/MC device", + "properties": { + "media_changers": { + "description": "Information of media-changer devices", + "items": { + "$ref": "#/definitions/v3HardwareTapesDevicesMediaChanger" + }, + "type": "array" + }, + "tapes": { + "description": "Information of tape devices", + "items": { + "$ref": "#/definitions/v3HardwareTapesDevicesMediaChanger" + }, + "type": "array" + } + }, + "type": "object" + }, + "v3HardwareTapesDevicesMediaChanger": { + "properties": { + "id": { + "description": "The unique display id.", + "type": "string" + }, + "name": { + "description": "Name of the device", + "type": "string" + }, + "opencount": { + "description": "Number of open", + "type": "integer" + }, + "paths": { + "description": "Accessible paths of the device", + "items": { + "$ref": "#/definitions/v3HardwareTapesDevicesMediaChangerPath" + }, + "type": "array" + }, + "product": { + "description": "Product information string including vendor, model, and revision", + "type": "string" + }, + "serial": { + "description": "Serial number of the device", + "type": "string" + }, + "state": { + "description": "Device state", + "enum": [ + "read/write", + "write only", + "read only", + "raw", + "closed" + ], + "type": "string" + }, + "wwnn": { + "description": "World wide node name of the port", + "type": "string" + } + }, + "type": "object" + }, + "v3HardwareTapesDevicesMediaChangerPath": { + "description": "An accessible path of the device", + "properties": { + "LUN": { + "description": "Logic unit number of the device on the path", + "type": "integer" + }, + "devname": { + "description": "Device driver file name", + "type": "string" + }, + "opencount": { + "description": "Number of open", + "type": "integer" + }, + "passname": { + "description": "Pass through device driver file name", + "type": "string" + }, + "path": { + "description": "Path of the device", + "type": "string" + }, + "portid": { + "description": "Port ID on the path", + "type": "string" + }, + "state": { + "description": "path state", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "wwpn": { + "description": "World wide port name", + "type": "string" + } + }, + "type": "object" + }, + "v3HdfsLogLevel": { + "properties": { + "level": { + "description": "Setup the HDFS service log level for this node", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace", + "default" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3HealthcheckEvaluation": { + "description": "Evaluation Request/Result", + "properties": { + "checklist_id": { + "description": "Checklist to be run", + "type": "string" + }, + "overrides": { + "description": "Optional overrides for thresholds etc.", + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationOverride" + }, + "type": "array" + }, + "parameters": { + "$ref": "#/definitions/Empty" + } + }, + "required": [ + "checklist_id" + ], + "type": "object" + }, + "v3HealthcheckEvaluationExtended": { + "description": "Evaluation Request/Result", + "properties": { + "checklist_id": { + "description": "Checklist to be run", + "type": "string" + }, + "details": { + "description": "Evaluation results by item - only if COMPLETED", + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationDetail" + }, + "type": "array" + }, + "id": { + "description": "Unique identifier", + "type": "string" + }, + "overrides": { + "description": "Optional overrides for thresholds etc.", + "items": { + "$ref": "#/definitions/v10HealthcheckEvaluationOverride" + }, + "type": "array" + }, + "parameters": { + "$ref": "#/definitions/Empty" + }, + "result": { + "description": "Overall result of evaluation - only if COMPLETED", + "enum": [ + "PASS", + "FAIL" + ], + "type": "string" + }, + "run_status": { + "description": "Execution status", + "enum": [ + "QUEUED", + "RUNNING", + "PAUSED", + "FAILED", + "COMPLETED" + ], + "type": "string" + }, + "start_time": { + "description": "Specifies the start time for a checklist or item.", + "type": "number" + } + }, + "type": "object" + }, + "v3HealthcheckEvaluations": { + "additionalProperties": false, + "properties": { + "evaluations": { + "items": { + "$ref": "#/definitions/v3HealthcheckEvaluationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3HealthcheckEvaluationsExtended": { + "additionalProperties": false, + "properties": { + "evaluations": { + "items": { + "$ref": "#/definitions/v3HealthcheckEvaluationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3HealthcheckItem": { + "description": "Item that can be evaluated", + "properties": { + "description": { + "description": "Optional extended description of item", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "freshness": { + "description": "Maximum age in seconds of acceptable earlier results", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "Unique identifier", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node": { + "description": "True if this item is to be evaluated on each node", + "type": "boolean" + }, + "parameters": { + "description": "Accepted and required parameters", + "items": { + "$ref": "#/definitions/v3HealthcheckItemParameter" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "reference": { + "description": "KB URL or similar reference link", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "summary": { + "description": "Brief description of item", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3HealthcheckItemParameter": { + "description": "Item parameter definition", + "properties": { + "default": { + "description": "Default value of parameter", + "type": "string" + }, + "description": { + "description": "Parameter description including value structure", + "type": "string" + }, + "mandatory": { + "description": "True if parameter must be supplied", + "type": "boolean" + }, + "name": { + "description": "Parameter name", + "type": "string" + } + }, + "type": "object" + }, + "v3HealthcheckItems": { + "additionalProperties": false, + "properties": { + "items": { + "items": { + "$ref": "#/definitions/v3HealthcheckItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3HealthcheckItemsExtended": { + "additionalProperties": false, + "properties": { + "items": { + "items": { + "$ref": "#/definitions/v3HealthcheckItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3HealthcheckParameter": { + "description": "Parameter and Value", + "properties": { + "id": { + "description": "Unique identifier", + "type": "string" + }, + "name": { + "description": "Unique identifier - same as id", + "type": "string" + }, + "value": { + "description": "Value of parameter", + "type": "string" + } + }, + "required": [ + "value", + "name" + ], + "type": "object" + }, + "v3HealthcheckParameterExtended": { + "description": "Parameter and Value", + "properties": { + "id": { + "description": "Unique identifier", + "type": "string" + }, + "name": { + "description": "Unique identifier - same as id", + "type": "string" + }, + "value": { + "description": "Value of parameter", + "type": "string" + } + }, + "type": "object" + }, + "v3HealthcheckParameterExtendedExtended": { + "description": "Parameter and Value", + "properties": { + "id": { + "description": "Unique identifier", + "type": "string" + }, + "name": { + "description": "Unique identifier - same as id", + "type": "string" + }, + "value": { + "description": "Value of parameter", + "type": "string" + } + }, + "type": "object" + }, + "v3HealthcheckParameters": { + "additionalProperties": false, + "properties": { + "parameters": { + "items": { + "$ref": "#/definitions/v3HealthcheckParameterExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3HealthcheckParametersExtended": { + "additionalProperties": false, + "properties": { + "parameters": { + "items": { + "$ref": "#/definitions/v3HealthcheckParameterExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3HistogramStatBy": { + "properties": { + "begin_time": { + "description": "Unix Epoch time of start of results collection job.", + "type": "integer" + }, + "breakouts": { + "description": "Histogram breakout data according to breakout parameter.", + "items": { + "$ref": "#/definitions/v3HistogramStatByBreakout" + }, + "type": "array" + }, + "result_length": { + "description": "Total length of the result list.", + "type": "integer" + } + }, + "required": [ + "result_length", + "breakouts", + "begin_time" + ], + "type": "object" + }, + "v3HistogramStatByBreakout": { + "properties": { + "data": { + "description": "List of bucket, file count pairs.", + "items": { + "type": "string" + }, + "properties": { + "bucket": { + "description": "Stat histogram bucket.", + "type": "integer" + }, + "value": { + "description": "Number of files in bucket.", + "type": "integer" + } + }, + "required": [ + "bucket", + "value" + ], + "type": "array" + }, + "key": { + "description": "Breakout key by which results are filtered.", + "type": "string" + } + }, + "required": [ + "data", + "key" + ], + "type": "object" + }, + "v3HistoryCpu": { + "additionalProperties": false, + "properties": { + "statistics": { + "items": { + "$ref": "#/definitions/v3HistoryCpuStatistic" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3HistoryCpuStatistic": { + "description": "A synciq performance report.", + "properties": { + "allocated": { + "description": "Nodes allocated for the sync action.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "id": { + "description": "An ID for a single performance report.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "limit": { + "description": "Sync action limit.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "name": { + "description": "The name of the SyncIQ policy if specified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "timestamp": { + "description": "Timestamp for the performance report.", + "maximum": 2147483646, + "minimum": 1000000000, + "type": "integer" + }, + "total": { + "description": "Total usage for the performance report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "timestamp", + "limit", + "allocated", + "total", + "id" + ], + "type": "object" + }, + "v3HistoryWorker": { + "additionalProperties": false, + "properties": { + "statistics": { + "items": { + "$ref": "#/definitions/v3HistoryWorkerStatistic" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3HistoryWorkerStatistic": { + "allOf": [ + { + "$ref": "#/definitions/v3HistoryCpuStatistic" + }, + { + "description": "A synciq performance report.", + "properties": { + "name": { + "description": "The name of the SyncIQ policy if specified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + ] + }, + "v3HttpSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3HttpSettingsSettings" + } + }, + "type": "object" + }, + "v3HttpSettingsSettings": { + "description": "This is schema that contains HTTP protocol properties.", + "properties": { + "access_control": { + "description": "Enable Access Control Authentication", + "type": "boolean" + }, + "basic_authentication": { + "description": "Enable Basic Authentication", + "type": "boolean" + }, + "dav": { + "description": "Enable DAV specification", + "type": "boolean" + }, + "enable_access_log": { + "description": "Enable HTTP access logging", + "type": "boolean" + }, + "https": { + "description": "Use HTTPS transport", + "type": "boolean" + }, + "integrated_authentication": { + "description": "Enable Integrated Authentication", + "type": "boolean" + }, + "server_root": { + "description": "Document root directory. Must be within /ifs.", + "type": "string" + }, + "service": { + "description": "Enable/disable the HTTP service or redirect to WebUI.", + "enum": [ + "enabled", + "disabled", + "redirect" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3JobEvent": { + "properties": { + "flags": { + "description": "Event flags.", + "type": "string" + }, + "fmt_type": { + "description": "A string representation of the type of the data value.", + "type": "string" + }, + "id": { + "description": "Job event ID.", + "type": "integer" + }, + "job_id": { + "description": "Job ID.", + "minimum": 1, + "type": "integer" + }, + "job_type": { + "description": "Job Type.", + "type": "string" + }, + "key": { + "description": "Event key name.", + "type": "string" + }, + "phase": { + "description": "Job phase number at time of event.", + "type": "integer" + }, + "raw_type": { + "description": "An integer representation of the type of the data value.", + "type": "integer" + }, + "time": { + "description": "Time of event in Unix epoch seconds.", + "type": "integer" + }, + "value": { + "description": "Event value.", + "type": "string" + } + }, + "required": [ + "fmt_type", + "job_id", + "raw_type", + "job_type", + "value", + "flags", + "key", + "time", + "phase", + "id" + ], + "type": "object" + }, + "v3JobEvents": { + "additionalProperties": false, + "properties": { + "events": { + "items": { + "$ref": "#/definitions/v3JobEvent" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3JobJob": { + "properties": { + "allow_dup": { + "description": "Whether or not to queue the job if one of the same type is already running or queued.", + "type": "boolean" + }, + "avscan_params": { + "$ref": "#/definitions/v10JobJobAvscanParams" + }, + "changelistcreate_params": { + "$ref": "#/definitions/v1JobJobChangelistcreateParams" + }, + "domainmark_params": { + "$ref": "#/definitions/v1JobJobDomainmarkParams" + }, + "esrsmftdownload_params": { + "$ref": "#/definitions/v1JobJobEsrsmftdownloadParams" + }, + "paths": { + "description": "For jobs which take paths, the IFS paths to pass to the job.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "policy": { + "description": "Impact policy of this job instance.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "prepair_params": { + "$ref": "#/definitions/v1JobJobPrepairParams" + }, + "priority": { + "description": "Priority of this job instance; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "smartpoolstree_params": { + "$ref": "#/definitions/v1JobJobSmartpoolstreeParams" + }, + "snaprevert_params": { + "$ref": "#/definitions/v1JobJobSnaprevertParams" + }, + "type": { + "description": "Job type to queue.", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v3JobRecent": { + "additionalProperties": false, + "properties": { + "recent_jobs": { + "items": { + "$ref": "#/definitions/v1JobJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3JobReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v3JobEvent" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3MappingDump": { + "additionalProperties": false, + "properties": { + "identities": { + "items": { + "description": "On-disk identity mapping entry", + "items": { + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NdmpContextsBackup": { + "description": "Get NDMP Context List", + "properties": { + "contexts": { + "items": { + "$ref": "#/definitions/v3NdmpContextsBackupContext" + }, + "type": "array" + }, + "resume": { + "description": "Resume string returned by previous query.", + "type": "string" + }, + "total": { + "description": "The number of ndmp contexts.", + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpContextsBackupContext": { + "properties": { + "context_id": { + "description": "Context ID", + "type": "string" + }, + "id": { + "description": "Unique display id.", + "type": "string" + }, + "path": { + "description": "The directory of the backup. This is not applicable to restore contexts.", + "type": "string" + }, + "snapid": { + "description": "Snapshot ID reserved for the context. This is not applicable to restore contexts.", + "type": "integer" + }, + "start_time": { + "description": "Context creation time", + "type": "integer" + }, + "status": { + "description": "Whether the context is active.", + "type": "string" + }, + "total_sessions": { + "description": "The number of sessions in the context", + "type": "integer" + }, + "type": { + "description": "Type of context; It can be bre, backup, and restore", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpContextsBackupContextExtended": { + "allOf": [ + { + "$ref": "#/definitions/v3NdmpContextsBackupContext" + }, + { + "description": "View a NDMP Context", + "properties": { + "context_expiration_time": { + "description": "Context expiration time", + "type": "integer" + }, + "lead_session_id": { + "description": "The leading session in the backup or restore", + "type": "string" + }, + "multistream": { + "description": "Indicating a multi-stream backup or restore operation", + "type": "boolean" + }, + "sessions": { + "items": { + "$ref": "#/definitions/v3NdmpContextsBackupContextSession" + }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "v3NdmpContextsBackupContextSession": { + "properties": { + "bre_context_id": { + "description": "bre context id; This is not applicable to restore sessions.", + "type": "string" + }, + "session_id": { + "description": "Session ID", + "type": "string" + }, + "start_time": { + "description": "Session creation time", + "type": "integer" + }, + "status": { + "description": "The status of the session", + "type": "string" + }, + "stream_id": { + "description": "Stream ID", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpContextsBackupExtended": { + "additionalProperties": false, + "properties": { + "contexts": { + "items": { + "$ref": "#/definitions/v3NdmpContextsBackupContextExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NdmpContextsBre": { + "additionalProperties": false, + "properties": { + "contexts": { + "items": { + "$ref": "#/definitions/v3NdmpContextsBreContext" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpContextsBreContext": { + "description": "List IDs of all BRE contexts on the cluster", + "properties": { + "bre_context_id": { + "description": "Unique ID of NDMP BRE context", + "type": "string" + }, + "id": { + "description": "Unique display id.", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpContextsBreContextEnvVariable": { + "properties": { + "name": { + "description": "Environment variable name", + "type": "string" + }, + "value": { + "description": "Environment variable value", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpContextsBreContextExtended": { + "allOf": [ + { + "$ref": "#/definitions/v3NdmpContextsBreContext" + }, + { + "description": "View a NDMP restartable backup Context", + "properties": { + "backup type": { + "description": "Backup type", + "type": "string" + }, + "bkp_context_id": { + "description": "Backup Context ID", + "type": "string" + }, + "create_time": { + "description": "Context creation time", + "type": "integer" + }, + "env_variables": { + "description": "List of environment variables for restartable backup", + "items": { + "$ref": "#/definitions/v3NdmpContextsBreContextEnvVariable" + }, + "type": "array" + }, + "results": { + "description": "Backup result", + "type": "integer" + }, + "snap_name": { + "description": "Snapshot name of backup", + "type": "string" + }, + "status": { + "description": "Context status bits", + "type": "integer" + }, + "stream_id": { + "description": "Backup Stream ID", + "type": "integer" + } + }, + "type": "object" + } + ] + }, + "v3NdmpContextsBreExtended": { + "additionalProperties": false, + "properties": { + "contexts": { + "items": { + "$ref": "#/definitions/v3NdmpContextsBreContextExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NdmpDiagnostics": { + "properties": { + "diagnostics": { + "$ref": "#/definitions/v3NdmpDiagnosticsDiagnostics" + } + }, + "type": "object" + }, + "v3NdmpDiagnosticsDiagnostics": { + "properties": { + "diag_level": { + "description": "Diagnostics level for ndmp.", + "type": "integer" + }, + "protocol_version": { + "description": "The version of the ndmp protocol.", + "type": "integer" + }, + "trace_level": { + "description": "Trace level for ndmp.", + "enum": [ + "none", + "standard", + "include-file-history", + "log-file-history" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpDumpdate": { + "properties": { + "date": { + "description": "The backup time since epoch.", + "type": "integer" + }, + "id": { + "description": "The unique display id.", + "type": "string" + }, + "level": { + "description": "The level of the backup.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "The path specified by NDMP environment variable FILESYSTEM.", + "type": "string" + }, + "snapid": { + "description": "The snapshot ID used for a faster incremental backup. 0 means a regular backup.", + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpDumpdates": { + "description": "Get list of dumpdates entries.", + "properties": { + "dumpdates": { + "items": { + "$ref": "#/definitions/v3NdmpDumpdate" + }, + "type": "array" + }, + "resume": { + "description": "Resume string returned by previous query.", + "type": "string" + }, + "total": { + "description": "The number of dumpdates entries.", + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpLogs": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NdmpLogsNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpLogsNode": { + "description": "Object containing a listing of NDMP log file entries at the given log file page for this node.", + "properties": { + "current_page": { + "description": "The page on this node's NDMP log file being returned.", + "type": "string" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "logs": { + "description": "The log file entries from the current page on this node.", + "type": "string" + }, + "max_page": { + "description": "The highest page number in this node's NDMP log file.", + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpSession": { + "description": "Describes various attributes of a backup session", + "properties": { + "data_bytes_transferred": { + "description": "Bytes transferred to/from the filesystem", + "type": "integer" + }, + "data_state": { + "description": "State of the NDMP Data Service", + "enum": [ + "IDLE", + "LISTEN", + "ACTIVE", + "CONNECTED", + "HALTED", + "INVALID" + ], + "type": "string" + }, + "dest_path": { + "description": "The path being recovered to", + "type": "string" + }, + "dma_ip_addr": { + "description": "IP address of the DMA", + "type": "string" + }, + "elapsed_time": { + "description": "Number of seconds elapsed since the backup was started", + "type": "integer" + }, + "id": { + "description": "Unique display ID.", + "type": "string" + }, + "lnn": { + "description": "The lnn of the active session.", + "type": "string" + }, + "mover_bytes_transferred": { + "description": "Bytes transferred to/from tape or remote writer", + "type": "integer" + }, + "mover_state": { + "description": "State of the NDMP Mover Service", + "enum": [ + "IDLE", + "LISTEN", + "ACTIVE", + "PAUSED", + "HALTED", + "INVALID" + ], + "type": "string" + }, + "operation": { + "description": "The type of backup session", + "enum": [ + "None", + "Backup", + "Recover", + "Recover file history" + ], + "type": "string" + }, + "remote_ip_addr": { + "description": "IP address of the remote NDMP participant", + "type": "string" + }, + "scsi_device": { + "description": "Name of the media changer device used if any", + "type": "string" + }, + "session": { + "description": "Session ID in form ..", + "type": "string" + }, + "source_path": { + "description": "The path being backed up", + "type": "string" + }, + "start_time": { + "description": "Time backup was started in seconds since epoch", + "type": "integer" + }, + "tape_device": { + "description": "Name of the tape device used if any", + "type": "string" + }, + "tape_open_mode": { + "description": "Describes the mode in which the tape is opened", + "enum": [ + "Read", + "Read/Write", + "Raw", + "Invalid" + ], + "type": "string" + }, + "throughput": { + "description": "The throughput in MB/s", + "type": "integer" + } + }, + "required": [ + "session", + "tape_device", + "mover_bytes_transferred", + "source_path", + "start_time", + "scsi_device", + "data_bytes_transferred", + "elapsed_time", + "mover_state", + "lnn", + "throughput", + "tape_open_mode", + "dest_path", + "data_state", + "operation", + "dma_ip_addr", + "id", + "remote_ip_addr" + ], + "type": "object" + }, + "v3NdmpSessions": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "sessions": { + "items": { + "$ref": "#/definitions/v3NdmpSession" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpSessionsExtended": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NdmpSessionsNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpSessionsNode": { + "description": "View probe info of a NDMP session", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "sessions": { + "items": { + "$ref": "#/definitions/v3NdmpSessionsNodeSession" + }, + "type": "array" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpSessionsNodeSession": { + "properties": { + "id": { + "description": "Unique display id.", + "type": "string" + }, + "probe_info": { + "description": "Text information from probing the session", + "type": "string" + }, + "session": { + "description": "session ID", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpSettingsDmas": { + "properties": { + "dmavendors": { + "items": { + "$ref": "#/definitions/v3NdmpSettingsDmasDmavendor" + }, + "type": "array" + } + }, + "type": "object" + }, + "v3NdmpSettingsDmasDmavendor": { + "properties": { + "dmavendor": { + "description": "NDMP dma vendor.", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpSettingsGlobal": { + "properties": { + "global": { + "$ref": "#/definitions/v3NdmpSettingsGlobalGlobal" + } + }, + "type": "object" + }, + "v3NdmpSettingsGlobalGlobal": { + "properties": { + "bre_max_num_contexts": { + "description": "Maximum number of BRE contexts.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "dma": { + "description": "A unique identifier for the dma vendor.", + "enum": [ + "generic", + "atempo", + "bakbone", + "commvault", + "emc", + "veritas", + "tivoli", + "veritas-netbackup", + "veritas-backupexec" + ], + "type": "string" + }, + "enable_redirector": { + "description": "Enable/Disable NDMP Redirector feature to distribute NDMP backup and restore operations among multiple nodes.", + "type": "boolean" + }, + "enable_throttler": { + "description": "Enable/Disable NDMP throttler feature to limit CPU usage for NDMP backup or restore operations on each node.", + "type": "boolean" + }, + "msb_context_retention_duration": { + "description": "Multi-Stream Backup context retention duration, expressed in seconds.", + "minimum": 0, + "type": "integer" + }, + "msr_context_retention_duration": { + "description": "Multi-Stream Restore context retention duration, expressed in seconds.", + "minimum": 0, + "type": "integer" + }, + "port": { + "description": "The port to listen on.", + "maximum": 65535, + "minimum": 1024, + "type": "integer" + }, + "service": { + "description": "Property to enable/disable the NDMP service.", + "type": "boolean" + }, + "stub_file_open_timeout": { + "description": "Stub file open timeout during a backup or restore, expressed in seconds.", + "maximum": 1200, + "minimum": 0, + "type": "integer" + }, + "throttler_cpu_threshold": { + "description": "NDMP Throttler CPU threshold in percentage.", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v3NdmpSettingsVariable": { + "properties": { + "value": { + "description": "The value of environment variable.", + "type": "string" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "v3NdmpSettingsVariableCreateParams": { + "allOf": [ + { + "$ref": "#/definitions/v3NdmpSettingsVariable" + }, + { + "properties": { + "name": { + "description": "The name of environment variable.", + "type": "string" + }, + "path": { + "description": "The backup path.", + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object" + } + ] + }, + "v3NdmpSettingsVariables": { + "description": "Get list of preferred environment variable.", + "properties": { + "resume": { + "description": "Resume string returned by previous query.", + "type": "string" + }, + "total": { + "description": "The number of backup paths.", + "type": "integer" + }, + "variables": { + "items": { + "$ref": "#/definitions/v3NdmpSettingsVariablesVariable" + }, + "type": "array" + } + }, + "type": "object" + }, + "v3NdmpSettingsVariablesVariable": { + "properties": { + "id": { + "description": "The unique display id", + "type": "string" + }, + "path": { + "description": "Return variables of the backup path.", + "type": "string" + }, + "path_variables": { + "items": { + "$ref": "#/definitions/v3NdmpSettingsVariablesVariablePathVariable" + }, + "type": "array" + } + }, + "type": "object" + }, + "v3NdmpSettingsVariablesVariablePathVariable": { + "properties": { + "name": { + "description": "The name of environment variable.", + "type": "string" + }, + "value": { + "description": "The value of environment variable.", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpUser": { + "properties": { + "name": { + "description": "A unique user name for NDMP administrator. Special characters(!, @, #, $, %, ^, &, * etc) are not allowed.", + "type": "string" + }, + "password": { + "description": "The password for the NDMP administrator. Whitespace characters or control characters are not allowed.", + "type": "string" + } + }, + "required": [ + "password", + "name" + ], + "type": "object" + }, + "v3NdmpUserExtended": { + "properties": { + "id": { + "description": "Unique display ID.", + "type": "string" + }, + "name": { + "description": "A unique user name for NDMP administrator. Special characters(!, @, #, $, %, ^, &, * etc) are not allowed.", + "type": "string" + } + }, + "type": "object" + }, + "v3NdmpUserExtendedExtended": { + "properties": { + "password": { + "description": "The password for the NDMP administrator. Whitespace characters or control characters are not allowed.", + "type": "string" + } + }, + "required": [ + "password" + ], + "type": "object" + }, + "v3NdmpUsers": { + "additionalProperties": false, + "properties": { + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/definitions/v3NdmpUserExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NdmpUsersExtended": { + "additionalProperties": false, + "properties": { + "users": { + "items": { + "$ref": "#/definitions/v3NdmpUserExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NetworkDnscache": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v3NetworkDnscacheSettings" + } + }, + "type": "object" + }, + "v3NetworkDnscacheExtended": { + "properties": { + "cache_entry_limit": { + "description": "DNS cache entry limit", + "maximum": 1048576, + "minimum": 1, + "type": "integer" + }, + "cluster_timeout": { + "description": "Timeout value for calls made to other nodes in the cluster", + "maximum": 30, + "minimum": 1, + "type": "integer" + }, + "dns_timeout": { + "description": "Timeout value for calls made to the dns resolvers", + "maximum": 30, + "minimum": 1, + "type": "integer" + }, + "eager_refresh": { + "description": "Lead time to refresh cache entries nearing expiration", + "maximum": 60, + "minimum": 0, + "type": "integer" + }, + "testping_delta": { + "description": "Deltas for checking cbind cluster health", + "maximum": 60, + "minimum": 0, + "type": "integer" + }, + "ttl_max_noerror": { + "description": "Upper bound on ttl for cache hits", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_max_nxdomain": { + "description": "Upper bound on ttl for nxdomain", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_max_other": { + "description": "Upper bound on ttl for non-nxdomain failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_max_servfail": { + "description": "Upper bound on ttl for server failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_noerror": { + "description": "Lower bound on ttl for cache hits", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_nxdomain": { + "description": "Lower bound on ttl for nxdomain", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_other": { + "description": "Lower bound on ttl for non-nxdomain failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_servfail": { + "description": "Lower bound on ttl for server failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NetworkDnscacheSettings": { + "properties": { + "cache_entry_limit": { + "description": "DNS cache entry limit", + "maximum": 1048576, + "minimum": 1, + "type": "integer" + }, + "cluster_timeout": { + "description": "Timeout value for calls made to other nodes in the cluster", + "maximum": 30, + "minimum": 1, + "type": "integer" + }, + "dns_timeout": { + "description": "Timeout value for calls made to the dns resolvers", + "maximum": 30, + "minimum": 1, + "type": "integer" + }, + "eager_refresh": { + "description": "Lead time to refresh cache entries nearing expiration", + "maximum": 60, + "minimum": 0, + "type": "integer" + }, + "testping_delta": { + "description": "Deltas for checking cbind cluster health", + "maximum": 60, + "minimum": 0, + "type": "integer" + }, + "ttl_max_noerror": { + "description": "Upper bound on ttl for cache hits", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_max_nxdomain": { + "description": "Upper bound on ttl for nxdomain", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_max_other": { + "description": "Upper bound on ttl for non-nxdomain failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_max_servfail": { + "description": "Upper bound on ttl for server failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_noerror": { + "description": "Lower bound on ttl for cache hits", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_nxdomain": { + "description": "Lower bound on ttl for nxdomain", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_other": { + "description": "Lower bound on ttl for non-nxdomain failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "ttl_min_servfail": { + "description": "Lower bound on ttl for server failures", + "maximum": 3600, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "testping_delta", + "ttl_max_servfail", + "eager_refresh", + "ttl_max_other", + "ttl_min_other", + "cluster_timeout", + "ttl_min_nxdomain", + "ttl_max_noerror", + "ttl_min_noerror", + "ttl_max_nxdomain", + "cache_entry_limit", + "ttl_min_servfail", + "dns_timeout" + ], + "type": "object" + }, + "v3NetworkExternal": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v3NetworkExternalSettings" + } + }, + "type": "object" + }, + "v3NetworkExternalExtended": { + "properties": { + "sbr": { + "description": "Enable or disable Source Based Routing (Defaults to false)", + "type": "boolean" + }, + "sc_rebalance_delay": { + "description": "Delay in seconds for IP rebalance.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "tcp_ports": { + "description": "List of client TCP ports.", + "items": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NetworkExternalSettings": { + "properties": { + "default_groupnet": { + "description": "Default client-side DNS settings for non-multitenancy aware programs", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sbr": { + "description": "Enable or disable Source Based Routing (Defaults to false)", + "type": "boolean" + }, + "sc_rebalance_delay": { + "description": "Delay in seconds for IP rebalance.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "tcp_ports": { + "description": "List of client TCP ports.", + "items": { + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "sbr", + "sc_rebalance_delay", + "default_groupnet", + "tcp_ports" + ], + "type": "object" + }, + "v3NetworkGroupnet": { + "properties": { + "description": { + "description": "A description of the groupnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dns_cache_enabled": { + "description": "DNS caching is enabled or disabled.", + "type": "boolean" + }, + "dns_options": { + "description": "List of DNS resolver options.", + "items": { + "enum": [ + "rotate" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "dns_search": { + "description": "List of DNS search suffixes.", + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "dns_servers": { + "description": "List of Domain Name Server IP addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the groupnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "server_side_dns_search": { + "description": "Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP.", + "type": "boolean" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v3NetworkGroupnetExtended": { + "properties": { + "description": { + "description": "A description of the groupnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dns_cache_enabled": { + "description": "DNS caching is enabled or disabled.", + "type": "boolean" + }, + "dns_options": { + "description": "List of DNS resolver options.", + "items": { + "enum": [ + "rotate" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "dns_search": { + "description": "List of DNS search suffixes.", + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "dns_servers": { + "description": "List of Domain Name Server IP addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique Interface ID.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "The name of the groupnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "server_side_dns_search": { + "description": "Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP.", + "type": "boolean" + }, + "subnets": { + "description": "Name of the subnets in the groupnet.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NetworkGroupnetExtendedExtended": { + "properties": { + "description": { + "description": "A description of the groupnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dns_cache_enabled": { + "description": "DNS caching is enabled or disabled.", + "type": "boolean" + }, + "dns_options": { + "description": "List of DNS resolver options.", + "items": { + "enum": [ + "rotate" + ], + "type": "string" + }, + "maxItems": 1, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "dns_search": { + "description": "List of DNS search suffixes.", + "items": { + "maxLength": 2048, + "minLength": 1, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 6, + "minItems": 0, + "type": "array" + }, + "dns_servers": { + "description": "List of Domain Name Server IP addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 3, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the groupnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "server_side_dns_search": { + "description": "Enable or disable appending nodes DNS search list to client DNS inquiries directed at SmartConnect service IP.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3NetworkGroupnets": { + "additionalProperties": false, + "properties": { + "groupnets": { + "items": { + "$ref": "#/definitions/v3NetworkGroupnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NetworkGroupnetsExtended": { + "additionalProperties": false, + "properties": { + "groupnets": { + "items": { + "$ref": "#/definitions/v3NetworkGroupnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NetworkPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Name of the groupnet this pool belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique Pool ID.", + "maxLength": 99, + "minLength": 1, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "rules": { + "description": "Names of the rules in this pool.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_suspended_nodes": { + "description": "List of LNNs showing currently suspended nodes in SmartConnect.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "subnet": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v3NetworkPools": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v3NetworkPool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NfsLogLevel": { + "properties": { + "level": { + "description": "Valid NFS logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3NfsNetgroup": { + "properties": { + "settings": { + "$ref": "#/definitions/v3NfsNetgroupSettings" + } + }, + "type": "object" + }, + "v3NfsNetgroupSettings": { + "description": "NFS netgroup cache settings.", + "properties": { + "bgwrite": { + "description": "To-disk backup interval for the netgroup cache.", + "type": "integer" + }, + "expiration": { + "description": "Time between updates of netgroups in the cache.", + "type": "integer" + }, + "lifetime": { + "description": "Length of time an un-accessed netgroup remains in the cache.", + "type": "integer" + }, + "retry": { + "description": "Retry interval for netgroup updates if the remote provider is unresponsive.", + "type": "integer" + } + }, + "type": "object" + }, + "v3NfsNlmSessions": { + "additionalProperties": false, + "properties": { + "clients": { + "items": { + "$ref": "#/definitions/v3NfsNlmSessionsClient" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NfsNlmSessionsClient": { + "description": "Describes host/callback information for a NSM monitor entry", + "properties": { + "cluster_ip": { + "description": "An IP address for which NSM has client records", + "type": "string" + }, + "delegates": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "host_type": { + "description": "The sort of host that this entry represents", + "enum": [ + "client", + "server", + "reverse", + "expired" + ], + "type": "string" + }, + "hostname": { + "description": "The host being monitored", + "type": "string" + }, + "id": { + "description": "Session ID", + "type": "string" + }, + "is_active": { + "description": "Whether or not the client is actively being monitored", + "type": "boolean" + }, + "last_modified": { + "description": "Unix time in seconds that the client was last modified (monitored or unmonitored)", + "type": "integer" + }, + "notify_attempts_remaining": { + "description": "Number of times we will attempt to notify this client before giving up", + "type": "integer" + }, + "notify_error": { + "description": "Last error received attempting to notify this client", + "type": "string" + }, + "notify_last_attempt": { + "description": "Unix time in seconds when we last attempted to notify this clients", + "type": "integer" + }, + "zone": { + "description": "Access zone name", + "type": "string" + } + }, + "type": "object" + }, + "v3NfsNlmSessionsExtended": { + "additionalProperties": false, + "properties": { + "sessions": { + "items": { + "$ref": "#/definitions/v3NfsNlmSessionsClient" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NfsSettingsGlobal": { + "properties": { + "settings": { + "$ref": "#/definitions/v3NfsSettingsGlobalSettings" + } + }, + "type": "object" + }, + "v3NfsSettingsGlobalSettings": { + "description": "Specifies the global NFS configuration settings.", + "properties": { + "nfsv3_enabled": { + "description": "True if NFSv3 is enabled.", + "type": "boolean" + }, + "nfsv4_enabled": { + "description": "True if NFSv4 is enabled.", + "type": "boolean" + }, + "rpc_maxthreads": { + "description": "Specifies the maximum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "rpc_minthreads": { + "description": "Specifies the minimum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "service": { + "description": "True if the NFS service is enabled. When set to false, the NFS service is disabled.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_GLOBAL" + }, + "v3NodeDrives": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeDrivesNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeDrivesNode": { + "description": "Information about this node's drives.", + "properties": { + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v3ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeDrivesPurposelist": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeDrivesPurposelistNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeDrivesPurposelistNode": { + "description": "Information about this node's drive purposes.", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "purposes": { + "description": "List of the drive purposes available on this node.", + "items": { + "$ref": "#/definitions/v3NodeDrivesPurposelistNodePurpose" + }, + "type": "array" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeDrivesPurposelistNodePurpose": { + "description": "Purpose information.", + "properties": { + "purpose": { + "description": "String representation of this purpose for API use.", + "type": "string" + }, + "purpose_description": { + "description": "A description of this purpose.", + "type": "string" + } + }, + "type": "object" + }, + "v3NodeHardware": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeHardwareNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeHardwareFast": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v3NodeHardwareFastNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeHardwareFastNode": { + "description": "Fast subset of node hardware identifying information (static).", + "properties": { + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "product": { + "description": "PowerScale product name.", + "type": "string" + }, + "serial_number": { + "description": "Serial number of this node.", + "type": "string" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "type": "string" + } + }, + "type": "object" + }, + "v3NodeHardwareNode": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_count": { + "description": "Number of chassis making up this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "flash_drive": { + "description": "Manufacturer, model, and device id of this node's flash drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "imb_version": { + "description": "Version of this node's PowerScale Management Board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3NodePartitions": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodePartitionsNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodePartitionsNode": { + "description": "Node partition information.", + "properties": { + "count": { + "description": "Count of how many partitions are included.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "description": "Partition information.", + "items": { + "$ref": "#/definitions/v10ClusterNodePartition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeSensors": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeSensorsNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeSensorsNode": { + "description": "Node sensor information (hardware reported).", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "sensors": { + "description": "This node's sensor information.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSensor" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeState": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeStateNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStateNode": { + "description": "Node state information (reported and modifiable).", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "readonly": { + "$ref": "#/definitions/v10ClusterNodeStateReadonly" + }, + "servicelight": { + "$ref": "#/definitions/v10ClusterNodeStateServicelight" + }, + "smartfail": { + "$ref": "#/definitions/v10ClusterNodeStateSmartfail" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStateReadonly": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeStateReadonlyNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStateReadonlyNode": { + "description": "Node readonly state.", + "properties": { + "allowed": { + "description": "The current read-only mode allowed status for the node.", + "type": "boolean" + }, + "enabled": { + "description": "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared.", + "type": "boolean" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "mode": { + "description": "The current read-only mode status for the node.", + "type": "boolean" + }, + "status": { + "description": "The current read-only mode status description for the node.", + "type": "string" + }, + "valid": { + "description": "The read-only state values are valid (False = Error).", + "type": "boolean" + }, + "value": { + "description": "The current read-only value (enumerated bitfield) for the node.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStateServicelight": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeStateServicelightNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStateServicelightExtended": { + "description": "Node service light state.", + "properties": { + "enabled": { + "description": "The node service light state (True = on).", + "type": "boolean" + }, + "present": { + "description": "This node has a service light.", + "type": "boolean" + }, + "supported": { + "description": "This node supports a service light.", + "type": "boolean" + }, + "valid": { + "description": "The node service light state is valid (False = Error).", + "type": "boolean" + } + }, + "type": "object" + }, + "v3NodeStateServicelightNode": { + "description": "Node service light state.", + "properties": { + "enabled": { + "description": "The node service light state (True = on).", + "type": "boolean" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "present": { + "description": "This node has a service light.", + "type": "boolean" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "supported": { + "description": "This node supports a service light.", + "type": "boolean" + }, + "valid": { + "description": "The node service light state is valid (False = Error).", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "type": "object" + }, + "v3NodeStateSmartfail": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeStateSmartfailNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStateSmartfailNode": { + "description": "Node smartfail state.", + "properties": { + "dead": { + "description": "This node is dead (dead_devs).", + "type": "boolean" + }, + "down": { + "description": "This node is down (down_devs).", + "type": "boolean" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "in_cluster": { + "description": "This node is in the cluster (all_devs).", + "type": "boolean" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "readonly": { + "description": "This node is readonly (ro_devs).", + "type": "boolean" + }, + "shutdown_readonly": { + "description": "This node is shutdown readonly (down_devs).", + "type": "boolean" + }, + "smartfailed": { + "description": "This node is smartfailed (soft_devs).", + "type": "boolean" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStatus": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeStatusNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStatusBatterystatus": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v3NodeStatusBatterystatusNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NodeStatusBatterystatusNode": { + "description": "Battery status information.", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "last_test_time1": { + "description": "The last battery test time for battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_test_time2": { + "description": "The last battery test time for battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "next_test_time1": { + "description": "The next checkup for battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "next_test_time2": { + "description": "The next checkup for battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "present": { + "description": "Node has battery status.", + "type": "boolean" + }, + "result1": { + "description": "The result of the last battery test for battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "result2": { + "description": "The result of the last battery test for battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status1": { + "description": "The status of battery 1.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status2": { + "description": "The status of battery 2.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "supported": { + "description": "Node supports battery status.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3NodeStatusNode": { + "description": "Node status information (hardware reported).", + "properties": { + "batterystatus": { + "$ref": "#/definitions/v10ClusterNodeStatusBatterystatus" + }, + "capacity": { + "description": "Storage capacity of this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeStatusCapacityItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "cpu": { + "$ref": "#/definitions/v10ClusterNodeStatusCpu" + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "nvram": { + "$ref": "#/definitions/v10ClusterNodeStatusNvram" + }, + "powersupplies": { + "$ref": "#/definitions/v10ClusterNodeStatusPowersupplies" + }, + "release": { + "description": "OneFS release.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uptime": { + "description": "Seconds this node has been online.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "version": { + "description": "OneFS version.", + "maxLength": 511, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3NodesNodeFirmwareStatus": { + "description": "The firmware status for the node.", + "properties": { + "devices": { + "description": "List of the firmware status for hardware components on the node.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareDeviceNodeDevice" + }, + "maxItems": 64, + "minItems": 0, + "type": "array" + }, + "node_unavailable": { + "description": "Node is unavailable.", + "type": "boolean" + }, + "package": { + "description": "List of the firmware binary information for the installed firmware package.", + "items": { + "$ref": "#/definitions/v10ClusterFirmwareDeviceNodePackageItem" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NtpServer": { + "description": "NTP server.", + "properties": { + "key": { + "description": "Key value from key_file that maps to this server.", + "type": "string" + }, + "name": { + "description": "NTP server name.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v3NtpServerExtended": { + "allOf": [ + { + "$ref": "#/definitions/v3NtpServer" + }, + { + "description": "NTP server.", + "properties": { + "id": { + "description": "Field ID.", + "type": "string" + }, + "key": { + "description": "Key value from key_file that maps to this server.", + "type": "string" + } + }, + "required": [ + "id", + "key" + ], + "type": "object" + } + ] + }, + "v3NtpServerExtendedExtended": { + "description": "NTP server.", + "properties": { + "key": { + "description": "Key value from key_file that maps to this server.", + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "v3NtpServers": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "servers": { + "items": { + "$ref": "#/definitions/v3NtpServerExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3NtpServersExtended": { + "additionalProperties": false, + "properties": { + "servers": { + "items": { + "$ref": "#/definitions/v3NtpServerExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3NtpSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3NtpSettingsSettings" + } + }, + "type": "object" + }, + "v3NtpSettingsSettings": { + "description": "NTP settings.", + "properties": { + "chimers": { + "description": "Number of nodes that will contact the NTP servers.", + "minimum": 1, + "type": "integer" + }, + "excluded": { + "description": "Node number (LNN) for nodes excluded from chimer duty.", + "items": { + "type": "string" + }, + "type": "array" + }, + "key_file": { + "description": "Path to NTP key file within /ifs.", + "type": "string" + } + }, + "type": "object" + }, + "v3PoolsPoolRule": { + "properties": { + "description": { + "description": "Description for the provisioning rule.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "iface": { + "description": "Interface name the provisioning rule applies to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Name of the provisioning rule.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "node_type": { + "description": "Node type the provisioning rule applies to.", + "enum": [ + "any", + "storage", + "accelerator", + "storage-i", + "accelerator-i", + "backup-accelerator" + ], + "type": "string" + } + }, + "required": [ + "iface", + "name" + ], + "type": "object" + }, + "v3PoolsPoolRules": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "rules": { + "items": { + "$ref": "#/definitions/v3PoolsPoolRulesRule" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3PoolsPoolRulesRule": { + "properties": { + "description": { + "description": "Description for the provisioning rule.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Name of the groupnet this rule belongs to", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique rule ID.", + "maxLength": 132, + "minLength": 1, + "type": "string" + }, + "iface": { + "description": "Interface name the provisioning rule applies to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Name of the provisioning rule.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "node_type": { + "description": "Node type the provisioning rule applies to.", + "enum": [ + "any", + "storage", + "accelerator", + "storage-i", + "accelerator-i", + "backup-accelerator" + ], + "type": "string" + }, + "pool": { + "description": "Name of the pool this rule belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "subnet": { + "description": "Name of the subnet this rule belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "subnet", + "iface", + "description", + "node_type", + "groupnet", + "id", + "pool", + "name" + ], + "type": "object" + }, + "v3PoolsPoolScResumeNode": { + "properties": { + "lnn": { + "description": "Logical node numbers of the nodes suspended/resumed.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "lnn" + ], + "type": "object" + }, + "v3ProvidersAds": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v3ProvidersAdsAdsItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersAdsAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "forest": { + "description": "Specifies the Active Directory forest.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname": { + "description": "Specifies the fully qualified hostname stored in the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "instance": { + "description": "Specifies Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_account": { + "description": "Specifies the SAM account name of the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_name": { + "description": "Specifies name to join AD as.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "netbios_domain": { + "description": "Specifies the NetBIOS domain name associated with the machine account.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "primary_domain": { + "description": "Specifies the AD domain to which the provider is joined.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "site": { + "description": "Specifies the site for the Active Directory.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "system": { + "description": "If set to true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersAdsAdsItemExtended": { + "allOf": [ + { + "$ref": "#/definitions/v3ProvidersAdsAdsItem" + }, + { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "recommended_spns": { + "description": "Configuration recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "spns": { + "description": "Currently configured SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "v3ProvidersAdsExtended": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v3ProvidersAdsAdsItemExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersAdsIdParams": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_controller": { + "description": "Specifies the domain controller to which the authentication service should send requests", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_name": { + "description": "Specifies name to join AD as.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "password": { + "description": "Specifies the password used during domain join.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "reset_schannel": { + "description": "Resets the secure channel to the primary domain.", + "type": "boolean" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "spns": { + "description": "Currently configured SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "description": "Specifies the user name that has permission to join a machine to the given domain.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3ProvidersAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "account": { + "description": "Specifies the machine account name when creating a SAM account with Active Directory.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "dns_domain": { + "description": "Specifies the DNS search domain. Set this parameter if the DNS search domain has a unique name or address.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "instance": { + "description": "Specifies Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "kerberos_hdfs_spn": { + "description": "Determines if connecting through HDFS with Kerberos.", + "type": "boolean" + }, + "kerberos_nfs_spn": { + "description": "Determines if connecting through NFS with Kerberos.", + "type": "boolean" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_name": { + "description": "Specifies name to join AD as.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "organizational_unit": { + "description": "Specifies the organizational unit.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the password used during domain join.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "description": "Specifies the user name that has permission to join a machine to the given domain.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "user", + "password", + "name" + ], + "type": "object" + }, + "v3ProvidersKrb5": { + "additionalProperties": false, + "properties": { + "krb5": { + "items": { + "$ref": "#/definitions/v3ProvidersKrb5Krb5Item" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersKrb5Extended": { + "additionalProperties": false, + "properties": { + "krb5": { + "items": { + "$ref": "#/definitions/v3ProvidersKrb5Krb5ItemExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersKrb5Item": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPN.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the Kerberos provider password.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "realm" + ], + "type": "object" + }, + "v3ProvidersKrb5Krb5Item": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the Kerberos provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPNs.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the Kerberos provider password.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "recommended_spns": { + "description": "Specifies the recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed", + "type": "boolean" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3ProvidersKrb5Krb5ItemExtended": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the Kerberos provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPNs.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "recommended_spns": { + "description": "Specifies the recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed", + "type": "boolean" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3ProvidersLdap": { + "additionalProperties": false, + "properties": { + "ldap": { + "items": { + "$ref": "#/definitions/v3ProvidersLdapLdapItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersLdapIdParams": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3ProvidersLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "required": [ + "base_dn", + "server_uris", + "name" + ], + "type": "object" + }, + "v3ProvidersLdapLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3ProvidersNis": { + "additionalProperties": false, + "properties": { + "nis": { + "items": { + "$ref": "#/definitions/v3ProvidersNisNisItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersNisItem": { + "description": "Specifies the properties for an NIS authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "If true, enables the NIS provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname_lookup": { + "description": "If true, enables host name look ups.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the NIS provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nis_domain": { + "description": "Specifies the NIS domain name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "request_timeout": { + "description": "Specifies the request timeout interval in seconds.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "retry_time": { + "description": "Specifies the timeout period in seconds after which a request will be retried.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "servers": { + "description": "Adds an NIS server for this provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ypmatch_using_tcp": { + "description": "If true, specifies TCP for YP Match operations.", + "type": "boolean" + } + }, + "required": [ + "servers", + "nis_domain", + "name" + ], + "type": "object" + }, + "v3ProvidersNisNisItem": { + "description": "Specifies the properties for an NIS authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "If true, enables the NIS provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname_lookup": { + "description": "If true, enables host name look ups.", + "type": "boolean" + }, + "id": { + "description": "Specifies the NIS provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the NIS provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nis_domain": { + "description": "Specifies the NIS domain name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "request_timeout": { + "description": "Specifies the request timeout interval in seconds.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "retry_time": { + "description": "Specifies the timeout period in seconds after which a request will be retried.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "servers": { + "description": "Adds an NIS server for this provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ypmatch_using_tcp": { + "description": "If true, specifies TCP for YP Match operations.", + "type": "boolean" + } + }, + "type": "object" + }, + "v3ProvidersSummary": { + "additionalProperties": false, + "properties": { + "provider_instances": { + "items": { + "$ref": "#/definitions/v3ProvidersSummaryProviderInstance" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ProvidersSummaryProviderInstance": { + "description": "Specifies the summary information for an authentication provider.", + "properties": { + "active_server": { + "description": "Specifies the server through which the provider serves authentication requests. Null if no server is set or is not applicable for that provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "client_site": { + "description": "The Nodes Site.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "connections": { + "items": { + "$ref": "#/definitions/v1ProvidersSummaryProviderInstanceConnection" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "dc_site": { + "description": "The DC Site.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "forest": { + "description": "Specifies the Active Directory forest. Null if not applicable.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "The groupnet the provider is in.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Indicates the status of the provider.", + "enum": [ + "offline", + "active", + "online", + "initializing", + "joining", + "disabled" + ], + "type": "string" + }, + "type": { + "description": "Specifies the type of provider.", + "enum": [ + "file", + "ldap", + "local", + "nis", + "ads", + "krb5", + "unknown" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3ReportsScans": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v3ReportsScansReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3ReportsScansExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v3ReportsScansReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ReportsScansReport": { + "additionalProperties": false, + "description": "A report for an antivirus scan.", + "properties": { + "bytes_sent": { + "description": "The number of bytes sent to the virus definition server to be scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The length of time the job ran for.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end": { + "description": "The time the job ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files": { + "description": "The number of files scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for the report.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infections": { + "description": "The number of infections found.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_id": { + "description": "The ID of the job that ran the policy. If the scan was manually run on a single file, this field will be null.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "policy_id": { + "description": "The id of the policy that this scan job executed.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "size": { + "description": "The cumulative size of the files scanned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start": { + "description": "The time the job started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "The state of the job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v3ReportsThreats": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v3ReportsThreatsReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3ReportsThreatsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v3ReportsThreatsReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ReportsThreatsReport": { + "additionalProperties": false, + "description": "A report for an antivirus threat.", + "properties": { + "file": { + "description": "The file that contained the threat.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "A unique identifier for the report.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_id": { + "description": "The id of the policy that found this threat.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "remediation": { + "description": "The action that was taken to remediate the threat.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "scan_id": { + "description": "The id of the scan report this threat is associated with.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "threat": { + "description": "A description of the threat that was found.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "time": { + "description": "The time that the threat was found, in Unix epoch seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3ResultDirectories": { + "properties": { + "attribute_count": { + "description": "User attribute count.", + "type": "integer" + }, + "begin_time": { + "description": "Unix Epoch time of start of results collection job.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_depth": { + "description": "Directory depth.", + "type": "integer" + }, + "dir_usage": { + "$ref": "#/definitions/v3ResultDirectoriesDirUsage" + }, + "path_parts": { + "description": "Directory path information from root to current directory.", + "items": { + "type": "string" + }, + "type": "array" + }, + "total_usage": { + "$ref": "#/definitions/v3ResultDirectoriesTotalUsage" + }, + "usage_data": { + "description": "Disk usage for all of immediate children of the current directory.", + "items": { + "$ref": "#/definitions/v3ResultDirectoriesUsageDataItem" + }, + "type": "array" + } + }, + "required": [ + "total_usage", + "path_parts", + "usage_data", + "attribute_count", + "dir_depth", + "begin_time", + "dir_usage" + ], + "type": "object" + }, + "v3ResultDirectoriesDirUsage": { + "description": "Disk usage by the current directory.", + "properties": { + "ads_cnt": { + "description": "Number of alternate data streams.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_cnt": { + "description": "Number of directories.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "file_cnt": { + "description": "Number of files.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "lin": { + "description": "Logical inode number.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_size_sum": { + "description": "Logical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum_overflow": { + "description": "Logical size sum of overflow in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of directory.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "other_cnt": { + "description": "Other count.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "parent": { + "description": "Parent directory inode.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size_sum": { + "description": "Physical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "type": "object" + }, + "v3ResultDirectoriesTotalUsage": { + "allOf": [ + { + "$ref": "#/definitions/v9ResultDirPoolsUsageDirUsage" + }, + { + "description": "Disk usage from root.", + "properties": { + "ads_cnt": { + "description": "Number of alternate data streams.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_cnt": { + "description": "Number of directories.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "file_cnt": { + "description": "Number of files.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "lin": { + "description": "Logical inode number.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_size_sum": { + "description": "Logical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum_overflow": { + "description": "Logical size sum of overflow in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of directory.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "other_cnt": { + "description": "Other count.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "parent": { + "description": "Parent directory inode.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size_sum": { + "description": "Physical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "required": [ + "name", + "parent", + "phys_size_sum", + "lin", + "other_cnt", + "file_cnt", + "dir_cnt", + "log_size_sum", + "log_size_sum_overflow", + "ads_cnt" + ], + "type": "object" + } + ] + }, + "v3ResultDirectoriesUsageDataItem": { + "description": "Disk usage by the named sub-directory.", + "properties": { + "ads_cnt": { + "description": "Number of alternate data streams.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_cnt": { + "description": "Number of directories.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "file_cnt": { + "description": "Number of files.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "has_subdirs": { + "description": "Defines if directory has subdirectories.", + "type": "boolean" + }, + "lin": { + "description": "Logical inode number.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_size_sum": { + "description": "Logical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum_overflow": { + "description": "Logical size sum of overflow in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of directory.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "other_cnt": { + "description": "Other count.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "parent": { + "description": "Parent directory inode.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size_sum": { + "description": "Physical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "required": [ + "name", + "parent", + "phys_size_sum", + "lin", + "other_cnt", + "has_subdirs", + "log_size_sum", + "dir_cnt", + "file_cnt", + "log_size_sum_overflow", + "ads_cnt" + ], + "type": "object" + }, + "v3ResultHistogram": { + "properties": { + "atime_enabled": { + "description": "Access time enabled.", + "type": "boolean" + }, + "attribute_count": { + "description": "User attribute count.", + "type": "integer" + }, + "begin_time": { + "description": "Unix Epoch time of start of results collection job.", + "type": "integer" + }, + "histogram": { + "description": "Histogram data of specified file count parameter.", + "items": { + "$ref": "#/definitions/v3ResultHistogramHistogramItem" + }, + "type": "array" + } + }, + "required": [ + "atime_enabled", + "histogram", + "attribute_count", + "begin_time" + ], + "type": "object" + }, + "v3ResultHistogramHistogramItem": { + "properties": { + "bucket": { + "description": "Bucket for holding file counts within a range.", + "type": "integer" + }, + "value": { + "description": "Number of files within the bucket.", + "type": "integer" + } + }, + "required": [ + "bucket", + "value" + ], + "type": "object" + }, + "v3ResultTopDirs": { + "properties": { + "change": { + "description": "Change in directory ranking from result set comparison.", + "type": "integer" + }, + "dir_atime_enabled": { + "description": "Directory access time enabled.", + "type": "boolean" + }, + "dirs": { + "description": "Directory listing.", + "items": { + "$ref": "#/definitions/v3ResultTopDirsDir" + }, + "type": "array" + }, + "top_n_max": { + "description": "Limit on number of top results.", + "type": "integer" + }, + "total_count": { + "description": "Total count of directory results.", + "type": "integer" + } + }, + "required": [ + "dirs", + "top_n_max", + "dir_atime_enabled", + "total_count" + ], + "type": "object" + }, + "v3ResultTopDirsDir": { + "properties": { + "atime": { + "description": "Directory access time", + "type": "integer" + }, + "btime": { + "description": "Directory creation begin time.", + "type": "integer" + }, + "ctime": { + "description": "Unix inode change time.", + "type": "integer" + }, + "path": { + "description": "Relative directory path under /ifs/.", + "type": "string" + } + }, + "required": [ + "btime", + "path", + "atime", + "ctime" + ], + "type": "object" + }, + "v3ResultTopFiles": { + "properties": { + "atime_enabled": { + "description": "Access time enabled.", + "type": "boolean" + }, + "change": { + "description": "Change in file ranking from result set comparison.", + "type": "integer" + }, + "dir_atime_enabled": { + "description": "Directory access time enabled.", + "type": "boolean" + }, + "files": { + "description": "Files listing.", + "items": { + "$ref": "#/definitions/v3ResultTopFilesFile" + }, + "type": "array" + }, + "top_n_max": { + "description": "Limit on number of top results.", + "type": "integer" + }, + "total_count": { + "description": "Total count of file results.", + "type": "integer" + } + }, + "required": [ + "files", + "atime_enabled", + "dir_atime_enabled", + "top_n_max", + "total_count" + ], + "type": "object" + }, + "v3ResultTopFilesFile": { + "properties": { + "atime": { + "description": "File access time.", + "type": "integer" + }, + "btime": { + "description": "File creation begin time.", + "type": "integer" + }, + "ctime": { + "description": "Unix inode change time.", + "type": "integer" + }, + "log_size": { + "description": "Logical file size in bytes.", + "type": "integer" + }, + "path": { + "description": "Relative file path under /ifs/.", + "type": "string" + }, + "phys_size": { + "description": "Physical file size in bytes.", + "type": "integer" + } + }, + "required": [ + "log_size", + "ctime", + "btime", + "phys_size", + "path", + "atime" + ], + "type": "object" + }, + "v3ResultsIdDirectories": { + "properties": { + "attribute_count": { + "description": "User attribute count.", + "type": "integer" + }, + "begin_time": { + "description": "Unix Epoch time of start of results collection job.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_depth": { + "description": "Directory depth.", + "type": "integer" + }, + "dir_usage": { + "$ref": "#/definitions/v3ResultsIdDirectoriesDirUsage" + }, + "path_parts": { + "description": "Directory path information from root to current directory.", + "items": { + "type": "string" + }, + "type": "array" + }, + "total_usage": { + "$ref": "#/definitions/v3ResultsIdDirectoriesTotalUsage" + }, + "usage_data": { + "description": "Disk usage for all of immediate children of the current directory.", + "items": { + "$ref": "#/definitions/v3ResultDirectoriesUsageDataItem" + }, + "type": "array" + } + }, + "required": [ + "total_usage", + "path_parts", + "usage_data", + "attribute_count", + "dir_depth", + "begin_time", + "dir_usage" + ], + "type": "object" + }, + "v3ResultsIdDirectoriesDirUsage": { + "description": "Disk usage by the current directory.", + "properties": { + "ads_cnt": { + "description": "Number of alternate data streams.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_cnt": { + "description": "Number of directories.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "file_cnt": { + "description": "Number of files.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "lin": { + "description": "Logical inode number.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_size_sum": { + "description": "Logical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum_overflow": { + "description": "Logical size sum of overflow in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of directory.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "other_cnt": { + "description": "Other count.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "parent": { + "description": "Parent directory inode.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size_sum": { + "description": "Physical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "type": "object" + }, + "v3ResultsIdDirectoriesTotalUsage": { + "allOf": [ + { + "$ref": "#/definitions/v3ResultDirectoriesDirUsage" + }, + { + "description": "Disk usage from root.", + "properties": { + "ads_cnt": { + "description": "Number of alternate data streams.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_cnt": { + "description": "Number of directories.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "file_cnt": { + "description": "Number of files.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "lin": { + "description": "Logical inode number.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_size_sum": { + "description": "Logical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum_overflow": { + "description": "Logical size sum of overflow in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of directory.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "other_cnt": { + "description": "Other count.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "parent": { + "description": "Parent directory inode.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size_sum": { + "description": "Physical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "required": [ + "name", + "parent", + "phys_size_sum", + "lin", + "other_cnt", + "file_cnt", + "dir_cnt", + "log_size_sum", + "log_size_sum_overflow", + "ads_cnt" + ], + "type": "object" + } + ] + }, + "v3SettingsAcls": { + "properties": { + "acl_policy_settings": { + "$ref": "#/definitions/v3SettingsAclsAclPolicySettings" + } + }, + "type": "object" + }, + "v3SettingsAclsAclPolicySettings": { + "description": "ACL policies settings.", + "properties": { + "access": { + "description": "Access checks (chmod, chown).", + "enum": [ + "unix", + "windows" + ], + "type": "string" + }, + "calcmode": { + "description": "Displayed mode bits.", + "enum": [ + "approx", + "777" + ], + "type": "string" + }, + "calcmode_group": { + "description": "Approximate group mode bits when ACL exists.", + "enum": [ + "group_aces", + "group_only" + ], + "type": "string" + }, + "calcmode_owner": { + "description": "Approximate owner mode bits when ACL exists.", + "enum": [ + "owner_aces", + "owner_only" + ], + "type": "string" + }, + "chmod": { + "description": "chmod on files with existing ACLs.", + "enum": [ + "remove", + "replace", + "replace_users_and_groups", + "merge", + "deny", + "ignore" + ], + "type": "string" + }, + "chmod_007": { + "description": "chmod (007) on files with existing ACLs.", + "enum": [ + "default", + "remove" + ], + "type": "string" + }, + "chmod_inheritable": { + "description": "ACLs created on directories by UNIX chmod.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "chown": { + "description": "chown/chgrp on files with existing ACLs.", + "enum": [ + "owner_group_and_acl", + "owner_group_only", + "ignore" + ], + "type": "string" + }, + "create_over_smb": { + "description": "ACL creation over SMB.", + "enum": [ + "allow", + "disallow" + ], + "type": "string" + }, + "dos_attr": { + "description": " Read only DOS attribute.", + "enum": [ + "deny_smb", + "deny_smb_and_nfs" + ], + "type": "string" + }, + "group_owner_inheritance": { + "description": "Group owner inheritance.", + "enum": [ + "native", + "parent", + "creator" + ], + "type": "string" + }, + "rwx": { + "description": "Treatment of 'rwx' permissions.", + "enum": [ + "retain", + "full_control" + ], + "type": "string" + }, + "synthetic_denies": { + "description": "Synthetic 'deny' ACEs.", + "enum": [ + "none", + "remove" + ], + "type": "string" + }, + "utimes": { + "description": "Access check (utimes)", + "enum": [ + "only_owner", + "owner_and_write" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3SettingsReportingEula": { + "additionalProperties": false, + "properties": { + "eula": { + "$ref": "#/definitions/v3SettingsReportingEulaEula" + } + }, + "type": "object" + }, + "v3SettingsReportingEulaEula": { + "properties": { + "accepted": { + "description": "Indicates whether the telemetry collection warning has been acknowledged", + "type": "boolean" + }, + "body": { + "description": "The body of the telemetry collection warning", + "type": "string" + } + }, + "type": "object" + }, + "v3SmbLogLevel": { + "properties": { + "level": { + "description": "Valid SMB logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3SmbLogLevelFilter": { + "properties": { + "ip_addrs": { + "description": "Array of client IP addresses to filter against.", + "items": { + "type": "string" + }, + "type": "array" + }, + "level": { + "description": "Logging level of the filter.", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "type": "string" + }, + "ops": { + "description": "Array of SMB operations to filter against.", + "items": { + "description": "Valid SMB operations to log", + "enum": [ + "read", + "write", + "session-setup", + "logoff", + "flush", + "notify", + "tree-connect", + "tree-disconnect", + "create", + "delete", + "oplock", + "locking", + "set-info", + "query", + "close", + "create-directory", + "delete-directory" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "level" + ], + "type": "object" + }, + "v3SmbLogLevelFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v3SmbLogLevelFiltersFilter" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SmbLogLevelFiltersFilter": { + "properties": { + "id": { + "description": "Unique ID of the log filter.", + "type": "integer" + }, + "ip_addrs": { + "description": "Array of client IP addresses to filter against.", + "items": { + "type": "string" + }, + "type": "array" + }, + "level": { + "description": "Logging level of the filter.", + "enum": [ + "ALWAYS", + "ERROR", + "WARNING", + "INFO", + "VERBOSE", + "DEBUG", + "TRACE", + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "type": "string" + }, + "ops": { + "description": "Array of SMB operations to filter against.", + "items": { + "description": "Valid SMB operations to log", + "enum": [ + "read", + "write", + "session-setup", + "logoff", + "flush", + "notify", + "tree-connect", + "tree-disconnect", + "create", + "delete", + "oplock", + "locking", + "set-info", + "query", + "close", + "create-directory", + "delete-directory" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "level" + ], + "type": "object" + }, + "v3SmbSettingsGlobal": { + "properties": { + "settings": { + "$ref": "#/definitions/v3SmbSettingsGlobalSettings" + } + }, + "type": "object" + }, + "v3SmbSettingsGlobalSettings": { + "properties": { + "access_based_share_enum": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "audit_fileshare": { + "description": "Specify level of file share audit events to log.", + "enum": [ + "all", + "success", + "failure", + "none" + ], + "type": "string" + }, + "audit_logon": { + "description": "Specify the level of logon audit events to log.", + "enum": [ + "all", + "success", + "failure", + "none" + ], + "type": "string" + }, + "dot_snap_accessible_child": { + "description": "Allow access to .snapshot directories in share subdirectories.", + "type": "boolean" + }, + "dot_snap_accessible_root": { + "description": "Allow access to the .snapshot directory in the root of the share.", + "type": "boolean" + }, + "dot_snap_visible_child": { + "description": "Show .snapshot directories in share subdirectories.", + "type": "boolean" + }, + "dot_snap_visible_root": { + "description": "Show the .snapshot directory in the root of a share.", + "type": "boolean" + }, + "enable_security_signatures": { + "description": "Indicates whether the server supports signed SMB packets.", + "type": "boolean" + }, + "guest_user": { + "description": "Specifies the fully-qualified user to use for guest access.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ignore_eas": { + "description": "Specify whether to ignore EAs on files.", + "type": "boolean" + }, + "onefs_cpu_multiplier": { + "description": "Specify the number of OneFS driver worker threads per CPU.", + "maximum": 4, + "minimum": 1, + "type": "integer" + }, + "onefs_num_workers": { + "description": "Set the maximum number of OneFS driver worker threads.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "require_security_signatures": { + "description": "Indicates whether the server requires signed SMB packets.", + "type": "boolean" + }, + "server_side_copy": { + "description": "Enable Server Side Copy.", + "type": "boolean" + }, + "server_string": { + "description": "Provides a description of the server.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "service": { + "description": "Specify whether service is enabled.", + "type": "boolean" + }, + "srv_cpu_multiplier": { + "description": "Specify the number of SRV service worker threads per CPU.", + "maximum": 8, + "minimum": 1, + "type": "integer" + }, + "srv_num_workers": { + "description": "Set the maximum number of SRV service worker threads.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "support_multichannel": { + "description": "Support multichannel.", + "type": "boolean" + }, + "support_netbios": { + "description": "Support NetBIOS.", + "type": "boolean" + }, + "support_smb2": { + "description": "Support the SMB2 protocol on the server.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_GLOBAL" + }, + "v3SmbSettingsShare": { + "properties": { + "settings": { + "$ref": "#/definitions/v3SmbSettingsShareSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v3SmbSettingsShareSettings": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Specify level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Set the create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "directory_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on the share.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Allow oplock requests.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone in which to update settings", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_SHARE" + }, + "v3SmbShare": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_path": { + "description": "Create path if does not exist.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "v3SmbShareExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Share ID.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zid": { + "description": "Numeric ID of the access zone which contains this SMB share", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "path", + "id", + "zid", + "name" + ], + "type": "object" + }, + "v3SmbShareExtendedExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v3SmbShares": { + "additionalProperties": false, + "properties": { + "digest": { + "description": "An identifier for a set of shares.", + "type": "string" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "shares": { + "items": { + "$ref": "#/definitions/v3SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v3SmbSharesExtended": { + "additionalProperties": false, + "properties": { + "shares": { + "items": { + "$ref": "#/definitions/v3SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v3SnmpSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3SnmpSettingsSettings" + } + }, + "type": "object" + }, + "v3SnmpSettingsExtended": { + "description": "SNMP settings.", + "properties": { + "read_only_community": { + "description": "The read-only community name. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "service": { + "description": "Whether the SNMP service is enabled.", + "type": "boolean" + }, + "snmp_v1_v2c_access": { + "description": "Whether SNMP v1 and v2c protocols are enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_access": { + "description": "Whether SNMP v3 is enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_password": { + "description": "This field allows a client to change the SNMP v3 authentication password. There is always a password set. @DEFAULT reverts this field to its default value.", + "maxLength": 39, + "minLength": 8, + "type": "string" + }, + "snmp_v3_read_only_user": { + "description": "The read-only user for SNMP v3 read requests. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "system_contact": { + "description": "Contact information for the system owner. This must be a valid email address. @DEFAULT reverts this field to its default value.", + "maxLength": 254, + "minLength": 3, + "pattern": "[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}", + "type": "string" + }, + "system_location": { + "description": "A location name for the SNMP system. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v3SnmpSettingsSettings": { + "description": "SNMP settings.", + "properties": { + "read_only_community": { + "description": "The read-only community name. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "service": { + "description": "Whether the SNMP service is enabled.", + "type": "boolean" + }, + "snmp_v1_v2c_access": { + "description": "Whether SNMP v1 and v2c protocols are enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_access": { + "description": "Whether SNMP v3 is enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_read_only_user": { + "description": "The read-only user for SNMP v3 read requests. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "system_contact": { + "description": "Contact information for the system owner. This must be a valid email address. @DEFAULT reverts this field to its default value.", + "maxLength": 254, + "minLength": 3, + "pattern": "[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}", + "type": "string" + }, + "system_location": { + "description": "A location name for the SNMP system. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v3StatisticsOperation": { + "properties": { + "operation": { + "description": "The name of the operation.", + "type": "string" + } + }, + "required": [ + "operation" + ], + "type": "object" + }, + "v3StatisticsOperations": { + "additionalProperties": false, + "properties": { + "operations": { + "items": { + "$ref": "#/definitions/v3StatisticsOperation" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3StoragepoolNodepool": { + "properties": { + "can_disable_l3": { + "description": "Indicates if disabling L3 is possible.", + "type": "boolean" + }, + "can_enable_l3": { + "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives.", + "type": "boolean" + }, + "health_flags": { + "description": "An array of containing any health issues with this pool. If the pool is healthy, the list is empty.", + "items": { + "enum": [ + "underprovisioned", + "missing_drives", + "devices_down", + "devices_smartfailed", + "waiting_repair" + ], + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "The system ID given to the node pool.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "l3_status": { + "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", + "enum": [ + "l3", + "storage", + "migrating" + ], + "type": "string" + }, + "lnns": { + "description": "The nodes that are part of this node pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "manual": { + "description": "Whether or not the node pool is manually managed.", + "type": "boolean" + }, + "name": { + "description": "The node pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "protection_policy": { + "description": "The underlying protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "tier": { + "description": "The name (if named) or system ID of the node pool's tier, if it is in a tier. Otherwise null.", + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v1StoragepoolNodepoolUsage" + } + }, + "required": [ + "name", + "lnns", + "l3_status", + "manual", + "can_enable_l3", + "l3", + "can_disable_l3", + "tier", + "id" + ], + "type": "object" + }, + "v3StoragepoolNodepools": { + "additionalProperties": false, + "properties": { + "nodepools": { + "items": { + "$ref": "#/definitions/v3StoragepoolNodepool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3StoragepoolNodepoolsExtended": { + "additionalProperties": false, + "properties": { + "nodepools": { + "items": { + "$ref": "#/definitions/v3StoragepoolNodepool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3StoragepoolStoragepool": { + "properties": { + "can_disable_l3": { + "description": "Indicates if disabling L3 is possible.", + "type": "boolean" + }, + "can_enable_l3": { + "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives.", + "type": "boolean" + }, + "children": { + "description": "The names or IDs of the pool's children.", + "items": { + "type": "string" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "health_flags": { + "description": "An array of containing any health issues with this pool. If the pool is healthy, the list is empty. Only appears on 'nodepool' type storagepools.", + "items": { + "enum": [ + "underprovisioned", + "missing_drives", + "devices_down", + "devices_smartfailed", + "waiting_repair" + ], + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "The system ID given to the pool.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "l3_status": { + "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", + "enum": [ + "l3", + "storage", + "migrating" + ], + "type": "string" + }, + "lnns": { + "description": "The nodes that are part of this pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "manual": { + "description": "Whether or not the node pool is manually managed.", + "type": "boolean" + }, + "name": { + "description": "The pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "protection_policy": { + "description": "The underlying protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The pool type.", + "enum": [ + "tier", + "nodepool" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v1StoragepoolNodepoolUsage" + } + }, + "required": [ + "name", + "lnns", + "type", + "id" + ], + "type": "object" + }, + "v3StoragepoolStoragepools": { + "additionalProperties": false, + "properties": { + "storagepools": { + "items": { + "$ref": "#/definitions/v3StoragepoolStoragepool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_POOLDETAILS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3StoragepoolSuggestedProtection": { + "properties": { + "suggested_protection": { + "description": "The suggested protection policy.", + "type": "string" + } + }, + "type": "object" + }, + "v3SubnetsSubnetPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v3SubnetsSubnetPools": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v3SubnetsSubnetPoolsPool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3SubnetsSubnetPoolsPool": { + "properties": { + "access_zone": { + "description": "Name of a valid access zone to map IP address pool to the zone.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "aggregation_mode": { + "description": "OneFS supports the following NIC aggregation modes.", + "enum": [ + "roundrobin", + "failover", + "lacp", + "fec" + ], + "type": "string" + }, + "alloc_method": { + "description": "Specifies how IP address allocation is done among pool members.", + "enum": [ + "dynamic", + "static" + ], + "type": "string" + }, + "description": { + "description": "A description of the pool.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Name of the groupnet this pool belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique Pool ID.", + "maxLength": 99, + "minLength": 1, + "type": "string" + }, + "ifaces": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolIface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "ranges": { + "description": "List of IP address ranges in this pool.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "rebalance_policy": { + "description": "Rebalance policy..", + "enum": [ + "auto", + "manual" + ], + "type": "string" + }, + "rules": { + "description": "Names of the rules in this pool.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "sc_auto_unsuspend_delay": { + "description": "Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "sc_connect_policy": { + "description": "SmartConnect client connection balancing policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_dns_zone": { + "description": "SmartConnect zone name for the pool.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "sc_dns_zone_aliases": { + "description": "List of SmartConnect zone aliases (DNS names) to the pool.", + "items": { + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_failover_policy": { + "description": "SmartConnect IP failover policy.", + "enum": [ + "round_robin", + "conn_count", + "throughput", + "cpu_usage" + ], + "type": "string" + }, + "sc_subnet": { + "description": "Name of SmartConnect service subnet for this pool.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "sc_suspended_nodes": { + "description": "List of LNNs showing currently suspended nodes in SmartConnect.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "sc_ttl": { + "description": "Time to live value for SmartConnect DNS query responses in seconds.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "static_routes": { + "description": "List of interface members in this pool.", + "items": { + "$ref": "#/definitions/v12SubnetsSubnetPoolStaticRoute" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "subnet": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ifaces", + "aggregation_mode", + "sc_failover_policy", + "sc_subnet", + "sc_suspended_nodes", + "id", + "subnet", + "rebalance_policy", + "sc_connect_policy", + "groupnet", + "description", + "rules", + "access_zone", + "alloc_method", + "ranges", + "sc_dns_zone_aliases", + "sc_dns_zone", + "name", + "static_routes", + "sc_ttl", + "addr_family", + "sc_auto_unsuspend_delay" + ], + "type": "object" + }, + "v3SummaryClient": { + "additionalProperties": false, + "properties": { + "client": { + "items": { + "$ref": "#/definitions/v3SummaryClientClientItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SummaryClientClientItem": { + "properties": { + "class": { + "description": "The class of the operation.", + "type": "string" + }, + "in": { + "description": "Rate of input (in bytes/second) for an operation since the last time isi statistics collected the data.", + "type": "number" + }, + "in_avg": { + "description": "Average input (received) bytes for an operation, in bytes.", + "type": "number" + }, + "in_max": { + "description": "Maximum input (received) bytes for an operation, in bytes.", + "type": "number" + }, + "in_min": { + "description": "Minimum input (received) bytes for an operation, in bytes.", + "type": "number" + }, + "local_addr": { + "description": "The IP address (in dotted-quad form) of the host receiving the operation request.", + "type": "string" + }, + "local_name": { + "description": "The resolved text name of the LocalAddr, if resolution can be performed.", + "type": "string" + }, + "node": { + "description": "The node on which the operation was performed.", + "type": "integer" + }, + "num_operations": { + "description": "The number of times an operation has been performed.", + "type": "integer" + }, + "operation_rate": { + "description": "The rate (in ops/second) at which an operation has been performed.", + "type": "number" + }, + "out": { + "description": "Rate of output (in bytes/second) for an operation since the last time isi statistics collected the data.", + "type": "number" + }, + "out_avg": { + "description": "Average output (sent) bytes for an operation, in bytes.", + "type": "number" + }, + "out_max": { + "description": "Maximum output (sent) bytes for an operation, in bytes.", + "type": "number" + }, + "out_min": { + "description": "Minimum output (sent) bytes for an operation, in bytes.", + "type": "number" + }, + "protocol": { + "description": "The protocol of the operation.", + "type": "string" + }, + "remote_addr": { + "description": "The IP address (in dotted-quad form) of the host sending the operation request.", + "type": "string" + }, + "remote_name": { + "description": "The resolved text name of the RemoteAddr, if resolution can be performed.", + "type": "string" + }, + "time": { + "description": "Unix Epoch time in seconds of the request.", + "type": "integer" + }, + "time_avg": { + "description": "The average elapsed time (in microseconds) taken to complete an operation.", + "type": "number" + }, + "time_max": { + "description": "The maximum elapsed time (in microseconds) taken to complete an operation.", + "type": "number" + }, + "time_min": { + "description": "The minimum elapsed time (in microseconds) taken to complete an operation.", + "type": "number" + }, + "user": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + "required": [ + "out_avg", + "protocol", + "num_operations", + "in", + "out", + "time_avg", + "time_max", + "remote_addr", + "local_addr", + "in_avg", + "node", + "in_min", + "local_name", + "out_min", + "time_min", + "remote_name", + "class", + "in_max", + "operation_rate", + "out_max", + "time" + ], + "type": "object" + }, + "v3SummaryDrive": { + "additionalProperties": false, + "properties": { + "drive": { + "items": { + "$ref": "#/definitions/v3SummaryDriveDriveItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SummaryDriveDriveItem": { + "properties": { + "access_latency": { + "description": "The average operation latency.", + "type": "number" + }, + "access_slow": { + "description": "The rate of slow (long-latency) operations.", + "type": "number" + }, + "busy": { + "description": "The percentage of time the drive was busy.", + "type": "number" + }, + "bytes_in": { + "description": "The rate of bytes written.", + "type": "number" + }, + "bytes_out": { + "description": "The rate of bytes read.", + "type": "number" + }, + "drive_id": { + "description": "Drive ID LNN:bay.", + "type": "string" + }, + "iosched_latency": { + "description": "The average time spent in the I/O scheduler.", + "type": "number" + }, + "iosched_queue": { + "description": "The average length of the I/O scheduler queue.", + "type": "number" + }, + "time": { + "description": "Unix Epoch time in seconds of the request.", + "type": "integer" + }, + "type": { + "description": "The type of the drive.", + "type": "string" + }, + "used_bytes_percent": { + "description": "The percent of blocks used on the drive.", + "type": "number" + }, + "used_inodes": { + "description": "The number of inodes allocated on the drive.", + "type": "number" + }, + "xfer_size_in": { + "description": "The average size of write operations.", + "type": "number" + }, + "xfer_size_out": { + "description": "The average size of read operations.", + "type": "number" + }, + "xfers_in": { + "description": "The rate of write operations.", + "type": "number" + }, + "xfers_out": { + "description": "The rate of read operations.", + "type": "number" + } + }, + "required": [ + "xfer_size_in", + "access_latency", + "xfers_in", + "iosched_latency", + "bytes_in", + "time", + "iosched_queue", + "access_slow", + "xfers_out", + "busy", + "used_inodes", + "bytes_out", + "drive_id", + "xfer_size_out", + "type", + "used_bytes_percent" + ], + "type": "object" + }, + "v3SummaryHeat": { + "additionalProperties": false, + "properties": { + "heat": { + "items": { + "$ref": "#/definitions/v3SummaryHeatHeatItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SummaryHeatHeatItem": { + "properties": { + "class_name": { + "description": "The class of operation", + "type": "string" + }, + "event_name": { + "description": "The type of event", + "type": "string" + }, + "event_type": { + "description": "The event type id", + "type": "integer" + }, + "lin": { + "description": "Logical inode (LIN)", + "type": "string" + }, + "node": { + "description": "The node where this event occurred.", + "type": "integer" + }, + "operation_rate": { + "description": "Approximate operations per second for this lin.", + "type": "number" + }, + "path": { + "description": "Canonical LIN path if known", + "type": "string" + }, + "time": { + "description": "Unix Epoch time in seconds of the request.", + "type": "integer" + } + }, + "required": [ + "node", + "event_type", + "class_name", + "lin", + "operation_rate", + "event_name", + "time", + "path" + ], + "type": "object" + }, + "v3SummaryProtocol": { + "additionalProperties": false, + "properties": { + "protocol": { + "items": { + "$ref": "#/definitions/v3SummaryProtocolProtocolItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SummaryProtocolProtocolItem": { + "properties": { + "class": { + "description": "The class of the operation.", + "type": "string" + }, + "in": { + "description": "Rate of input (in bytes/second) for an operation since the last time isi statistics collected the data.", + "type": "number" + }, + "in_avg": { + "description": "Average input (received) bytes for an operation, in bytes.", + "type": "number" + }, + "in_max": { + "description": "Maximum input (received) bytes for an operation, in bytes.", + "type": "number" + }, + "in_min": { + "description": "Minimum input (received) bytes for an operation, in bytes.", + "type": "number" + }, + "in_standard_dev": { + "description": "Standard deviation for input (received) bytes for an operation, in bytes.", + "type": "number" + }, + "node": { + "description": "The node on which the operation was performed.", + "type": "integer" + }, + "operation": { + "description": "The operation performed.", + "type": "string" + }, + "operation_count": { + "description": "The number of times an operation has been performed.", + "type": "integer" + }, + "operation_rate": { + "description": "The rate (in ops/second) at which an operation has been performed.", + "type": "number" + }, + "out": { + "description": "Rate of output (in bytes/second) for an operation since the last time isi statistics collected the data.", + "type": "number" + }, + "out_avg": { + "description": "Average output (sent) bytes for an operation, in bytes.", + "type": "number" + }, + "out_max": { + "description": "Maximum output (sent) bytes for an operation, in bytes.", + "type": "number" + }, + "out_min": { + "description": "Minimum output (sent) bytes for an operation, in bytes.", + "type": "number" + }, + "out_standard_dev": { + "description": "Standard deviation for output (received) bytes for an operation, in bytes.", + "type": "number" + }, + "protocol": { + "description": "The protocol of the operation.", + "type": "string" + }, + "time": { + "description": "Unix Epoch time in seconds of the request.", + "type": "integer" + }, + "time_avg": { + "description": "The average elapsed time (in microseconds) taken to complete an operation.", + "type": "number" + }, + "time_max": { + "description": "The maximum elapsed time (in microseconds) taken to complete an operation.", + "type": "number" + }, + "time_min": { + "description": "The minimum elapsed time (in microseconds) taken to complete an operation.", + "type": "number" + }, + "time_standard_dev": { + "description": "The standard deviation time (in microseconds) taken to complete an operation.", + "type": "number" + } + }, + "required": [ + "node", + "in_min", + "protocol", + "time_min", + "time_avg", + "time_standard_dev", + "time", + "in_max", + "out_avg", + "operation_rate", + "out_max", + "out_standard_dev", + "out_min", + "in", + "in_standard_dev", + "time_max", + "operation", + "operation_count", + "class", + "in_avg", + "out" + ], + "type": "object" + }, + "v3SummaryProtocolStats": { + "additionalProperties": false, + "properties": { + "protocol-stats": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-Stats" + } + }, + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-Stats": { + "additionalProperties": false, + "properties": { + "cpu": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsCpu" + }, + "disk": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsDisk" + }, + "network": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsNetwork" + }, + "onefs": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsOnefs" + }, + "protocol": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsProtocol" + }, + "time": { + "description": "Unix Epoch time in seconds of the request.", + "type": "integer" + } + }, + "required": [ + "time" + ], + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsCpu": { + "properties": { + "idle": { + "description": "Percentage of CPU idle time", + "type": "number" + }, + "system": { + "description": "Percentage of CPU consumed by the system", + "type": "number" + }, + "user": { + "description": "Percentage of CPU consumed by user activities", + "type": "number" + } + }, + "required": [ + "idle", + "system", + "user" + ], + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsDisk": { + "properties": { + "iops": { + "description": "Disk iops", + "type": "number" + }, + "read": { + "description": "Disk reads", + "type": "number" + }, + "write": { + "description": "Disk writes", + "type": "number" + } + }, + "required": [ + "read", + "write", + "iops" + ], + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsNetwork": { + "properties": { + "in": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsNetworkIn" + }, + "out": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsNetworkOut" + } + }, + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsNetworkIn": { + "properties": { + "errors_per_sec": { + "description": "Network input errors per-second", + "type": "number" + }, + "megabytes_per_sec": { + "description": "Network input megabytes per-second", + "type": "number" + }, + "packets_per_sec": { + "description": "Network input packets per-second", + "type": "number" + } + }, + "required": [ + "errors_per_sec", + "megabytes_per_sec", + "packets_per_sec" + ], + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsNetworkOut": { + "properties": { + "errors_per_sec": { + "description": "Network output errors per-second", + "type": "number" + }, + "megabytes_per_sec": { + "description": "Network output megabytes per-second", + "type": "number" + }, + "packets_per_sec": { + "description": "Network output packets per-second", + "type": "number" + } + }, + "required": [ + "errors_per_sec", + "megabytes_per_sec", + "packets_per_sec" + ], + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsOnefs": { + "properties": { + "in": { + "description": "OneFS throughput in MB/s in.", + "type": "number" + }, + "out": { + "description": "OneFS throughput in MB/s out.", + "type": "number" + }, + "total": { + "description": "OneFS throughput in MB/s total.", + "type": "number" + } + }, + "required": [ + "total", + "out", + "in" + ], + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsProtocol": { + "description": "A single protocol for which statistics should be reported.", + "properties": { + "data": { + "items": { + "$ref": "#/definitions/v3SummaryProtocolStatsProtocol-StatsProtocolDataItem" + }, + "type": "array" + }, + "name": { + "description": "The name of the protocol.", + "type": "string" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "v3SummaryProtocolStatsProtocol-StatsProtocolDataItem": { + "properties": { + "name": { + "description": "The name of the protocol operation.", + "type": "string" + }, + "value": { + "description": "Protocol specific operations per second. This is a variable number of output fields depending on the protocol being displayed.", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "v3SummarySystem": { + "additionalProperties": false, + "properties": { + "system": { + "items": { + "$ref": "#/definitions/v3SummarySystemSystemItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SummarySystemSystemItem": { + "properties": { + "cpu": { + "description": "The percentage CPU utilization.", + "type": "number" + }, + "disk_in": { + "description": "Traffic to disk (in bytes/sec).", + "type": "number" + }, + "disk_out": { + "description": "Traffic from disk (in bytes/sec).", + "type": "number" + }, + "ftp": { + "description": "The total throughput (in bytes/sec) for FTP operations.", + "type": "number" + }, + "hdfs": { + "description": "The total throughput (in bytes/second) for HDFS operations.", + "type": "number" + }, + "http": { + "description": "The total throughput (in bytes/sec) for HTTP operations.", + "type": "number" + }, + "net_in": { + "description": "Incoming network traffic (in bytes/sec) for all operations.", + "type": "number" + }, + "net_out": { + "description": "Outgoing network traffic (in bytes/sec) for all operations.", + "type": "number" + }, + "nfs": { + "description": "The total throughput (in bytes/sec) for NFS (NFS3 & NFS4) operations.", + "type": "number" + }, + "node": { + "description": "Node ID/LNN, 'All' for cluster.", + "type": "string" + }, + "s3": { + "description": "The total throughput (in bytes/second) for S3 operations.", + "type": "number" + }, + "smb": { + "description": "The total throughput (in bytes/sec) for SMB (SMB1 & SMB2) operations.", + "type": "number" + }, + "time": { + "description": "Unix Epoch time in seconds of the request.", + "type": "integer" + }, + "total": { + "description": "The total throughput (in bytes/sec) for all protocols listed.", + "type": "number" + } + }, + "required": [ + "node", + "ftp", + "http", + "hdfs", + "s3", + "net_out", + "smb", + "nfs", + "time", + "disk_out", + "net_in", + "disk_in", + "total", + "cpu" + ], + "type": "object" + }, + "v3SwiftAccount": { + "description": "This is an account for the Swift protocol.", + "properties": { + "id": { + "description": "Unique id of swift account", + "type": "string" + }, + "name": { + "description": "Name of Swift account", + "type": "string" + }, + "swiftgroup": { + "description": "Group with filesystem ownership of this account", + "type": "string" + }, + "swiftuser": { + "description": "User with filesystem ownership of this account", + "type": "string" + }, + "users": { + "description": "Users who are allowed to access Swift account", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone": { + "description": "Name of access zone for account", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v3SwiftAccountExtended": { + "description": "This is an account for the Swift protocol.", + "properties": { + "id": { + "description": "Unique id of swift account", + "type": "string" + }, + "name": { + "description": "Name of Swift account", + "type": "string" + }, + "path": { + "description": "Path to root of Swift account", + "type": "string" + }, + "swiftgroup": { + "description": "Group with filesystem ownership of this account", + "type": "string" + }, + "swiftuser": { + "description": "User with filesystem ownership of this account", + "type": "string" + }, + "users": { + "description": "Users who are allowed to access Swift account", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone": { + "description": "Name of access zone for account", + "type": "string" + } + }, + "type": "object" + }, + "v3SwiftAccounts": { + "additionalProperties": false, + "properties": { + "accounts": { + "items": { + "$ref": "#/definitions/v3SwiftAccountExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3SwiftAccountsExtended": { + "additionalProperties": false, + "properties": { + "accounts": { + "items": { + "$ref": "#/definitions/v3SwiftAccountExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SyncJob": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "workers": { + "description": "A list of workers for this job.", + "items": { + "$ref": "#/definitions/v15SyncJobWorker" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "workers", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v3SyncJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v3SyncJob" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_JOBS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3SyncJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v3SyncJob" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SyncPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v3SyncPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_POLICIES" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3SyncPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v3SyncPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SyncPolicy": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "target_host", + "name", + "target_path", + "action" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_POLICIES" + }, + "v3SyncPolicyExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "password_set": { + "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET.", + "type": "boolean" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "last_success", + "id", + "target_host", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v3SyncPolicyExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "enum": [ + false + ], + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v3SyncRule": { + "description": "A rule limiting the bandwidth, file operations, cpu usage, or worker count for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + }, + "type": { + "description": "The type of system resource this rule limits.", + "enum": [ + "bandwidth", + "file_count", + "cpu", + "worker" + ], + "type": "string" + } + }, + "required": [ + "limit", + "type" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_RULES" + }, + "v3SyncRuleExtended": { + "description": "A rule limiting the bandwidth, file operations, cpu usage, or worker count for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this performance rule.", + "type": "string" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + }, + "type": { + "description": "The type of system resource this rule limits.", + "enum": [ + "bandwidth", + "file_count", + "cpu", + "worker" + ], + "type": "string" + } + }, + "type": "object" + }, + "v3SyncRuleExtendedExtended": { + "description": "A rule limiting the bandwidth, file operations, cpu usage, or worker count for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + } + }, + "type": "object" + }, + "v3SyncRuleExtendedExtendedExtended": { + "allOf": [ + { + "$ref": "#/definitions/v3SyncRuleExtended" + }, + { + "description": "A rule limiting the bandwidth, file operations, cpu usage, or worker count for all sync jobs on this cluster.", + "properties": { + "description": { + "description": "User-entered description of this performance rule.", + "type": "string" + }, + "enabled": { + "description": "Whether this performance rule is currently in effect during its specified intervals.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this performance rule.", + "type": "string" + }, + "limit": { + "description": "Amount the specified system resource type is limited by this rule. Units are kb/s for bandwidth, files/s for file-count, processing percentage used for cpu, or percentage of maximum available workers.", + "type": "integer" + }, + "schedule": { + "$ref": "#/definitions/v1SyncRuleSchedule" + }, + "type": { + "description": "The type of system resource this rule limits.", + "enum": [ + "bandwidth", + "file_count", + "cpu", + "worker" + ], + "type": "string" + } + }, + "required": [ + "description", + "schedule", + "enabled", + "limit", + "type", + "id" + ], + "type": "object" + } + ] + }, + "v3SyncRules": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "rules": { + "items": { + "$ref": "#/definitions/v3SyncRuleExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_RULES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "rules", + "total", + "resume" + ], + "type": "object" + }, + "v3SyncRulesExtended": { + "additionalProperties": false, + "properties": { + "rules": { + "items": { + "$ref": "#/definitions/v3SyncRuleExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3SyncSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3SyncSettingsSettings" + } + }, + "type": "object" + }, + "v3SyncSettingsExtended": { + "description": "Global SyncIQ settings.", + "properties": { + "burst_memory_constraint": { + "description": "The per-worker burst socket memory constraint, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "burst_socket_buffer_size": { + "description": "The per-worker burst socket buffer coalesced data, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "rpo_alerts": { + "description": "If disabled, no RPO alerts will be generated.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_RPO_ALERTS" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS" + }, + "v3SyncSettingsSettings": { + "description": "Global SyncIQ settings.", + "properties": { + "burst_memory_constraint": { + "description": "The per-worker burst socket memory constraint, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "burst_socket_buffer_size": { + "description": "The per-worker burst socket buffer coalesced data, in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "max_concurrent_jobs": { + "description": "The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.", + "maximum": 1000, + "minimum": 0, + "type": "integer" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "rpo_alerts": { + "description": "If disabled, no RPO alerts will be generated.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_RPO_ALERTS" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS" + }, + "v3TimezoneRegion": { + "description": "A geographical region that can contain timezones.", + "properties": { + "comments": { + "description": "Clarifying comments on the region or timezone.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the timezone region.", + "type": "string" + }, + "region": { + "description": "The name of the region.", + "type": "string" + }, + "timezone": { + "$ref": "#/definitions/v3TimezoneRegionTimezone" + } + }, + "type": "object" + }, + "v3TimezoneRegionTimezone": { + "description": "The single timezone that this region contains. This field will be null if the region contains more than one timezone.", + "properties": { + "abbreviation": { + "description": "The abbreviation for this timezone.", + "type": "string" + }, + "path": { + "description": "The timezone path. This is the unique identifier for the timezone.", + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object" + }, + "v3TimezoneRegions": { + "additionalProperties": false, + "properties": { + "regions": { + "items": { + "$ref": "#/definitions/v3TimezoneRegion" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v3TimezoneSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v3TimezoneRegionTimezone" + } + }, + "type": "object" + }, + "v3UpgradeCluster": { + "description": "Cluster wide upgrade status info.", + "properties": { + "cluster_overview": { + "$ref": "#/definitions/v12UpgradeClusterClusterOverview" + }, + "cluster_state": { + "description": "The different states of an upgrade, rollback, or assessment. One of the following values: 'committed', 'upgraded', 'partially upgraded', 'upgrading', 'rolling back', 'assessing', 'error'", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "current_process": { + "description": "The current upgrade activity.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "finish_time": { + "description": "The time when a rollback, assessment or upgrade has finished completely. Use ISO 8601 standard. Null if the cluster_state is not 'upgraded'.", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs. Null if the cluster_state is 'committed' or 'upgraded.'", + "maxLength": 4096, + "minLength": 5, + "type": "string" + }, + "onefs_version_current": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "onefs_version_upgrade": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "patch_action": { + "description": "The most recent patch action performed.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "patch_name": { + "description": "The patch with the most recent patch action.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "start_time": { + "description": "The time when an upgrade, rollback, or assessment was started. Use ISO 8601 standard. Null if the cluster_state is 'committed' or 'partially upgraded.'", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "upgrade_is_committed": { + "description": "True if upgrade is committed.", + "type": "boolean" + }, + "upgrade_settings": { + "$ref": "#/definitions/v12UpgradeClusterUpgradeSettings" + }, + "upgrade_triggered_time": { + "description": "Time at which upgrade was originally requested.", + "maxLength": 128, + "minLength": 4, + "type": "string" + } + }, + "type": "object" + }, + "v3UserChangePassword": { + "description": "Change Password Request", + "properties": { + "new_password": { + "description": "Specifies user's new password", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "old_password": { + "description": "User's expired password", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "new_password", + "old_password" + ], + "type": "object" + }, + "v3UserMemberOf": { + "additionalProperties": false, + "properties": { + "member_of": { + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3Zone": { + "description": "Specifies properties for access zones.", + "properties": { + "alternate_system_provider": { + "description": "Specifies an alternate system provider.", + "type": "string" + }, + "auth_providers": { + "description": "Specifies the list of authentication providers available on this access zone.", + "items": { + "type": "string" + }, + "type": "array" + }, + "cache_entry_expiry": { + "description": "Specifies amount of time in seconds to cache a user/group.", + "type": "integer" + }, + "create_path": { + "description": "Determines if a path is created when a path does not exist.", + "type": "boolean" + }, + "force_overlap": { + "description": "Allow for overlapping base path.", + "type": "boolean" + }, + "groupnet": { + "description": "Groupnet identifier", + "type": "string" + }, + "home_directory_umask": { + "description": "Specifies the permissions set on automatically created user home directories.", + "type": "integer" + }, + "ifs_restricted": { + "description": "Specifies a list of users and groups that have read and write access to /ifs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "map_untrusted": { + "description": "Maps untrusted domains to this NetBIOS domain during authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the access zone name.", + "type": "string" + }, + "negative_cache_entry_expiry": { + "description": "Specifies number of seconds the negative cache entry is valid.", + "type": "integer" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name.", + "type": "string" + }, + "path": { + "description": "Specifies the access zone base directory path.", + "type": "string" + }, + "skeleton_directory": { + "description": "Specifies the skeleton directory that is used for user home directories.", + "type": "string" + }, + "system_provider": { + "description": "Specifies the system provider for the access zone.", + "type": "string" + }, + "user_mapping_rules": { + "description": "Specifies the current ID mapping rules.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "v3ZoneExtended": { + "description": "Specifies properties for access zones.", + "properties": { + "alternate_system_provider": { + "description": "Specifies an alternate system provider.", + "type": "string" + }, + "auth_providers": { + "description": "Specifies the list of authentication providers available on this access zone.", + "items": { + "type": "string" + }, + "type": "array" + }, + "cache_entry_expiry": { + "description": "Specifies amount of time in seconds to cache a user/group.", + "type": "integer" + }, + "create_path": { + "description": "Determines if a path is created when a path does not exist.", + "type": "boolean" + }, + "groupnet": { + "description": "Groupnet identifier", + "type": "string" + }, + "home_directory_umask": { + "description": "Specifies the permissions set on automatically created user home directories.", + "type": "integer" + }, + "id": { + "description": "Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method", + "type": "string" + }, + "ifs_restricted": { + "description": "Specifies a list of users and groups that have read and write access to /ifs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "map_untrusted": { + "description": "Maps untrusted domains to this NetBIOS domain during authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the access zone name.", + "type": "string" + }, + "negative_cache_entry_expiry": { + "description": "Specifies number of seconds the negative cache entry is valid.", + "type": "integer" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name.", + "type": "string" + }, + "path": { + "description": "Specifies the access zone base directory path.", + "type": "string" + }, + "skeleton_directory": { + "description": "Specifies the skeleton directory that is used for user home directories.", + "type": "string" + }, + "system": { + "description": "True if the access zone is built-in.", + "type": "boolean" + }, + "system_provider": { + "description": "Specifies the system provider for the access zone.", + "type": "string" + }, + "user_mapping_rules": { + "description": "Specifies the current ID mapping rules.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_id": { + "description": "Specifies the access zone ID on the system.", + "type": "integer" + } + }, + "type": "object" + }, + "v3ZoneExtendedExtended": { + "description": "Specifies properties for access zones.", + "properties": { + "alternate_system_provider": { + "description": "Specifies an alternate system provider.", + "type": "string" + }, + "auth_providers": { + "description": "Specifies the list of authentication providers available on this access zone.", + "items": { + "type": "string" + }, + "type": "array" + }, + "cache_entry_expiry": { + "description": "Specifies amount of time in seconds to cache a user/group.", + "type": "integer" + }, + "create_path": { + "description": "Determines if a path is created when a path does not exist.", + "type": "boolean" + }, + "force_overlap": { + "description": "Allow for overlapping base path.", + "type": "boolean" + }, + "home_directory_umask": { + "description": "Specifies the permissions set on automatically created user home directories.", + "type": "integer" + }, + "ifs_restricted": { + "description": "Specifies a list of users and groups that have read and write access to /ifs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "map_untrusted": { + "description": "Maps untrusted domains to this NetBIOS domain during authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the access zone name.", + "type": "string" + }, + "negative_cache_entry_expiry": { + "description": "Specifies number of seconds the negative cache entry is valid.", + "type": "integer" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name.", + "type": "string" + }, + "path": { + "description": "Specifies the access zone base directory path.", + "type": "string" + }, + "skeleton_directory": { + "description": "Specifies the skeleton directory that is used for user home directories.", + "type": "string" + }, + "system_provider": { + "description": "Specifies the system provider for the access zone.", + "type": "string" + }, + "user_mapping_rules": { + "description": "Specifies the current ID mapping rules.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "v3ZoneExtendedExtendedExtended": { + "description": "Specifies properties for access zones.", + "properties": { + "alternate_system_provider": { + "description": "Specifies an alternate system provider.", + "type": "string" + }, + "auth_providers": { + "description": "Specifies the list of authentication providers available on this access zone.", + "items": { + "type": "string" + }, + "type": "array" + }, + "cache_entry_expiry": { + "description": "Specifies amount of time in seconds to cache a user/group.", + "type": "integer" + }, + "create_path": { + "description": "Determines if a path is created when a path does not exist.", + "type": "boolean" + }, + "force_overlap": { + "description": "Allow for overlapping base path.", + "type": "boolean" + }, + "groupnet": { + "description": "Groupnet identifier", + "type": "string" + }, + "home_directory_umask": { + "description": "Specifies the permissions set on automatically created user home directories.", + "type": "integer" + }, + "id": { + "description": "Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method", + "type": "string" + }, + "ifs_restricted": { + "description": "Specifies a list of users and groups that have read and write access to /ifs.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "type": "array" + }, + "map_untrusted": { + "description": "Maps untrusted domains to this NetBIOS domain during authentication.", + "type": "string" + }, + "name": { + "description": "Specifies the access zone name.", + "type": "string" + }, + "negative_cache_entry_expiry": { + "description": "Specifies number of seconds the negative cache entry is valid.", + "type": "integer" + }, + "netbios_name": { + "description": "Specifies the NetBIOS name.", + "type": "string" + }, + "path": { + "description": "Specifies the access zone base directory path.", + "type": "string" + }, + "skeleton_directory": { + "description": "Specifies the skeleton directory that is used for user home directories.", + "type": "string" + }, + "system": { + "description": "True if the access zone is built-in.", + "type": "boolean" + }, + "system_provider": { + "description": "Specifies the system provider for the access zone.", + "type": "string" + }, + "user_mapping_rules": { + "description": "Specifies the current ID mapping rules.", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_id": { + "description": "Specifies the access zone ID on the system.", + "type": "integer" + } + }, + "type": "object" + }, + "v3Zones": { + "additionalProperties": false, + "properties": { + "zones": { + "items": { + "$ref": "#/definitions/v3ZoneExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v3ZonesExtended": { + "additionalProperties": false, + "properties": { + "zones": { + "items": { + "$ref": "#/definitions/v3ZoneExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4AuditProgress": { + "properties": { + "progress": { + "$ref": "#/definitions/v4AuditProgressProgress" + } + }, + "type": "object" + }, + "v4AuditProgressProgress": { + "description": "Lists the current audit log times.", + "properties": { + "protocol_audit_cee_time": { + "description": "Specifies the last protocol audit event time consumed by the CEE forwarder.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "protocol_audit_log_time": { + "description": "Specifies the last logged audit protocol event time.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "protocol_audit_syslog_time": { + "description": "Specifies the last protocol audit event time consumed by the Syslog forwarder.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4AuthCacheItem": { + "description": "Flush security objects cache.", + "properties": { + "all": { + "description": "Flush all objects in cache for access zone.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid": { + "description": "Flush objects in cache for access zone specified by GID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "group_name": { + "description": "Flush objects in cache for access zone specified by group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "provider": { + "description": "Flush objects in cache for access zone specified by authentication provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sid": { + "description": "Flush objects in cache for access zone specified by SID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "description": "Flush objects in cache for access zone specified by UID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_name": { + "description": "Flush objects in cache for access zone specified by user name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v4AuthLdapTemplates": { + "additionalProperties": false, + "properties": { + "ldap_configuration_templates": { + "items": { + "$ref": "#/definitions/v4AuthLdapTemplatesLdapConfigurationTemplate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4AuthLdapTemplatesLdapConfigurationTemplate": { + "description": "Configurable fields of LDAP Providers.", + "properties": { + "cn_attribute": { + "description": "Specifies canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "crypt_password_attribute": { + "description": "Sets hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Sets the LDAP Email attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gecos_attribute": { + "description": "Sets the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Sets the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Sets LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Sets the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "homedir_attribute": { + "description": "Sets the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the LDAP provider field template.", + "enum": [ + "default", + "ldapsam", + "rfc2307", + "ad-idmu" + ], + "type": "string" + }, + "name_attribute": { + "description": "Sets the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Sets LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Sets the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Sets the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nt_password_attribute": { + "description": "Sets the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_expire_attribute": { + "description": "Sets the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Sets the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Sets the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Sets LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v4CertificateServer": { + "additionalProperties": false, + "properties": { + "certificates": { + "items": { + "$ref": "#/definitions/v4CertificateServerCertificate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4CertificateServerCertificate": { + "properties": { + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "dnsnames": { + "description": "A list of DNS names/patterns for which this certificate is valid. This list is extracted from the certificates CN (Common Name) and subjectAtlName extension fields.", + "items": { + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "fingerprints": { + "description": "A list of zero or more certificate fingerprints which can be used for certificate identification.", + "items": { + "$ref": "#/definitions/v7CertificateAuthorityCertificateFingerprint" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique server certificate identifier.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "issuer": { + "description": "Certificate issuer field extracted from the certificate.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Administrator specified name identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + }, + "not_after": { + "description": "Certificate notAfter field extracted from the certificate encoded as a UNIX epoch timestamp. The certificate is not valid after this timestamp.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "not_before": { + "description": "Certificate notBefore field extracted from the certificate encoded as a UNIX epoch timestamp. The certificate is not valid before this timestamp.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "Certificate validity status", + "enum": [ + "valid", + "invalid", + "expired", + "expiring" + ], + "type": "string" + }, + "subject": { + "description": "Certificate subject field extracted from the certificate.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "status", + "description", + "dnsnames", + "not_after", + "fingerprints", + "name", + "not_before", + "subject", + "id", + "issuer" + ], + "type": "object" + }, + "v4CertificateServerExtended": { + "additionalProperties": false, + "properties": { + "certificates": { + "items": { + "$ref": "#/definitions/v4CertificateServerCertificate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4CertificateServerItem": { + "properties": { + "certificate_key_password": { + "description": "Optional private key password. ", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "certificate_key_path": { + "description": "Local path to the certificate key that is to be imported.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "certificate_path": { + "description": "Local path to the certificate that is to be imported.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Administrator specified name identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + } + }, + "required": [ + "certificate_key_path", + "certificate_path" + ], + "type": "object" + }, + "v4CloudProxies": { + "additionalProperties": false, + "properties": { + "proxies": { + "items": { + "$ref": "#/definitions/v4CloudProxyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_PROXIES" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4CloudProxiesExtended": { + "additionalProperties": false, + "properties": { + "proxies": { + "items": { + "$ref": "#/definitions/v4CloudProxyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4CloudProxy": { + "description": "The configuration settings for a network proxy", + "properties": { + "host": { + "description": "A host name or network address for connecting to this proxy", + "type": "string" + }, + "name": { + "description": "A unique friendly name for this proxy configuration", + "type": "string" + }, + "password": { + "description": "The password to connect to this proxy if required (write-only)", + "type": "string" + }, + "port": { + "description": "The port used to connect to this proxy", + "type": "integer" + }, + "type": { + "description": "The type of connection used to connect to this proxy", + "enum": [ + "socks_4", + "socks_5", + "http" + ], + "type": "string" + }, + "username": { + "description": "The username to connect to this proxy if required", + "type": "string" + } + }, + "required": [ + "name", + "host", + "type", + "port" + ], + "type": "object", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_PROXIES" + }, + "v4CloudProxyExtended": { + "description": "The configuration settings for a network proxy", + "properties": { + "host": { + "description": "A host name or network address for connecting to this proxy", + "type": "string" + }, + "id": { + "description": "A globally unique ID (guid) or the name of this proxy (read-only)", + "type": "string" + }, + "name": { + "description": "A unique friendly name for this proxy configuration", + "type": "string" + }, + "password": { + "description": "The password to connect to this proxy if required (write-only)", + "type": "string" + }, + "password_is_set": { + "description": "Indicates whether a password has been set for this proxy", + "type": "boolean" + }, + "port": { + "description": "The port used to connect to this proxy", + "type": "integer" + }, + "type": { + "description": "The type of connection used to connect to this proxy", + "enum": [ + "socks_4", + "socks_5", + "http" + ], + "type": "string" + }, + "username": { + "description": "The username to connect to this proxy if required", + "type": "string" + } + }, + "type": "object" + }, + "v4CloudProxyExtendedExtended": { + "description": "The configuration settings for a network proxy", + "properties": { + "host": { + "description": "A host name or network address for connecting to this proxy", + "type": "string" + }, + "name": { + "description": "A unique friendly name for this proxy configuration", + "type": "string" + }, + "password": { + "description": "The password to connect to this proxy if required (write-only)", + "type": "string" + }, + "port": { + "description": "The port used to connect to this proxy", + "type": "integer" + }, + "type": { + "description": "The type of connection used to connect to this proxy", + "enum": [ + "socks_4", + "socks_5", + "http" + ], + "type": "string" + }, + "username": { + "description": "The username to connect to this proxy if required", + "type": "string" + } + }, + "type": "object" + }, + "v4EventAlertCondition": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "items": { + "enum": [ + "all", + "SYS_DISK_EVENTS", + "100000000", + "NODE_STATUS_EVENTS", + "200000000", + "REBOOT_EVENTS", + "300000000", + "SW_EVENTS", + "400000000", + "QUOTA_EVENTS", + "500000000", + "SNAP_EVENTS", + "600000000", + "WINNET_EVENTS", + "700000000", + "FILESYS_EVENTS", + "800000000", + "HW_EVENTS", + "900000000", + "CPOOL_EVENTS", + "1100000000" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "Channels for alert.", + "items": { + "type": "string" + }, + "minimum": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Unique identifier.", + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "severities": { + "description": "Severities to be alerted.", + "items": { + "enum": [ + "emergency", + "critical", + "warning", + "information" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "name", + "channels", + "condition" + ], + "type": "object" + }, + "v4EventAlertConditionExtended": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "items": { + "enum": [ + "all", + "SYS_DISK_EVENTS", + "100000000", + "NODE_STATUS_EVENTS", + "200000000", + "REBOOT_EVENTS", + "300000000", + "SW_EVENTS", + "400000000", + "QUOTA_EVENTS", + "500000000", + "SNAP_EVENTS", + "600000000", + "WINNET_EVENTS", + "700000000", + "FILESYS_EVENTS", + "800000000", + "HW_EVENTS", + "900000000", + "CPOOL_EVENTS", + "1100000000" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "Channels for alert.", + "items": { + "type": "string" + }, + "minimum": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "minimum": 0, + "type": "integer" + }, + "severities": { + "description": "Severities to be alerted.", + "items": { + "enum": [ + "emergency", + "critical", + "warning", + "information" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4EventAlertConditions": { + "additionalProperties": false, + "properties": { + "alert-conditions": { + "items": { + "$ref": "#/definitions/v4EventAlertConditionsAlert-Condition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4EventAlertConditionsAlert-Condition": { + "description": "Specifies under what conditions and over which channel an alert should be sent.", + "properties": { + "categories": { + "description": "Event Group categories to be alerted: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "items": { + "enum": [ + "all", + "SYS_DISK_EVENTS", + "100000000", + "NODE_STATUS_EVENTS", + "200000000", + "REBOOT_EVENTS", + "300000000", + "SW_EVENTS", + "400000000", + "QUOTA_EVENTS", + "500000000", + "SNAP_EVENTS", + "600000000", + "WINNET_EVENTS", + "700000000", + "FILESYS_EVENTS", + "800000000", + "HW_EVENTS", + "900000000", + "CPOOL_EVENTS", + "1100000000" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "channels": { + "description": "Channels for alert.", + "items": { + "type": "string" + }, + "minimum": 0, + "type": "array" + }, + "condition": { + "description": "Trigger condition for alert.", + "enum": [ + "NEW", + "NEW EVENTS", + "ONGOING", + "SEVERITY INCREASE", + "SEVERITY DECREASE", + "RESOLVED" + ], + "type": "string" + }, + "eventgroup_ids": { + "description": "Event Group IDs to be alerted.", + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Unique identifier.", + "type": "string" + }, + "interval": { + "description": "Required with ONGOING condition only, period in seconds between alerts of ongoing conditions.", + "minimum": 0, + "type": "integer" + }, + "limit": { + "description": "Required with NEW EVENTS condition only, limits the number of alerts sent as events are added.", + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Unique identifier.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "severities": { + "description": "Severities to be alerted.", + "items": { + "enum": [ + "emergency", + "critical", + "warning", + "information" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "transient": { + "description": "Any eventgroup lasting less than this many seconds is deemed transient and will not generate alerts under this condition.", + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4EventAlertConditionsExtended": { + "additionalProperties": false, + "properties": { + "alert-conditions": { + "items": { + "$ref": "#/definitions/v4EventAlertConditionsAlert-Condition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4EventEventgroupDefinitions": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v4EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4EventEventgroupDefinitionsEventgroup-Definition": { + "description": "Description of an eventgroup that can occur and be detected.", + "properties": { + "category": { + "description": "ID of eventgroup category: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "enum": [ + "all", + "100000000", + "200000000", + "300000000", + "400000000", + "500000000", + "600000000", + "700000000", + "800000000", + "900000000", + "1100000000" + ], + "type": "string" + }, + "description": { + "description": "Human readable description - may contain value placeholders.", + "type": "string" + }, + "id": { + "description": "Unique Identifier.", + "type": "string" + }, + "name": { + "description": "Name for eventgroup.", + "type": "string" + } + }, + "type": "object" + }, + "v4EventEventgroupDefinitionsExtended": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v4EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4FilepoolDefaultPolicy": { + "description": "A default filepool policy object", + "properties": { + "default-policy": { + "$ref": "#/definitions/v4FilepoolDefaultPolicyDefault-Policy" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_DEFAULT_POLICY" + }, + "v4FilepoolDefaultPolicyDefault-Policy": { + "description": "A default filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v4FilepoolPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v4FilepoolPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_POLICIES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4FilepoolPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v4FilepoolPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4FilepoolPolicy": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "birth_cluster_id": { + "description": "The guid assigned to the cluster on which the account was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "id": { + "description": "A unique identifier for this policy", + "type": "integer" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + }, + "state": { + "description": "Indicates whether this policy is in a good state (\"OK\") or disabled (\"disabled\")", + "enum": [ + "OK", + "disabled" + ], + "type": "string" + }, + "state_details": { + "description": "Gives further information to describe the state of this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v4FilepoolPolicyExtended": { + "description": "A filepool policy object", + "properties": { + "actions": { + "description": "A list of actions to be taken for matching files", + "items": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyAction" + }, + "maxItems": 7, + "minItems": 0, + "type": "array" + }, + "apply_order": { + "description": "The order in which this policy should be applied (relative to other policies)", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "description": { + "description": "A description for this policy", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1FilepoolPolicyFileMatchingPattern" + }, + "name": { + "description": "A unique name for this policy", + "maxLength": 768, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "actions" + ], + "type": "object" + }, + "v4FilepoolTemplates": { + "additionalProperties": false, + "properties": { + "templates": { + "items": { + "$ref": "#/definitions/v4FilepoolPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_FILEPOOL_TEMPLATES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4FilepoolTemplatesExtended": { + "additionalProperties": false, + "properties": { + "templates": { + "items": { + "$ref": "#/definitions/v4FilepoolPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4GroupnetSubnet": { + "properties": { + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addr": { + "description": "The address that SmartConnect listens for DNS requests.", + "maxLength": 2048, + "minLength": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "sc_service_name": { + "description": "Domain Name corresponding to the SmartConnect Service Address.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 2, + "type": "integer" + } + }, + "required": [ + "addr_family", + "prefixlen", + "name" + ], + "type": "object" + }, + "v4GroupnetSubnetExtended": { + "properties": { + "addr_family": { + "description": "IP address format.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "base_addr": { + "description": "The base IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "groupnet": { + "description": "Name of the groupnet this subnet belongs to.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique Subnet ID.", + "maxLength": 66, + "minLength": 1, + "type": "string" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "pools": { + "description": "Name of the pools in the subnet.", + "items": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addr": { + "description": "The address that SmartConnect listens for DNS requests.", + "maxLength": 2048, + "minLength": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "sc_service_name": { + "description": "Domain Name corresponding to the SmartConnect Service Address.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 2, + "type": "integer" + } + }, + "type": "object" + }, + "v4GroupnetSubnets": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subnets": { + "items": { + "$ref": "#/definitions/v4GroupnetSubnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4GroupnetsGroupnetSubnet": { + "properties": { + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addr": { + "description": "The address that SmartConnect listens for DNS requests.", + "maxLength": 2048, + "minLength": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "sc_service_name": { + "description": "Domain Name corresponding to the SmartConnect Service Address.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 2, + "type": "integer" + } + }, + "type": "object" + }, + "v4GroupnetsGroupnetSubnets": { + "additionalProperties": false, + "properties": { + "subnets": { + "items": { + "$ref": "#/definitions/v4GroupnetSubnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4HdfsRangerPluginSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v4HdfsRangerPluginSettingsSettings" + } + }, + "type": "object" + }, + "v4HdfsRangerPluginSettingsSettings": { + "description": "Settings for the HDFS ranger plugin", + "properties": { + "enabled": { + "description": "Enable or disable the HDFS ranger plugin", + "type": "boolean" + }, + "policy_manager_url": { + "description": "The scheme, hostname, and port of the Apache Ranger server (e.g. http://ranger.com:6080)", + "type": "string" + }, + "repository_name": { + "description": "The HDFS repository name that is registered with Apache Ranger server", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_RANGERPLUGIN_SETTINGS" + }, + "v4NdmpSettingsPreferredIp": { + "properties": { + "data_subnets": { + "items": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIpDataSubnet" + }, + "type": "array" + }, + "scope": { + "description": "Either cluster or a network subnet defined in OneFS.", + "type": "string" + } + }, + "required": [ + "scope", + "data_subnets" + ], + "type": "object" + }, + "v4NdmpSettingsPreferredIpDataSubnet": { + "properties": { + "subnet": { + "description": "The name of a subnet.", + "type": "string" + } + }, + "type": "object" + }, + "v4NdmpSettingsPreferredIpExtended": { + "properties": { + "data_subnets": { + "items": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIpDataSubnet" + }, + "type": "array" + } + }, + "required": [ + "data_subnets" + ], + "type": "object" + }, + "v4NdmpSettingsPreferredIps": { + "description": "Get a list of preferred ip preferences.", + "properties": { + "preferences": { + "items": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIpsPreference" + }, + "type": "array" + }, + "resume": { + "description": "Resume string returned by previous query.", + "type": "string" + }, + "total": { + "description": "The number of preferences.", + "type": "integer" + } + }, + "type": "object" + }, + "v4NdmpSettingsPreferredIpsExtended": { + "description": "Get a list of preferred ip preferences.", + "properties": { + "preferences": { + "items": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIpsPreference" + }, + "type": "array" + }, + "total": { + "description": "The number of preferences.", + "type": "integer" + } + }, + "type": "object" + }, + "v4NdmpSettingsPreferredIpsPreference": { + "properties": { + "data_subnets": { + "items": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIpDataSubnet" + }, + "type": "array" + }, + "id": { + "description": "The unique display id, same as scope", + "type": "string" + }, + "scope": { + "description": "Either cluster or a network subnet defined in OneFS.", + "type": "string" + } + }, + "type": "object" + }, + "v4ProgressGlobal": { + "properties": { + "progress": { + "$ref": "#/definitions/v4ProgressGlobalProgress" + } + }, + "type": "object" + }, + "v4ProgressGlobalProgress": { + "description": "Lists the current global audit log times.", + "properties": { + "protocol_audit_latest_log_time": { + "description": "Specifies the time of the last logged audit protocol event time on the cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "protocol_audit_oldest_cee_time": { + "description": "Specifies the time of the oldest protocol audit event consumed by the CEE forwarder on the cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "protocol_audit_oldest_syslog_time": { + "description": "Specifies the time of the oldest protocol audit event consumed by the Syslog forwarder on the cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4ProvidersLdap": { + "additionalProperties": false, + "properties": { + "ldap": { + "items": { + "$ref": "#/definitions/v4ProvidersLdapLdapItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4ProvidersLdapIdParams": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "template": { + "description": "Specifies template to be used to create the LDAP provider. The list of templates can be found at /auth/ldap-templates. Any fields directly defined in your request will override the template values.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v4ProvidersLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "template": { + "description": "Specifies template to be used to create the LDAP provider. The list of templates can be found at /auth/ldap-templates. Any fields directly defined in your request will override the template values.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "required": [ + "base_dn", + "server_uris", + "name" + ], + "type": "object" + }, + "v4ProvidersLdapLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v4ReportSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v4ReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v4ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4ReportsReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v4ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4ReportsReportSubreportsSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v4ReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v4ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4SummaryWorkload": { + "additionalProperties": false, + "properties": { + "workload": { + "items": { + "$ref": "#/definitions/v4SummaryWorkloadWorkloadItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4SummaryWorkloadWorkloadItem": { + "properties": { + "bytes_in": { + "description": "Count of bytes-in per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "bytes_out": { + "description": "Count of bytes-out per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "cpu": { + "description": "The number (across all cores) of micro-seconds per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "domain_id": { + "description": "The IFS domain of the path which the operation was requested on.", + "type": "string" + }, + "error": { + "description": "Report any errors during id resolution.", + "type": "string" + }, + "group_id": { + "description": "Group ID of the group that initiated the operation.", + "type": "number" + }, + "group_sid": { + "description": "Group SID of the group that initiated the operation.", + "type": "string" + }, + "groupname": { + "description": "The resolved text name of the group that initiated the operation.", + "type": "string" + }, + "job_type": { + "description": "The canonical name for the job followed by phase in brackets, ie. 'AVscan[1]', etc...", + "type": "string" + }, + "l2": { + "description": "L2 cache hits per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "l3": { + "description": "L3 cache hits per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "local_address": { + "description": "The IP address of the host receiving the operation request.", + "type": "string" + }, + "local_name": { + "description": "The resolved text name of the LocalAddr, if resolution can be performed.", + "type": "string" + }, + "node": { + "description": "The node on which the operation was performed or 0 for cluster scoped statistics.", + "maximum": 2147483647, + "minimum": 0, + "type": "number" + }, + "ops": { + "description": "Operations per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "path": { + "description": "The path which the operation was requestion on.", + "type": "string" + }, + "protocol": { + "description": "The protocol of the operation.", + "type": "string" + }, + "reads": { + "description": "Disk read operations per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "remote_address": { + "description": "The IP address of the host sending the operation request.", + "type": "string" + }, + "remote_name": { + "description": "The resolved text name of the RemoteAddr, if resolution can be performed.", + "type": "string" + }, + "share_name": { + "description": "The name of the SMB share through which the operation was requested.", + "type": "string" + }, + "system_name": { + "description": "The process name, job ID, etc...", + "type": "string" + }, + "time": { + "description": "Unix Epoch time in seconds that statistic was collected.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_id": { + "description": "User ID of the user who initiated the operation.", + "type": "number" + }, + "user_sid": { + "description": "User SID of the user who initiated the operation.", + "type": "string" + }, + "username": { + "description": "The resolved text name of the user who initiated the operation.", + "type": "string" + }, + "workload_id": { + "description": "ID of the workload (Pinned workloads only).", + "type": "integer" + }, + "workload_type": { + "description": "The type of workload output.", + "type": "string" + }, + "writes": { + "description": "Disk write operations per second.", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "zone_id": { + "description": "Zone ID", + "type": "number" + }, + "zone_name": { + "description": "The resolved text zone name", + "type": "string" + } + }, + "required": [ + "reads", + "bytes_in", + "writes", + "time", + "node", + "ops", + "bytes_out", + "l2", + "l3", + "cpu" + ], + "type": "object" + }, + "v4SyncReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncReportPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v4SyncReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v4SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4SyncReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v4SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4TargetReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v4TargetReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v4TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_TARGET_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v4TargetReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v4TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4TargetReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v4ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v4UpgradeCluster": { + "description": "Cluster wide upgrade status info.", + "properties": { + "cluster_overview": { + "$ref": "#/definitions/v12UpgradeClusterClusterOverview" + }, + "cluster_state": { + "description": "The different states of an upgrade, rollback, or assessment. One of the following values: 'committed', 'upgraded', 'partially upgraded', 'upgrading', 'rolling back', 'assessing', 'error'", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "current_process": { + "description": "The current upgrade activity.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "finish_time": { + "description": "The time when a rollback, assessment or upgrade has finished completely. Use ISO 8601 standard. Null if the cluster_state is not 'upgraded'.", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs. Null if the cluster_state is 'committed' or 'upgraded.'", + "maxLength": 4096, + "minLength": 5, + "type": "string" + }, + "node_median_time": { + "description": "The median time (seconds) to complete each node so far during this upgrade. Before the first node in an upgrade has completed this key will have an associated null value.", + "type": "integer" + }, + "onefs_version_current": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "onefs_version_upgrade": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "patch_action": { + "description": "The most recent patch action performed.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "patch_name": { + "description": "The patch with the most recent patch action.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "start_time": { + "description": "The time when an upgrade, rollback, or assessment was started. Use ISO 8601 standard. Null if the cluster_state is 'committed' or 'partially upgraded.'", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "upgrade_is_committed": { + "description": "True if upgrade is committed.", + "type": "boolean" + }, + "upgrade_settings": { + "$ref": "#/definitions/v12UpgradeClusterUpgradeSettings" + }, + "upgrade_triggered_time": { + "description": "Time at which upgrade was originally requested.", + "maxLength": 128, + "minLength": 4, + "type": "string" + } + }, + "type": "object" + }, + "v5ClusterIdentity": { + "description": "Unprivileged cluster information for display when logging in.", + "properties": { + "description": { + "description": "A description of the cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logon": { + "$ref": "#/definitions/v5ClusterIdentityLogon" + }, + "mttdl_level_msg": { + "description": "Enum to control the display message about the MTTDL of the cluster. This does NOT change the MTTDL of a cluster in anyway, and is purely a value for displaying messages.", + "enum": [ + "warn", + "none" + ], + "type": "string" + }, + "name": { + "description": "The name of the cluster.", + "type": "string" + } + }, + "required": [ + "mttdl_level_msg", + "logon", + "description", + "name" + ], + "type": "object" + }, + "v5ClusterIdentityExtended": { + "description": "Unprivileged cluster information for display when logging in.", + "properties": { + "description": { + "description": "A description of the cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logon": { + "$ref": "#/definitions/v5ClusterIdentityLogonExtended" + }, + "name": { + "description": "The name of the cluster.", + "type": "string" + } + }, + "type": "object" + }, + "v5ClusterIdentityLogon": { + "allOf": [ + { + "$ref": "#/definitions/v3ClusterIdentityLogon" + }, + { + "description": "The information displayed when a user logs in to the cluster.", + "properties": { + "motd": { + "description": "The message of the day.", + "type": "string" + }, + "motd_header": { + "description": "The header to the message of the day.", + "type": "string" + } + }, + "required": [ + "motd_header", + "motd" + ], + "type": "object" + } + ] + }, + "v5ClusterIdentityLogonExtended": { + "description": "The information displayed when a user logs in to the cluster.", + "properties": { + "motd": { + "description": "The message of the day.", + "type": "string" + }, + "motd_header": { + "description": "The header to the message of the day.", + "type": "string" + } + }, + "type": "object" + }, + "v5ClusterNode": { + "description": "Node information.", + "properties": { + "drive_d_config": { + "$ref": "#/definitions/v5ClusterNodeDriveDConfig" + }, + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v5ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "hardware": { + "$ref": "#/definitions/v5ClusterNodeHardware" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "$ref": "#/definitions/v10ClusterNodePartitions" + }, + "sensors": { + "$ref": "#/definitions/v10ClusterNodeSensors" + }, + "sleds": { + "description": "List of the sleds in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSled" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "state": { + "$ref": "#/definitions/v10ClusterNodeState" + }, + "status": { + "$ref": "#/definitions/v10ClusterNodeStatus" + } + }, + "type": "object" + }, + "v5ClusterNodeDrive": { + "description": "Drive information.", + "properties": { + "bay_group": { + "description": "The name of the bay group this drive belongs to.", + "maxLength": 2147483646, + "minLength": 0, + "type": "string" + }, + "baynum": { + "description": "Numerical representation of this drive's bay.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "blocks": { + "description": "Number of blocks on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "chassis": { + "description": "The chassis number which contains this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "devname": { + "description": "This drive's device name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "firmware": { + "$ref": "#/definitions/v10ClusterNodeDriveFirmware" + }, + "handle": { + "description": "Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "interface_type": { + "description": "String representation of this drive's interface type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnum": { + "description": "This drive's logical drive number in IFS.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "locnstr": { + "description": "String representation of this drive's physical location.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "logical_block_length": { + "description": "Size of a logical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "media_type": { + "description": "String representation of this drive's media type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "This drive's manufacturer and model.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "pending_actions": { + "description": "This drive's current outstanding actions. For example, \"add\" or \"firmware_update\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "physical_block_length": { + "description": "Size of a physical block on this drive.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "present": { + "description": "Indicates whether this drive is physically present in the node.", + "type": "boolean" + }, + "purpose": { + "description": "This drive's purpose in the DRV state machine.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "purpose_description": { + "description": "Description of this drive's purpose.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "serial": { + "description": "Serial number for this drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ui_state": { + "description": "This drive's state as presented to the UI.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "wwn": { + "description": "The drive's 'worldwide name' from its NAA identifiers.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "x_loc": { + "description": "This drive's x-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "y_loc": { + "description": "This drive's y-axis grid location.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5ClusterNodeDriveDConfig": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "alert": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAlert" + }, + "allow": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAllow" + }, + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "log": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigLog" + }, + "reboot": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigReboot" + }, + "spin_wait": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigSpinWait" + }, + "stall": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigStall" + } + }, + "required": [ + "automatic_replacement_recognition" + ], + "type": "object" + }, + "v5ClusterNodeHardware": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_count": { + "description": "Number of chassis making up this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_depth": { + "description": "Chassis depth for this node if applicable (e.g., Normal, Deep, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "code_name": { + "description": "Code name of this node if applicable If not supported or error: Unknown.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "compute_type": { + "description": "Type of compute node if applicable (e.g., Low, Medium, High, Turbo, Ultra, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "flash_drive": { + "description": "Manufacturer, model, and device id of this node's flash drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "imb_version": { + "description": "Version of this node's PowerScale Management Board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model": { + "description": "PowerScale node model identifier string (S200, X410, Infinity-H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model_code": { + "description": "PowerScale node model code string (S200, X410, H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_slot_id": { + "description": "Position of node within chassis. -1 for error or not supported.", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "peer_serial_number": { + "description": "Serial number of this node's peer/buddy node.(Infinity Only)", + "type": "string" + }, + "performance_code": { + "description": "Performance code of this node, if applicable (2, 4, 5, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sled_drive_count": { + "description": "Size of drive sleds in node, if applicable. Expected values: 3, 4, 6. 0 if unable to determine sled size. -1 for error or not supported. If PSI_Get fails: -1. PSI_Get can fail if PSI not initialized, or key does not exist.", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "tier": { + "description": "Platform tier level of this node if applicable (positive for a defined tier, 0 for unknown or not supported, -1 for error).", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "top_level_assembly_serial_number": { + "description": "Serial number of the top level assembly of this node.(Infinity Only)", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "top_level_assembly_serial_number", + "peer_serial_number" + ], + "type": "object" + }, + "v5ClusterNodes": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v5ClusterNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5GroupnetsSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v5GroupnetsSummarySummary" + } + }, + "type": "object" + }, + "v5GroupnetsSummarySummary": { + "description": "The summary of a collection of objects.", + "properties": { + "count": { + "description": "The count of objects in the collection", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "list": { + "description": "List of groupnet names", + "items": { + "$ref": "#/definitions/v5GroupnetsSummarySummaryListItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "count" + ], + "type": "object" + }, + "v5GroupnetsSummarySummaryListItem": { + "description": "Name of groupnet", + "properties": { + "name": { + "description": "Name of groupnet", + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v5HdfsFsimageJob": { + "properties": { + "job": { + "$ref": "#/definitions/v5HdfsFsimageJobJob" + } + }, + "type": "object" + }, + "v5HdfsFsimageJobJob": { + "description": "Information about job that generates FSImage.", + "properties": { + "reason": { + "description": "Further details about the state of the job.", + "type": "string" + }, + "state": { + "description": "State of the job.", + "enum": [ + "INPROGRESS", + "IDLE", + "FAILED", + "DISABLED", + "NONE" + ], + "type": "string" + }, + "time_started": { + "description": "The date and time job was started as a UNIX epoch. If null, started is not relevant to the state.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "txid": { + "description": "The transaction id of the FSImage. If null, txid is not relevant to the state.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5HdfsFsimageJobSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v5HdfsFsimageJobSettingsSettings" + } + }, + "type": "object" + }, + "v5HdfsFsimageJobSettingsSettings": { + "description": "Settings for the HDFS FSImage job.", + "properties": { + "generation_interval": { + "description": "The interval in seconds between successive FSImages. The default is 86400, which amounts to a day.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_FSIMAGE_JOB_SETTINGS" + }, + "v5HdfsFsimageLatest": { + "properties": { + "latest": { + "$ref": "#/definitions/v5HdfsFsimageLatestLatest" + } + }, + "type": "object" + }, + "v5HdfsFsimageLatestLatest": { + "description": "Information about the latest FSImage.", + "properties": { + "created": { + "description": "The date and time FSImage was created as a UNIX epoch.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "size": { + "description": "Size of the FSImage in bytes. If null, FSImage is not present.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "txid": { + "description": "The transaction id of the latest HDFS FSImage. If null, FSImage is not present.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5HdfsFsimageSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v5HdfsFsimageSettingsSettings" + } + }, + "type": "object" + }, + "v5HdfsFsimageSettingsSettings": { + "description": "Settings for the HDFS FSImage.", + "properties": { + "enabled": { + "description": "Enable or disable the HDFS FSImage generation and access to the latest FSImage.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_FSIMAGE_SETTINGS" + }, + "v5HdfsInotifySettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v5HdfsInotifySettingsSettings" + } + }, + "type": "object" + }, + "v5HdfsInotifySettingsSettings": { + "description": "Settings for HDFS INotify.", + "properties": { + "enabled": { + "description": "Enable or disable the collection of edits over HDFS and access to the edits via HDFS INotify stream.", + "type": "boolean" + }, + "maximum_delay": { + "description": "The maximum duration in seconds until an edit event is reported in INotify. The default is 60, which amounts to a minute.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "retention": { + "description": "The minimum amount of time in seconds the edits will be retained. The default is 172800, which amounts to 48hr.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_INOTIFY_SETTINGS" + }, + "v5HdfsInotifyStream": { + "properties": { + "stream": { + "$ref": "#/definitions/v5HdfsInotifyStreamStream" + } + }, + "type": "object" + }, + "v5HdfsInotifyStreamStream": { + "description": "Information about HDFS INotify stream.", + "properties": { + "current_transaction_id": { + "description": "The transaction id of the most recent edit applied over HDFS.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "sync_transaction_id": { + "description": "The transaction id of the latest edit exposed via HDFS INotify stream. This id usually lags behind the current_transaction_id.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5LicenseGenerate": { + "properties": { + "activated_license_list": { + "description": "Array of licenses included in activation file.", + "items": { + "description": "A license included in activation file.", + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "activation": { + "description": "Contents of licensing activation file.", + "maxLength": 2147483647, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "hardware": { + "description": "Array of licenses included in activation file.", + "items": { + "$ref": "#/definitions/v5LicenseGenerateHardwareItem" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "not_activated_license_list": { + "description": "An array of licenses not included in activation file.", + "items": { + "description": "A license not included in activation file.", + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v5LicenseGenerateHardwareItem": { + "properties": { + "drive_capacity": { + "description": "Licensed terabyte (TB, 10^12 bytes) drive capacity allocated as storage associated with tier. Included if tier is not NONINF and license is not a base only license.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "node_count": { + "description": "Licensed number of nodes in this tier.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "nodes_with_seds_count": { + "description": "Licensed number of nodes of this tier that contain self-encrypting drives. Included only if license is ONEFS and tier is not NONINF.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "tier": { + "description": "OneFS hardware tier. Tier is a number, NONINF, or NO_TIER. NONINF indicates a non infinity tier. NO_TIER indicates a license that is not tier based.", + "maxLength": 50, + "minLength": 1, + "pattern": "^NONINF$|^NO_TIER$|^\\d+$", + "type": "string" + } + }, + "type": "object" + }, + "v5LicenseLicense": { + "properties": { + "evaluation": { + "description": "A list of evaluation licenses to enable on the cluster.", + "items": { + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "license_file_content": { + "description": "License file string content. The license file is obtained from Dell EMC's SLC web portal. Do not use with the license_file_path option.", + "maxLength": 2147483647, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "license_file_path": { + "description": "Path to new license file, must be under /ifs. The license file is obtained from Dell EMC's SLC web portal. Do not include the path when only enabling evaluation licenses. Do not use with the license_file_content option.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + } + }, + "type": "object" + }, + "v5LicenseLicenseExtended": { + "description": "Information about a OneFS Hardware or Software license.", + "properties": { + "days_since_expiry": { + "description": "Number of days since a license expired.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "days_to_expiry": { + "description": "Number of days before a license expires.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "expiration": { + "description": "Date of license expiry. Format is YYYY-MM-DD. It is not included if there is no expiration. Feature is considered expired at end of this day. The cluster time is used to determine expiry.", + "maxLength": 10, + "minLength": 10, + "pattern": "^\\d\\d\\d\\d-\\d\\d-\\d\\d$", + "type": "string" + }, + "expired_alert": { + "description": "True when we are generating an alert that this feature has expired.", + "type": "boolean" + }, + "expiring_alert": { + "description": "True when we are generating an alert that this feature is expiring.", + "type": "boolean" + }, + "id": { + "description": "Name of the licensed feature.", + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "name": { + "description": "Name of the licensed feature.", + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "status": { + "description": "Current status of the license.", + "enum": [ + "Unlicensed", + "Licensed", + "Expired", + "Evaluation", + "Evaluation Expired" + ], + "minLength": 0, + "type": "string" + }, + "tiers": { + "description": "Tiered License details.", + "items": { + "$ref": "#/definitions/v5LicenseLicenseTier" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "status", + "tiers", + "expired_alert", + "id", + "expiring_alert", + "name" + ], + "type": "object" + }, + "v5LicenseLicenseTier": { + "properties": { + "entitlements_exceeded_alerts": { + "description": "List of alerts about exceeded entitlements: The following alerts appear when usage of a resource such as a node, an encryption node, or storage capacity exceeds the quantity licensed for that resource.", + "items": { + "$ref": "#/definitions/v5LicenseLicenseTierEntitlementsExceededAlert" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "licensed_drive_capacity": { + "description": "Licensed terabyte (TB, 10^12 bytes) drive capacity allocated as storage associated with tier. Included if tier is not NONINF and license is not a base only license.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "licensed_node_count": { + "description": "Licensed number of nodes in this tier.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "licensed_nodes_with_seds_count": { + "description": "Licensed number of nodes of this tier that contain self-encrypting drives. Included only if license is ONEFS and tier is not NONINF.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "tier": { + "description": "OneFS hardware tier. Tier is a number, NONINF, or NO_TIER. NONINF indicates a non infinity tier. NO_TIER indicates a license that is not tier based.", + "maxLength": 50, + "minLength": 1, + "pattern": "^NONINF$|^NO_TIER$|^\\d+$", + "type": "string" + }, + "used_drive_capacity": { + "description": "Actual terabyte (TB, 10^12 bytes) drive capacity allocated as storage space associated with tier. Included if tier is not NONINF and license is not a base only license.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "used_node_count": { + "description": "Actual number of nodes in this tier.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "used_nodes_with_seds_count": { + "description": "Actual number of nodes of this tier that contain self-encrypting drives. Included only if license is ONEFS and if tier is not NONINF.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5LicenseLicenseTierEntitlementsExceededAlert": { + "properties": { + "current": { + "description": "Current usage.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "issue_type": { + "description": "Alert type. The unit of measure for the current and licensed fields for capacity is terabytes. For nodes_with_seds_count, it is the number of nodes that have one or more self-encrypting drives.", + "enum": [ + "capacity", + "node_count", + "nodes_with_seds_count" + ], + "type": "string" + }, + "licensed": { + "description": "Licensed amount.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "issue_type" + ], + "type": "object" + }, + "v5LicenseLicenses": { + "additionalProperties": false, + "properties": { + "activation_incomplete_alert": { + "description": "True when we are generating an activation incomplete alert. An activation incomplete alert is generated if we do not have a signed license file 90 days after OneFS is upgraded.", + "type": "boolean" + }, + "base_only_licenses": { + "items": { + "description": "Name of the licensed features that can are not tier related and apply to any node type.", + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "evaluatable": { + "items": { + "description": "Name of the licensed features that can be evaluated", + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "maxItems": 50, + "minItems": 0, + "type": "array" + }, + "licenses": { + "items": { + "$ref": "#/definitions/v5LicenseLicenseExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "swid": { + "description": "Software license identifier. SWID will be absent if not yet obtained from a license file.", + "maxLength": 50, + "minLength": 1, + "pattern": ".+", + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "valid_signature": { + "description": "True if license file contains a valid signature.", + "type": "boolean" + } + }, + "required": [ + "activation_incomplete_alert", + "evaluatable", + "base_only_licenses", + "valid_signature" + ], + "type": "object" + }, + "v5LicenseLicensesExtended": { + "additionalProperties": false, + "properties": { + "licenses": { + "items": { + "$ref": "#/definitions/v5LicenseLicenseExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v5NodeDriveconfig": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v5NodeDriveconfigNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5NodeDriveconfigExtended": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + } + }, + "required": [ + "automatic_replacement_recognition" + ], + "type": "object" + }, + "v5NodeDriveconfigNode": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "alert": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAlert" + }, + "allow": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAllow" + }, + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "log": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigLog" + }, + "reboot": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigReboot" + }, + "spin_wait": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigSpinWait" + }, + "stall": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigStall" + } + }, + "required": [ + "automatic_replacement_recognition" + ], + "type": "object" + }, + "v5NodeDrives": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v5NodeDrivesNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5NodeDrivesNode": { + "description": "Information about this node's drives.", + "properties": { + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v5ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5NodeHardware": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v5NodeHardwareNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5NodeHardwareNode": { + "description": "Node hardware identifying information (static).", + "properties": { + "chassis": { + "description": "Name of this node's chassis.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_code": { + "description": "Chassis code of this node (1U, 2U, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_count": { + "description": "Number of chassis making up this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "chassis_depth": { + "description": "Chassis depth for this node if applicable (e.g., Normal, Deep, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "class": { + "description": "Class of this node (storage, accelerator, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "code_name": { + "description": "Code name of this node if applicable If not supported or error: Unknown.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "compute_type": { + "description": "Type of compute node if applicable (e.g., Low, Medium, High, Turbo, Ultra, Unknown). If not supported or error: Unknown. ", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "configuration_id": { + "description": "Node configuration ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cpu": { + "description": "Manufacturer and model of this node's CPU.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_controller": { + "description": "Manufacturer and model of this node's disk controller.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disk_expander": { + "description": "Manufacturer and model of this node's disk expander.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "family_code": { + "description": "Family code of this node (X, S, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "flash_drive": { + "description": "Manufacturer, model, and device id of this node's flash drive.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generation_code": { + "description": "Generation code of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "hwgen": { + "description": "PowerScale hardware generation name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "imb_version": { + "description": "Version of this node's PowerScale Management Board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "infiniband": { + "description": "Infiniband card type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lcd_version": { + "description": "Version of the LCD panel.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "model": { + "description": "PowerScale node model identifier string (S200, X410, Infinity-H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "model_code": { + "description": "PowerScale node model code string (S200, X410, H500, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "motherboard": { + "description": "Manufacturer and model of this node's motherboard.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "net_interfaces": { + "description": "Description of all this node's network interfaces.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_slot_id": { + "description": "Position of node within chassis. -1 for error or not supported.", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "nvram": { + "description": "Manufacturer and model of this node's NVRAM board.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "peer_serial_number": { + "description": "Serial number of this node's peer/buddy node.(Infinity Only)", + "type": "string" + }, + "performance_code": { + "description": "Performance code of this node, if applicable (2, 4, 5, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "powersupplies": { + "description": "Description strings for each power supply on this node.", + "items": { + "description": "Manufacturer and firmware of this power supply.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "processor": { + "description": "Number of processors and cores on this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "PowerScale product name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ram": { + "description": "Size of RAM in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "serial_number": { + "description": "Serial number of this node.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "series": { + "description": "Series of this node (X, I, NL, etc.).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sled_drive_count": { + "description": "Size of drive sleds in node, if applicable. Expected values: 3, 4, 6. 0 if unable to determine sled size. -1 for error or not supported. If PSI_Get fails: -1. PSI_Get can fail if PSI not initialized, or key does not exist.", + "maximum": 6, + "minimum": -1, + "type": "integer" + }, + "storage_class": { + "description": "Storage class of this node (storage or diskless).", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "tier": { + "description": "Platform tier level of this node if applicable (positive for a defined tier, 0 for unknown or not supported, -1 for error).", + "maximum": 4, + "minimum": -1, + "type": "integer" + }, + "top_level_assembly_serial_number": { + "description": "Serial number of the top level assembly of this node.(Infinity Only)", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "top_level_assembly_serial_number", + "peer_serial_number" + ], + "type": "object" + }, + "v5NodeSleds": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v5NodeSledsNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5NodeSledsNode": { + "description": "Information about this node's sleds.", + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "sleds": { + "description": "List of the sleds in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSled" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v5SnmpSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v5SnmpSettingsSettings" + } + }, + "type": "object" + }, + "v5SnmpSettingsExtended": { + "description": "SNMP settings.", + "properties": { + "read_only_community": { + "description": "The read-only community name. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "service": { + "description": "Whether the SNMP service is enabled.", + "type": "boolean" + }, + "snmp_v1_v2c_access": { + "description": "Whether SNMP v1 and v2c protocols are enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_access": { + "description": "Whether SNMP v3 is enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_auth_protocol": { + "description": "SNMPv3 authentication protocol. May only be SHA or MD5. @DEFAULT reverts this field to its default value.", + "enum": [ + "SHA", + "MD5" + ], + "type": "string" + }, + "snmp_v3_password": { + "description": "This field allows a client to change the SNMP v3 authentication password. There is always a password set. @DEFAULT reverts this field to its default value.", + "maxLength": 39, + "minLength": 8, + "type": "string" + }, + "snmp_v3_priv_password": { + "description": "This field allows a client to change the SNMP v3 privacy password. There is always a password set. @DEFAULT reverts this field to its default value.", + "maxLength": 39, + "minLength": 8, + "type": "string" + }, + "snmp_v3_priv_protocol": { + "description": "SNMPv3 privacy protocol. May only be AES or DES. @DEFAULT reverts this field to its default value.", + "enum": [ + "AES", + "DES" + ], + "type": "string" + }, + "snmp_v3_read_only_user": { + "description": "The read-only user for SNMP v3 read requests. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "snmp_v3_security_level": { + "description": "SNMPv3 privacy protocol. May only be AES or DES. @DEFAULT reverts this field to its default value.", + "enum": [ + "noAuthNoPriv", + "authNoPriv", + "authPriv" + ], + "type": "string" + }, + "system_contact": { + "description": "Contact information for the system owner. This must be a valid email address. @DEFAULT reverts this field to its default value.", + "maxLength": 254, + "minLength": 3, + "pattern": "[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}", + "type": "string" + }, + "system_location": { + "description": "A location name for the SNMP system. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v5SnmpSettingsSettings": { + "description": "SNMP settings.", + "properties": { + "read_only_community": { + "description": "The read-only community name. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "service": { + "description": "Whether the SNMP service is enabled.", + "type": "boolean" + }, + "snmp_v1_v2c_access": { + "description": "Whether SNMP v1 and v2c protocols are enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_access": { + "description": "Whether SNMP v3 is enabled. @DEFAULT reverts this field to its default value.", + "type": "boolean" + }, + "snmp_v3_auth_protocol": { + "description": "SNMPv3 authentication protocol. May only be SHA or MD5. @DEFAULT reverts this field to its default value.", + "enum": [ + "SHA", + "MD5" + ], + "type": "string" + }, + "snmp_v3_priv_protocol": { + "description": "SNMPv3 privacy protocol. May only be AES or DES. @DEFAULT reverts this field to its default value.", + "enum": [ + "AES", + "DES" + ], + "type": "string" + }, + "snmp_v3_read_only_user": { + "description": "The read-only user for SNMP v3 read requests. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + }, + "snmp_v3_security_level": { + "description": "SNMPv3 privacy protocol. May only be AES or DES. @DEFAULT reverts this field to its default value.", + "enum": [ + "noAuthNoPriv", + "authNoPriv", + "authPriv" + ], + "type": "string" + }, + "system_contact": { + "description": "Contact information for the system owner. This must be a valid email address. @DEFAULT reverts this field to its default value.", + "maxLength": 254, + "minLength": 3, + "pattern": "[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}", + "type": "string" + }, + "system_location": { + "description": "A location name for the SNMP system. @DEFAULT reverts this field to its default value.", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v5StoragepoolSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v5StoragepoolSettingsSettings" + } + }, + "type": "object" + }, + "v5StoragepoolSettingsExtended": { + "additionalProperties": false, + "properties": { + "automatically_manage_io_optimization": { + "description": "Automatically manage IO optimization settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "automatically_manage_protection": { + "description": "Automatically manage protection settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "global_namespace_acceleration_enabled": { + "description": "Optimize namespace operations by storing metadata on SSDs.", + "type": "boolean" + }, + "protect_directories_one_level_higher": { + "description": "Automatically add additional protection level to all directories.", + "type": "boolean" + }, + "spillover_enabled": { + "description": "Spill writes into other pools as needed.", + "type": "boolean" + }, + "spillover_target": { + "$ref": "#/definitions/v1StoragepoolSettingsSpilloverTarget" + }, + "ssd_l3_cache_default_enabled": { + "description": "The L3 Cache default enabled state. This specifies whether L3 Cache should be enabled on new node pools", + "type": "boolean" + }, + "ssd_qab_mirrors": { + "description": "Controls number of mirrors of QAB blocks to place on SSDs.", + "enum": [ + "one", + "all" + ], + "type": "string" + }, + "ssd_system_btree_mirrors": { + "description": "Controls number of mirrors of system B-tree blocks to place on SSDs.", + "enum": [ + "one", + "all" + ], + "type": "string" + }, + "ssd_system_delta_mirrors": { + "description": "Controls number of mirrors of system delta blocks to place on SSDs.", + "enum": [ + "one", + "all" + ], + "type": "string" + }, + "virtual_hot_spare_deny_writes": { + "description": "Deny writes into reserved virtual hot spare space.", + "type": "boolean" + }, + "virtual_hot_spare_hide_spare": { + "description": "Hide reserved virtual hot spare space from free space counts.", + "type": "boolean" + }, + "virtual_hot_spare_limit_drives": { + "description": "The number of drives to reserve for the virtual hot spare, from 0-4.", + "maximum": 4, + "minimum": 0, + "type": "integer" + }, + "virtual_hot_spare_limit_percent": { + "description": "The percent space to reserve for the virtual hot spare, from 0-20.", + "maximum": 20, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_SETTINGS" + }, + "v5StoragepoolSettingsSettings": { + "additionalProperties": false, + "properties": { + "automatically_manage_io_optimization": { + "description": "Automatically manage IO optimization settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "automatically_manage_protection": { + "description": "Automatically manage protection settings on files.", + "enum": [ + "all", + "files_at_default", + "none" + ], + "type": "string" + }, + "global_namespace_acceleration_enabled": { + "description": "Optimize namespace operations by storing metadata on SSDs.", + "type": "boolean" + }, + "global_namespace_acceleration_state": { + "description": "Whether or not namespace operation optimizations are currently in effect.", + "enum": [ + "honored", + "inactive" + ], + "type": "string" + }, + "protect_directories_one_level_higher": { + "description": "Automatically add additional protection level to all directories.", + "type": "boolean" + }, + "spillover_enabled": { + "description": "Spill writes into other pools as needed.", + "type": "boolean" + }, + "spillover_target": { + "$ref": "#/definitions/v1StoragepoolSettingsSettingsSpilloverTarget" + }, + "ssd_l3_cache_default_enabled": { + "description": "The L3 Cache default enabled state. This specifies whether L3 Cache should be enabled on new node pools.", + "type": "boolean" + }, + "ssd_qab_mirrors": { + "description": "Controls number of mirrors of QAB blocks to place on SSDs.", + "enum": [ + "one", + "all", + "disabled", + "invalid", + "none" + ], + "type": "string" + }, + "ssd_system_btree_mirrors": { + "description": "Controls number of mirrors of system B-tree blocks to place on SSDs.", + "enum": [ + "one", + "all", + "disabled", + "invalid", + "none" + ], + "type": "string" + }, + "ssd_system_delta_mirrors": { + "description": "Controls number of mirrors of system delta blocks to place on SSDs.", + "enum": [ + "one", + "all", + "disabled", + "invalid", + "none" + ], + "type": "string" + }, + "virtual_hot_spare_deny_writes": { + "description": "Deny writes into reserved virtual hot spare space.", + "type": "boolean" + }, + "virtual_hot_spare_hide_spare": { + "description": "Hide reserved virtual hot spare space from free space counts.", + "type": "boolean" + }, + "virtual_hot_spare_limit_drives": { + "description": "The number of drives to reserve for the virtual hot spare, from 0-4.", + "maximum": 4, + "minimum": 0, + "type": "integer" + }, + "virtual_hot_spare_limit_percent": { + "description": "The percent space to reserve for the virtual hot spare, from 0-20.", + "maximum": 20, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "virtual_hot_spare_deny_writes", + "virtual_hot_spare_hide_spare", + "spillover_target", + "ssd_qab_mirrors", + "ssd_system_delta_mirrors", + "global_namespace_acceleration_enabled", + "ssd_system_btree_mirrors", + "virtual_hot_spare_limit_drives", + "automatically_manage_io_optimization", + "spillover_enabled", + "virtual_hot_spare_limit_percent", + "ssd_l3_cache_default_enabled", + "automatically_manage_protection", + "global_namespace_acceleration_state", + "protect_directories_one_level_higher" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_SETTINGS" + }, + "v6InlineSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v6InlineSettingsSettings" + } + }, + "type": "object" + }, + "v6InlineSettingsSettings": { + "description": "Inline dedupe settings.", + "properties": { + "mode": { + "description": "Target operating mode: disabled, paused, assess or enabled.", + "enum": [ + "disabled", + "paused", + "assess", + "enabled" + ], + "type": "string" + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "v6SettingsCompression": { + "properties": { + "settings": { + "$ref": "#/definitions/v6SettingsCompressionSettings" + } + }, + "type": "object" + }, + "v6SettingsCompressionExtended": { + "properties": { + "enabled": { + "description": "Enable filesystem compression.", + "type": "boolean" + } + }, + "type": "object" + }, + "v6SettingsCompressionSettings": { + "properties": { + "enabled": { + "description": "Enable filesystem compression.", + "type": "boolean" + } + }, + "required": [ + "enabled" + ], + "type": "object" + }, + "v6SmbSettingsGlobal": { + "properties": { + "settings": { + "$ref": "#/definitions/v6SmbSettingsGlobalSettings" + } + }, + "type": "object" + }, + "v6SmbSettingsGlobalSettings": { + "properties": { + "access_based_share_enum": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "audit_fileshare": { + "description": "Specify level of file share audit events to log.", + "enum": [ + "all", + "success", + "failure", + "none" + ], + "type": "string" + }, + "audit_logon": { + "description": "Specify the level of logon audit events to log.", + "enum": [ + "all", + "success", + "failure", + "none" + ], + "type": "string" + }, + "dot_snap_accessible_child": { + "description": "Allow access to .snapshot directories in share subdirectories.", + "type": "boolean" + }, + "dot_snap_accessible_root": { + "description": "Allow access to the .snapshot directory in the root of the share.", + "type": "boolean" + }, + "dot_snap_visible_child": { + "description": "Show .snapshot directories in share subdirectories.", + "type": "boolean" + }, + "dot_snap_visible_root": { + "description": "Show the .snapshot directory in the root of a share.", + "type": "boolean" + }, + "enable_security_signatures": { + "description": "Indicates whether the server supports signed SMB packets.", + "type": "boolean" + }, + "guest_user": { + "description": "Specifies the fully-qualified user to use for guest access.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ignore_eas": { + "description": "Specify whether to ignore EAs on files.", + "type": "boolean" + }, + "onefs_cpu_multiplier": { + "description": "Specify the number of OneFS driver worker threads per CPU.", + "maximum": 4, + "minimum": 1, + "type": "integer" + }, + "onefs_num_workers": { + "description": "Set the maximum number of OneFS driver worker threads.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "reject_unencrypted_access": { + "description": "If SMB3 encryption is enabled, reject unencrypted access from clients.", + "type": "boolean" + }, + "require_security_signatures": { + "description": "Indicates whether the server requires signed SMB packets.", + "type": "boolean" + }, + "server_side_copy": { + "description": "Enable Server Side Copy.", + "type": "boolean" + }, + "server_string": { + "description": "Provides a description of the server.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "service": { + "description": "Specify whether service is enabled.", + "type": "boolean" + }, + "srv_cpu_multiplier": { + "description": "Specify the number of SRV service worker threads per CPU.", + "maximum": 8, + "minimum": 1, + "type": "integer" + }, + "srv_num_workers": { + "description": "Set the maximum number of SRV service worker threads.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "support_multichannel": { + "description": "Support multichannel.", + "type": "boolean" + }, + "support_netbios": { + "description": "Support NetBIOS.", + "type": "boolean" + }, + "support_smb2": { + "description": "Support the SMB2 protocol on the server.", + "type": "boolean" + }, + "support_smb3_encryption": { + "description": "Support the SMB3 encryption on the server.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_GLOBAL" + }, + "v6SmbSettingsShare": { + "properties": { + "settings": { + "$ref": "#/definitions/v6SmbSettingsShareSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v6SmbSettingsShareSettings": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Specify level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Set the create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "directory_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on the share.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Allow oplock requests.", + "type": "boolean" + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone in which to update settings", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_SHARE" + }, + "v6SmbSettingsZone": { + "properties": { + "settings": { + "$ref": "#/definitions/v6SmbSettingsZoneSettings" + } + }, + "type": "object" + }, + "v6SmbSettingsZoneSettings": { + "properties": { + "access_based_share_enum": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "enable_security_signatures": { + "description": "Indicates whether the server supports signed SMB packets.", + "type": "boolean" + }, + "reject_unencrypted_access": { + "description": "If SMB3 encryption is enabled, reject unencrypted access from clients.", + "type": "boolean" + }, + "require_security_signatures": { + "description": "Indicates whether the server requires signed SMB packets.", + "type": "boolean" + }, + "server_side_copy": { + "description": "Enable Server Side Copy.", + "type": "boolean" + }, + "support_multichannel": { + "description": "Support multichannel.", + "type": "boolean" + }, + "support_smb2": { + "description": "Support the SMB2 protocol on the server.", + "type": "boolean" + }, + "support_smb3_encryption": { + "description": "Support the SMB3 encryption on the server.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_GLOBAL" + }, + "v6SmbShare": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_path": { + "description": "Create path if does not exist.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "v6SmbShareExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Share ID.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zid": { + "description": "Numeric ID of the access zone which contains this SMB share", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "path", + "id", + "zid", + "name" + ], + "type": "object" + }, + "v6SmbShareExtendedExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v6SmbShares": { + "additionalProperties": false, + "properties": { + "digest": { + "description": "An identifier for a set of shares.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "shares": { + "items": { + "$ref": "#/definitions/v6SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v6SmbSharesExtended": { + "additionalProperties": false, + "properties": { + "shares": { + "items": { + "$ref": "#/definitions/v6SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v7AntivirusSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v7AntivirusSettingsSettings" + } + }, + "type": "object" + }, + "v7AntivirusSettingsExtended": { + "additionalProperties": false, + "description": "Antivirus settings.", + "properties": { + "fail_open": { + "description": "Allow access when scanning fails.", + "type": "boolean" + }, + "glob_filters": { + "description": "Glob patterns for leaf filenames.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "glob_filters_enabled": { + "description": "Enable glob filters.", + "type": "boolean" + }, + "glob_filters_include": { + "description": "If true, only scan files matching a glob filter. If false, only scan files that don't match a glob filter.", + "type": "boolean" + }, + "path_prefixes": { + "description": "Paths to include in realtime scans.", + "items": { + "maxLength": 4096, + "minLength": 0, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "quarantine": { + "description": "Try to quarantine files when threats are found.", + "type": "boolean" + }, + "repair": { + "description": "Try to repair files when threats are found.", + "type": "boolean" + }, + "report_expiry": { + "description": "Amount of time in seconds until old reporting data is purged.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "scan_cloudpool_files": { + "description": "Scan files stored in CloudPools.", + "type": "boolean" + }, + "scan_on_close": { + "description": "Scan files when apps close them.", + "type": "boolean" + }, + "scan_on_open": { + "description": "Scan files on access.", + "type": "boolean" + }, + "scan_size_maximum": { + "description": "Skip scanning files larger than this.", + "maximum": 2147483648, + "minimum": 0, + "type": "integer" + }, + "service": { + "description": "Whether the antivirus service is enabled.", + "type": "boolean" + }, + "truncate": { + "description": "Try to truncate files when threats are found.", + "type": "boolean" + } + }, + "type": "object" + }, + "v7AntivirusSettingsSettings": { + "additionalProperties": false, + "description": "Antivirus settings.", + "properties": { + "fail_open": { + "description": "Allow access when scanning fails.", + "type": "boolean" + }, + "glob_filters": { + "description": "Glob patterns for leaf filenames.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "glob_filters_enabled": { + "description": "Enable glob filters.", + "type": "boolean" + }, + "glob_filters_include": { + "description": "If true, only scan files matching a glob filter. If false, only scan files that don't match a glob filter.", + "type": "boolean" + }, + "path_prefixes": { + "description": "Paths to include in realtime scans.", + "items": { + "maxLength": 4096, + "minLength": 0, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "quarantine": { + "description": "Try to quarantine files when threats are found.", + "type": "boolean" + }, + "repair": { + "description": "Try to repair files when threats are found.", + "type": "boolean" + }, + "report_expiry": { + "description": "Amount of time in seconds until old reporting data is purged.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "scan_cloudpool_files": { + "description": "Scan files stored in CloudPools.", + "type": "boolean" + }, + "scan_on_close": { + "description": "Scan files when apps close them.", + "type": "boolean" + }, + "scan_on_open": { + "description": "Scan files on access.", + "type": "boolean" + }, + "scan_size_maximum": { + "description": "Skip scanning files larger than this.", + "maximum": 2147483648, + "minimum": 0, + "type": "integer" + }, + "service": { + "description": "Whether the antivirus service is enabled.", + "type": "boolean" + }, + "truncate": { + "description": "Try to truncate files when threats are found.", + "type": "boolean" + } + }, + "required": [ + "repair", + "scan_on_close", + "service", + "fail_open", + "scan_on_open", + "report_expiry", + "quarantine", + "scan_size_maximum", + "path_prefixes", + "glob_filters_include", + "glob_filters", + "scan_cloudpool_files", + "truncate", + "glob_filters_enabled" + ], + "type": "object" + }, + "v7AuditSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v7AuditSettingsSettings" + } + }, + "type": "object" + }, + "v7AuditSettingsSettings": { + "description": "Per-Access Zone Audit settings", + "properties": { + "audit_failure": { + "description": "Filter of protocol operations to Audit when they fail.", + "items": { + "enum": [ + "close", + "close_directory", + "close_file", + "close_file_modified", + "close_file_unmodified", + "create", + "create_directory", + "create_file", + "delete", + "delete_directory", + "delete_file", + "get_security", + "get_security_directory", + "get_security_file", + "logoff", + "logon", + "open", + "open_directory", + "open_file", + "open_file_noaccess", + "open_file_read", + "open_file_write", + "read", + "read_file", + "rename", + "rename_directory", + "rename_file", + "set_security", + "set_security_directory", + "set_security_file", + "tree_connect", + "write", + "write_file" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "audit_success": { + "description": "Filter of protocol operations to Audit when they succeed.", + "items": { + "enum": [ + "close", + "close_directory", + "close_file", + "close_file_modified", + "close_file_unmodified", + "create", + "create_directory", + "create_file", + "delete", + "delete_directory", + "delete_file", + "get_security", + "get_security_directory", + "get_security_file", + "logoff", + "logon", + "open", + "open_directory", + "open_file", + "open_file_noaccess", + "open_file_read", + "open_file_write", + "read", + "read_file", + "rename", + "rename_directory", + "rename_file", + "set_security", + "set_security_directory", + "set_security_file", + "tree_connect", + "write", + "write_file" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "syslog_audit_events": { + "description": "Filter of Audit operations to forward to syslog.", + "items": { + "enum": [ + "close", + "close_directory", + "close_file", + "close_file_modified", + "close_file_unmodified", + "create", + "create_directory", + "create_file", + "delete", + "delete_directory", + "delete_file", + "get_security", + "get_security_directory", + "get_security_file", + "logoff", + "logon", + "open", + "open_directory", + "open_file", + "open_file_noaccess", + "open_file_read", + "open_file_write", + "read", + "read_file", + "rename", + "rename_directory", + "rename_file", + "set_security", + "set_security_directory", + "set_security_file", + "tree_connect", + "write", + "write_file" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "syslog_forwarding_enabled": { + "description": "Enables forwarding of events to syslog.", + "type": "boolean" + } + }, + "type": "object" + }, + "v7AuthError": { + "description": "Specifies the properties for auth error codes", + "properties": { + "code": { + "description": "Error code", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "description": { + "description": "Error description", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Error name", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7AuthLdapTemplates": { + "additionalProperties": false, + "properties": { + "ldap_configuration_templates": { + "items": { + "$ref": "#/definitions/v7AuthLdapTemplatesLdapConfigurationTemplate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7AuthLdapTemplatesLdapConfigurationTemplate": { + "description": "Configurable fields of LDAP Providers.", + "properties": { + "cn_attribute": { + "description": "Specifies canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "crypt_password_attribute": { + "description": "Sets hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Sets the LDAP Email attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gecos_attribute": { + "description": "Sets the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Sets the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Sets LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Sets the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "homedir_attribute": { + "description": "Sets the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the LDAP provider field template.", + "enum": [ + "default", + "ldapsam", + "rfc2307", + "rfc2307bis", + "ad-idmu" + ], + "type": "string" + }, + "member_lookup_method": { + "description": "Sets LDAP Member Lookup Method attribute.", + "enum": [ + "default", + "rfc2307bis" + ], + "type": "string" + }, + "name_attribute": { + "description": "Sets the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Sets LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Sets the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Sets the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nt_password_attribute": { + "description": "Sets the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_expire_attribute": { + "description": "Sets the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Sets the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid_attribute": { + "description": "Sets the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Sets LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7AuthUser": { + "description": "Specifies the configuration properties for a user.", + "properties": { + "dn": { + "description": "Specifies the distinguished name for the user.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "dns_domain": { + "description": "Specifies the DNS domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain": { + "description": "Specifies the domain that the object is part of.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email": { + "description": "Specifies an email address.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "enabled": { + "description": "True, if the authenticated user is enabled.", + "type": "boolean" + }, + "expired": { + "description": "True, if the authenticated user has expired.", + "type": "boolean" + }, + "expiry": { + "description": "Specifies the Unix Epoch time at which the authenticated user will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "gecos": { + "description": "Specifies the GECOS value, which is usually the full name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "generated_gid": { + "description": "True, if the GID was generated.", + "type": "boolean" + }, + "generated_uid": { + "description": "True, if the UID was generated.", + "type": "boolean" + }, + "generated_upn": { + "description": "True, if the UPN was generated.", + "type": "boolean" + }, + "gid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "home_directory": { + "description": "Specifies a home directory for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the user or group ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "locked": { + "description": "If true, indicates that the account is locked.", + "type": "boolean" + }, + "max_password_age": { + "description": "Specifies the maximum time in seconds allowed before the password expires.", + "type": "integer" + }, + "member_of": { + "description": "Specifies the groups that this user or group are members of.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "object_history": { + "items": { + "$ref": "#/definitions/v1AuthGroupObjectHistoryItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "on_disk_group_identity": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "on_disk_user_identity": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "password_expired": { + "description": "If true, the password has expired.", + "type": "boolean" + }, + "password_expires": { + "description": "If true, the password is allowed to expire.", + "type": "boolean" + }, + "password_expiry": { + "description": "Specifies the time in Unix Epoch seconds that the password will expire.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "password_last_set": { + "description": "Specifies the last time the password was set.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "primary_group_sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "prompt_password_change": { + "description": "Prompts the user to change their password at the next login.", + "type": "boolean" + }, + "provider": { + "description": "Specifies the authentication provider that the object belongs to.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sam_account_name": { + "description": "Specifies a user or group name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell": { + "description": "Specifies a path to the shell for the user.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "sid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ssh_public_keys": { + "description": "Specifies the user's LDAP SSH Public Key.", + "items": { + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "type": { + "description": "Specifies the object type.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "upn": { + "description": "Specifies a principal name for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_can_change_password": { + "description": "Specifies whether the password for the user can be changed.", + "type": "boolean" + } + }, + "required": [ + "domain", + "generated_gid", + "on_disk_group_identity", + "uid", + "password_expires", + "sam_account_name", + "dns_domain", + "password_expired", + "id", + "generated_upn", + "password_last_set", + "gid", + "provider", + "max_password_age", + "type", + "email", + "dn", + "shell", + "sid", + "expiry", + "on_disk_user_identity", + "password_expiry", + "user_can_change_password", + "expired", + "upn", + "locked", + "name", + "member_of", + "enabled", + "primary_group_sid", + "gecos", + "generated_uid", + "home_directory", + "prompt_password_change" + ], + "type": "object" + }, + "v7AuthUsers": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "users": { + "items": { + "$ref": "#/definitions/v7AuthUser" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_AUTH_USERS" + } + }, + "type": "object" + }, + "v7AuthUsersExtended": { + "additionalProperties": false, + "properties": { + "users": { + "items": { + "$ref": "#/definitions/v7AuthUser" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7CertificateAuthority": { + "additionalProperties": false, + "properties": { + "certificates": { + "items": { + "$ref": "#/definitions/v7CertificateAuthorityCertificate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7CertificateAuthorityCertificate": { + "properties": { + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "fingerprints": { + "description": "A list of zero or more certificate fingerprints which can be used for certificate identification.", + "items": { + "$ref": "#/definitions/v7CertificateAuthorityCertificateFingerprint" + }, + "maxItems": 100, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique server certificate identifier.", + "maxLength": 512, + "minLength": 1, + "type": "string" + }, + "issuer": { + "description": "Certificate issuer field extracted from the certificate.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "name": { + "description": "Administrator specified name identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + }, + "not_after": { + "description": "Certificate notAfter field extracted from the certificate encoded as a UNIX epoch timestamp. The certificate is not valid after this timestamp.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "not_before": { + "description": "Certificate notBefore field extracted from the certificate encoded as a UNIX epoch timestamp. The certificate is not valid before this timestamp.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "Certificate validity status", + "enum": [ + "valid", + "invalid", + "expired", + "expiring" + ], + "type": "string" + }, + "subject": { + "description": "Certificate subject field extracted from the certificate.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "status", + "description", + "not_after", + "fingerprints", + "name", + "not_before", + "subject", + "id", + "issuer" + ], + "type": "object" + }, + "v7CertificateAuthorityCertificateFingerprint": { + "properties": { + "type": { + "description": "Fingerprint hash algorithm", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "value": { + "description": "Fingerprint value", + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v7CertificateAuthorityExtended": { + "additionalProperties": false, + "properties": { + "certificates": { + "items": { + "$ref": "#/definitions/v7CertificateAuthorityCertificate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7CertificateAuthorityIdParams": { + "properties": { + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Administrator specified name identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + } + }, + "type": "object" + }, + "v7CertificateAuthorityItem": { + "properties": { + "certificate_path": { + "description": "Local path to the certificate that is to be imported.", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "description": { + "description": "Description field associated with a certificate provided for administrative convenience.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Administrator specified name identifier.", + "maxLength": 128, + "minLength": 0, + "pattern": "^[a-zA-Z0-9_-]*$", + "type": "string" + } + }, + "required": [ + "certificate_path" + ], + "type": "object" + }, + "v7CertificateSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v7CertificateSettingsSettings" + } + }, + "type": "object" + }, + "v7CertificateSettingsExtended": { + "properties": { + "certificate_monitor_enabled": { + "description": "Boolean value indicating whether certificate expiration monitoring is enabled.", + "type": "boolean" + }, + "certificate_pre_expiration_threshold": { + "description": "The number of seconds before certificate expiration that the certificate expiration monitor will start raising alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_https_certificate": { + "description": "ID of the server certificate to be used as the default HTTPS certificate.", + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v7CertificateSettingsSettings": { + "properties": { + "certificate_monitor_enabled": { + "description": "Boolean value indicating whether certificate expiration monitoring is enabled.", + "type": "boolean" + }, + "certificate_pre_expiration_threshold": { + "description": "The number of seconds before certificate expiration that the certificate expiration monitor will start raising alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_https_certificate": { + "description": "ID of the server certificate to be used as the default HTTPS certificate.", + "maxLength": 512, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "certificate_pre_expiration_threshold", + "certificate_monitor_enabled", + "default_https_certificate" + ], + "type": "object" + }, + "v7CertificatesPeer": { + "additionalProperties": false, + "properties": { + "certificates": { + "items": { + "$ref": "#/definitions/v7CertificateAuthorityCertificate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_CERTIFICATES_TARGET" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7CertificatesServer": { + "additionalProperties": false, + "properties": { + "certificates": { + "items": { + "$ref": "#/definitions/v4CertificateServerCertificate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_CERTIFICATES_SERVER" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7CloudAccount": { + "description": "A cloud account object", + "properties": { + "account_id": { + "description": "(S3 only) The user id of the S3 account", + "type": "string" + }, + "account_username": { + "description": "The username required to authenticate against the cloud service", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "birth_cluster_id": { + "description": "The guid of the cluster where this account was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "credential_provider": { + "$ref": "#/definitions/v7CloudAccountCredentialProvider" + }, + "enable_ocsp": { + "description": "(C2S-S3 only) Indicates whether to use OCSP to check the revocation status of the authentication certificate", + "type": "boolean" + }, + "enabled": { + "description": "Whether this account is explicitly enabled or disabled by a user", + "type": "boolean" + }, + "key": { + "description": "A valid authentication key for connecting to the cloud", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "A unique name for this account", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "ocsp_responder_url_required": { + "description": "(C2S-S3 only) Determines whether a certificate without an OCSP responder URL is considered valid or not", + "type": "boolean" + }, + "proxy": { + "description": "The id or name of a proxy to be used by this account", + "type": "string" + }, + "skip_ssl_validation": { + "description": "Indicates whether to skip peer verification of SSL certificates when connecting to the cloud", + "type": "boolean" + }, + "storage_region": { + "description": "An appropriate region for the account as defined by the cloud service provider. For example, faster access times may be gained by referencing a nearby region", + "type": "string" + }, + "telemetry_bucket": { + "description": "(S3 only) The name of the bucket into which generated metrics reports are placed by the cloud service provider", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "The type of cloud protocol required. E.g., \"isilon\" for Dell EMC PowerScale, \"ecs\" for Dell EMC ECS Appliance, \"virtustream\" for Virtustream Storage Cloud, \"azure\" for Microsoft Azure, \"s3\" for Amazon S3, \"c2s-s3\" for Amazon Commercial Cloud Services S3 and \"google\" for Google Cloud Platform and \"alibaba-cloud\" for Alibaba Cloud", + "enum": [ + "isilon", + "ecs", + "virtustream", + "azure", + "s3", + "c2s-s3", + "google", + "alibaba-cloud" + ], + "type": "string" + }, + "uri": { + "description": "A valid URI pointing to the location of the cloud storage", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "uri", + "type", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_ACCOUNTS" + }, + "v7CloudAccountCredentialProvider": { + "description": "(C2S-S3 only) Information to connect to a C2S Access Portal (CAP) server to request authentication credentials", + "properties": { + "agency": { + "description": "The agency name used to request credentials from the credential provider", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "certificate": { + "description": "The id or name of a certificate used to connect to the credential provider", + "maxLength": 512, + "minLength": 0, + "type": "string" + }, + "mission": { + "description": "The mission name used to request credentials from the credential provider", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "proxy": { + "description": "The id or name of a proxy used to connect to the credential provider", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "role": { + "description": "The role name used to request credentials from the credential provider", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "The type of credential provider", + "enum": [ + "c2s-s3" + ], + "type": "string" + }, + "uri": { + "description": "The URI of the credential provider", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7CloudAccountExtended": { + "description": "A cloud account object", + "properties": { + "account_id": { + "description": "(S3 only) The user id of the S3 account", + "type": "string" + }, + "account_username": { + "description": "The username required to authenticate against the cloud service", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "birth_cluster_id": { + "description": "The guid of the cluster where this account was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bucket": { + "description": "The machine generated name of the account bucket to store data", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "credential_provider": { + "$ref": "#/definitions/v7CloudAccountCredentialProvider" + }, + "enable_ocsp": { + "description": "(C2S-S3 only) Indicates whether to use OCSP to check the revocation status of the authentication certificate", + "type": "boolean" + }, + "enabled": { + "description": "Whether this account is explicitly enabled or disabled by a user", + "type": "boolean" + }, + "id": { + "description": "A globally unique name for this account", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "key": { + "description": "A valid authentication key for connecting to the cloud", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "metadata_bucket": { + "description": "The machine generated name of the account bucket to store metadata", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "A unique name for this account", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "ocsp_responder_url_required": { + "description": "(C2S-S3 only) Determines whether a certificate without an OCSP responder URL is considered valid or not", + "type": "boolean" + }, + "pool": { + "description": "Name of the pool referencing this account. Empty if none.", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "proxy": { + "description": "The id or name of a proxy to be used by this account", + "type": "string" + }, + "skip_account_check": { + "description": "(Not recommended) Indicates whether to skip validation that the cloud account is still accessible", + "type": "boolean" + }, + "skip_ssl_validation": { + "description": "Indicates whether to skip peer verification of SSL certificates when connecting to the cloud", + "type": "boolean" + }, + "state": { + "description": "Indicates whether this account is in a good state (\"OK\"), disabled (\"disabled\") or inaccessible via the network (\"unreachable\")", + "enum": [ + "OK", + "disabled", + "unreachable" + ], + "type": "string" + }, + "state_details": { + "description": "Gives further information to describe the state of this account", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "storage_region": { + "description": "An appropriate region for the account as defined by the cloud service provider. For example, faster access times may be gained by referencing a nearby region", + "type": "string" + }, + "telemetry_bucket": { + "description": "(S3 only) The name of the bucket into which generated metrics reports are placed by the cloud service provider", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "The type of cloud protocol required. E.g., \"isilon\" for Dell EMC PowerScale, \"ecs\" for Dell EMC ECS Appliance, \"virtustream\" for Virtustream Storage Cloud, \"azure\" for Microsoft Azure, \"s3\" for Amazon S3, \"c2s-s3\" for Amazon Commercial Cloud Services S3 and \"google\" for Google Cloud Platform and \"alibaba-cloud\" for Alibaba Cloud", + "enum": [ + "isilon", + "ecs", + "virtustream", + "azure", + "s3", + "c2s-s3", + "google", + "alibaba-cloud" + ], + "type": "string" + }, + "uri": { + "description": "A valid URI pointing to the location of the cloud storage", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7CloudAccountExtendedExtended": { + "description": "A cloud account object", + "properties": { + "account_id": { + "description": "(S3 only) The user id of the S3 account", + "type": "string" + }, + "account_username": { + "description": "The username required to authenticate against the cloud service", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "birth_cluster_id": { + "description": "The guid of the cluster where this account was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "credential_provider": { + "$ref": "#/definitions/v7CloudAccountCredentialProvider" + }, + "enable_ocsp": { + "description": "(C2S-S3 only) Indicates whether to use OCSP to check the revocation status of the authentication certificate", + "type": "boolean" + }, + "enabled": { + "description": "Whether this account is explicitly enabled or disabled by a user", + "type": "boolean" + }, + "key": { + "description": "A valid authentication key for connecting to the cloud", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "A unique name for this account", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "ocsp_responder_url_required": { + "description": "(C2S-S3 only) Determines whether a certificate without an OCSP responder URL is considered valid or not", + "type": "boolean" + }, + "proxy": { + "description": "The id or name of a proxy to be used by this account", + "type": "string" + }, + "skip_account_check": { + "description": "(Not recommended) Indicates whether to skip validation that the cloud account is still accessible", + "type": "boolean" + }, + "skip_ssl_validation": { + "description": "Indicates whether to skip peer verification of SSL certificates when connecting to the cloud", + "type": "boolean" + }, + "storage_region": { + "description": "An appropriate region for the account as defined by the cloud service provider. For example, faster access times may be gained by referencing a nearby region", + "type": "string" + }, + "telemetry_bucket": { + "description": "(S3 only) The name of the bucket into which generated metrics reports are placed by the cloud service provider", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uri": { + "description": "A valid URI pointing to the location of the cloud storage", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7CloudAccounts": { + "additionalProperties": false, + "properties": { + "accounts": { + "items": { + "$ref": "#/definitions/v7CloudAccountExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_ACCOUNTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7CloudAccountsExtended": { + "additionalProperties": false, + "properties": { + "accounts": { + "items": { + "$ref": "#/definitions/v7CloudAccountExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7CloudCertificates": { + "additionalProperties": false, + "properties": { + "certificates": { + "items": { + "$ref": "#/definitions/v7CertificateAuthorityCertificate" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_CERTIFICATES" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7CloudPool": { + "description": "A group of cloud accounts which will be the destination for file archiving", + "properties": { + "accounts": { + "description": "A list of valid names for the accounts in this pool. There is currently only one account allowed per pool.", + "items": { + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "birth_cluster_id": { + "description": "The guid of the cluster where this pool was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "A brief description of this pool", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "A unique name for this pool", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "The type of cloud protocol required. E.g., \"isilon\" for Dell EMC PowerScale, \"ecs\" for Dell EMC ECS Appliance, \"virtustream\" for Virtustream Storage Cloud, \"azure\" for Microsoft Azure, \"s3\" for Amazon S3, \"c2s-s3\" for Amazon Commercial Cloud Services S3 and \"google\" for Google Cloud Platform and \"alibaba-cloud\" for Alibaba Cloud", + "enum": [ + "isilon", + "ecs", + "virtustream", + "azure", + "s3", + "c2s-s3", + "google", + "alibaba-cloud" + ], + "type": "string" + }, + "vendor": { + "description": "A string identifier of the cloud services vendor", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "accounts", + "type", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_POOLS" + }, + "v7CloudPoolExtended": { + "description": "A group of cloud accounts which will be the destination for file archiving", + "properties": { + "accounts": { + "description": "A list of valid names for the accounts in this pool. There is currently only one account allowed per pool.", + "items": { + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "birth_cluster_id": { + "description": "The guid of the cluster where this pool was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "A brief description of this pool", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "A unique name for this pool", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "A unique name for this pool", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "state": { + "description": "Indicates whether this pool is in a good state (\"OK\") or disabled (\"disabled\")", + "enum": [ + "OK", + "disabled" + ], + "type": "string" + }, + "state_details": { + "description": "Gives further information to describe the state of this pool", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "The type of cloud protocol required. E.g., \"isilon\" for Dell EMC PowerScale, \"ecs\" for Dell EMC ECS Appliance, \"virtustream\" for Virtustream Storage Cloud, \"azure\" for Microsoft Azure, \"s3\" for Amazon S3, \"c2s-s3\" for Amazon Commercial Cloud Services S3 and \"google\" for Google Cloud Platform and \"alibaba-cloud\" for Alibaba Cloud", + "enum": [ + "isilon", + "ecs", + "virtustream", + "azure", + "s3", + "c2s-s3", + "google", + "alibaba-cloud" + ], + "type": "string" + }, + "vendor": { + "description": "A string identifier of the cloud services vendor", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7CloudPoolExtendedExtended": { + "description": "A group of cloud accounts which will be the destination for file archiving", + "properties": { + "accounts": { + "description": "A list of valid names for the accounts in this pool. There is currently only one account allowed per pool.", + "items": { + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "birth_cluster_id": { + "description": "The guid of the cluster where this pool was created", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "A brief description of this pool", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "A unique name for this pool", + "maxLength": 768, + "minLength": 0, + "type": "string" + }, + "vendor": { + "description": "A string identifier of the cloud services vendor", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7CloudPools": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v7CloudPoolExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_CLOUDPOOLS_POOLS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7CloudPoolsExtended": { + "additionalProperties": false, + "properties": { + "pools": { + "items": { + "$ref": "#/definitions/v7CloudPoolExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ClusterInternalNetworks": { + "additionalProperties": false, + "description": "Configuration fields for internal networks.", + "properties": { + "failover_ip_addresses": { + "description": "Array of IP address ranges to be used to configure the internal failover network of the OneFS cluster.", + "items": { + "$ref": "#/definitions/v7ClusterInternalNetworksFailoverIpAddresse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "failover_status": { + "description": "Status of failover network.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string" + }, + "int_a_fabric": { + "description": "Network fabric used for the primary network int-a.", + "enum": [ + "Ethernet", + "InfiniBand" + ], + "type": "string" + }, + "int_a_ip_addresses": { + "description": "Array of IP address ranges to be used to configure the internal int-a network of the OneFS cluster.", + "items": { + "$ref": "#/definitions/v7ClusterInternalNetworksFailoverIpAddresse" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "int_a_mtu": { + "description": "Maximum Transfer Unit (MTU) of the primary network int-a.", + "enum": [ + 1500, + 9000 + ], + "type": "integer" + }, + "int_a_prefix_length": { + "description": "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + "maximum": 128, + "minimum": 0, + "type": "integer" + }, + "int_a_status": { + "description": "Status of the primary network int-a.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string" + }, + "int_b_fabric": { + "description": "Network fabric used for the failover network.", + "enum": [ + "Ethernet", + "InfiniBand" + ], + "type": "string" + }, + "int_b_ip_addresses": { + "description": "Array of IP address ranges to be used to configure the internal int-b network of the OneFS cluster.", + "items": { + "$ref": "#/definitions/v7ClusterInternalNetworksFailoverIpAddresse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "int_b_mtu": { + "description": "Maximum Transfer Unit (MTU) of the failover network int-b.", + "enum": [ + 1500, + 9000 + ], + "type": "integer" + }, + "int_b_prefix_length": { + "description": "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + "maximum": 128, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ClusterInternalNetworksExtended": { + "additionalProperties": false, + "description": "Configuration fields for internal networks.", + "properties": { + "failover_ip_addresses": { + "description": "Array of IP address ranges to be used to configure the internal failover network of the OneFS cluster.", + "items": { + "$ref": "#/definitions/v7ClusterInternalNetworksFailoverIpAddresse" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "failover_status": { + "description": "Status of failover network.", + "enum": [ + "enabled", + "disabled" + ], + "type": "string" + }, + "int_a_ip_addresses": { + "description": "Array of IP address ranges to be used to configure the internal int-a network of the OneFS cluster.", + "items": { + "$ref": "#/definitions/v7ClusterInternalNetworksFailoverIpAddresse" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + }, + "int_a_prefix_length": { + "description": "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + "maximum": 128, + "minimum": 0, + "type": "integer" + }, + "int_b_ip_addresses": { + "description": "Array of IP address ranges to be used to configure the internal int-b network of the OneFS cluster.", + "items": { + "$ref": "#/definitions/v7ClusterInternalNetworksFailoverIpAddresse" + }, + "maxItems": 1, + "minItems": 0, + "type": "array" + }, + "int_b_prefix_length": { + "description": "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + "maximum": 128, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ClusterInternalNetworksFailoverIpAddresse": { + "description": "Specifies range of IP addresses where 'low' is starting address and 'high' is the end address.' Both 'low' and 'high' addresses are inclusive to the range.", + "properties": { + "high": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "low": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + } + }, + "required": [ + "high", + "low" + ], + "type": "object" + }, + "v7ClusterNode": { + "description": "Node information.", + "properties": { + "drive_d_config": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfig" + }, + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "hardware": { + "$ref": "#/definitions/v5ClusterNodeHardware" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "internal_ip_address": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "partitions": { + "$ref": "#/definitions/v10ClusterNodePartitions" + }, + "sensors": { + "$ref": "#/definitions/v10ClusterNodeSensors" + }, + "sleds": { + "description": "List of the sleds in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeSled" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "state": { + "$ref": "#/definitions/v10ClusterNodeState" + }, + "status": { + "$ref": "#/definitions/v10ClusterNodeStatus" + } + }, + "required": [ + "internal_ip_address" + ], + "type": "object" + }, + "v7ClusterNodes": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v7ClusterNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ClusterUpdateLnns": { + "additionalProperties": false, + "description": "Configuration fields for lnn.", + "properties": { + "lnns": { + "description": "Array of old and new logical node numbers.", + "items": { + "$ref": "#/definitions/v7ClusterUpdateLnnsLnn" + }, + "maxItems": 65535, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v7ClusterUpdateLnnsLnn": { + "description": "List of current and new logical node numbers.", + "properties": { + "current_lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "new_lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v7ClusterUpgradeItem": { + "description": "The settings necessary to start an upgrade.", + "properties": { + "install_image_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "nodes_to_rolling_upgrade": { + "description": "The nodes (to be) scheduled for upgrade ordered by queue position number. Null if the cluster_state is 'partially upgraded' or upgrade_type is 'simultaneous'. One of the following values: [, , ... ], 'all', null", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + }, + "patch_paths": { + "description": "List of additional patches to install during the upgrade.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "skip_optional": { + "description": "Used to indicate that the pre-upgrade check should be skipped.", + "type": "boolean" + }, + "upgrade_type": { + "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous'", + "maxLength": 128, + "minLength": 3, + "type": "string" + } + }, + "type": "object" + }, + "v7DatasetFilter": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v7DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v7DatasetFilterExtended": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "creation_time": { + "description": "Timestamp of when the filter was applied.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the filter configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The filter ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v7DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v7DatasetFilterMetricValues": { + "additionalProperties": false, + "description": "Configurable metrics.", + "properties": { + "groupname": { + "description": "groupname", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "local_address": { + "description": "Local IPv4, IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "path": { + "description": "Path of tracked directory", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "protocol": { + "description": "The protocol used for the request", + "enum": [ + "smb1", + "smb2" + ], + "type": "string" + }, + "remote_address": { + "description": "Client IPv4 or IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "share_name": { + "description": "SMB share name", + "maxLength": 320, + "minLength": 1, + "type": "string" + }, + "username": { + "description": "username", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "zone_name": { + "description": "The zone name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v7DatasetFilterMetricValuesExtended": { + "allOf": [ + { + "$ref": "#/definitions/v7DatasetFilterMetricValues" + }, + { + "description": "Performance metric values that can be used to pin workloads and apply filters, and performance metric values that are used to display information about the system performance dataset.", + "properties": { + "job_type": { + "description": "The job type.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "system_name": { + "description": "The system name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "v7DatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v7DatasetFilterExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v7DatasetWorkload": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v7DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v7DatasetWorkloadExtended": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "creation_time": { + "description": "Timestamp of when the workload was pinned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the workload configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The workload ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v7DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v7DatasetWorkloads": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "workloads": { + "items": { + "$ref": "#/definitions/v7DatasetWorkloadExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v7DatasetsDatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v7DatasetFilterExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v7DatasetsDatasetWorkloads": { + "additionalProperties": false, + "properties": { + "workloads": { + "items": { + "$ref": "#/definitions/v7DatasetWorkloadExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v7EventChannel": { + "description": "Named channel through which alerts can be delivered.", + "properties": { + "allowed_nodes": { + "description": "Nodes (LNNs) that can be masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "enabled": { + "description": "Channel is to be used or not.", + "type": "boolean" + }, + "excluded_nodes": { + "description": "Nodes (LNNs) that can NOT be the masters for this channel.", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Channel name, may not contain /.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "parameters": { + "$ref": "#/definitions/v12EventChannelsParameters" + }, + "system": { + "description": "Channel is a pre-defined system channel.", + "type": "boolean" + }, + "type": { + "description": "The mechanism used by the channel.", + "enum": [ + "connectemc", + "smtp", + "snmp", + "heartbeat" + ], + "type": "string" + } + }, + "type": "object" + }, + "v7EventChannels": { + "additionalProperties": false, + "properties": { + "channels": { + "items": { + "$ref": "#/definitions/v7EventChannel" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7EventEventlist": { + "description": "Events linked to an eventgroup occurrence.", + "properties": { + "event_count": { + "description": "Number of events linked to this eventgroup.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "eventgroup_instance": { + "description": "Unique identifier of eventgroup instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "events": { + "description": "List of all events linked to this eventgroup in chronological order.", + "items": { + "$ref": "#/definitions/v7EventEventlistEvent" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "id": { + "description": "Same as eventgroup_instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7EventEventlistEvent": { + "description": "Record of an event occurring on the cluster.", + "properties": { + "devid": { + "description": "The device id of the node if it is still part of the cluster otherwise None.", + "maximum": 65435, + "minimum": 0, + "type": "integer" + }, + "ended": { + "description": "Time event was ended (eventgroup resolved).", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "event": { + "description": "Integer identifier of the event type.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "Unique identifier of event occurrence.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lnn": { + "description": "The lnn of the node if it is still part of the cluster, otherwise None.", + "maximum": 65435, + "minimum": 0, + "type": "integer" + }, + "message": { + "description": "Human readable description.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "resolve_time": { + "description": "Time the event was resolved.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "severity": { + "description": "Severity of event occurrence.", + "enum": [ + "information", + "warning", + "critical", + "emergency", + "unknown" + ], + "type": "string" + }, + "specifier": { + "$ref": "#/definitions/Empty" + }, + "time": { + "description": "Time event was detected as UNIX timestamp.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "value": { + "description": "Value of measurement associated with this event.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "number" + } + }, + "type": "object" + }, + "v7EventEventlists": { + "additionalProperties": false, + "properties": { + "eventlists": { + "items": { + "$ref": "#/definitions/v7EventEventlist" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7EventEventlistsExtended": { + "additionalProperties": false, + "properties": { + "eventlists": { + "items": { + "$ref": "#/definitions/v7EventEventlist" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7GroupnetsGroupnetSubnet": { + "properties": { + "description": { + "description": "A description of the subnet.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "dsr_addrs": { + "description": "List of Direct Server Return addresses.", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 128, + "minItems": 0, + "type": "array" + }, + "gateway": { + "description": "Gateway IP address.", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "gateway_priority": { + "description": "Gateway priority.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "mtu": { + "description": "MTU of the subnet.", + "maximum": 9000, + "minimum": 576, + "type": "integer" + }, + "name": { + "description": "The name of the subnet.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[0-9a-zA-Z_-]*$", + "type": "string" + }, + "prefixlen": { + "description": "Subnet Prefix Length.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "sc_service_addrs": { + "description": "List of IP addresses that SmartConnect listens for DNS requests.", + "items": { + "$ref": "#/definitions/v12GroupnetSubnetScServiceAddr" + }, + "maxItems": 32, + "minItems": 0, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "array" + }, + "sc_service_name": { + "description": "Domain Name corresponding to the SmartConnect Service Address.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^$|^[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]*)*$", + "type": "string" + }, + "vlan_enabled": { + "description": "VLAN tagging enabled or disabled.", + "type": "boolean" + }, + "vlan_id": { + "description": "VLAN ID for all interfaces in the subnet.", + "maximum": 4094, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v7GroupnetsGroupnetSubnets": { + "additionalProperties": false, + "properties": { + "subnets": { + "items": { + "$ref": "#/definitions/v12GroupnetSubnetExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7HdfsCryptoSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v7HdfsCryptoSettingsSettings" + } + }, + "type": "object" + }, + "v7HdfsCryptoSettingsSettings": { + "description": "HDFS Encryption settings.", + "properties": { + "kms_url": { + "description": "Key Management Server URL. If null then TDE is not enabled.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7HistoryNetwork": { + "additionalProperties": false, + "properties": { + "statistics": { + "items": { + "$ref": "#/definitions/v7HistoryNetworkStatistic" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7HistoryNetworkStatistic": { + "allOf": [ + { + "$ref": "#/definitions/v3HistoryCpuStatistic" + }, + { + "description": "A synciq performance report.", + "properties": { + "name": { + "description": "The name of the SyncIQ policy if specified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + ] + }, + "v7IdResolutionDomains": { + "additionalProperties": false, + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of id resolution errors that occurred during the bulk resolution. This list is included with a successful response.", + "items": { + "$ref": "#/definitions/v7IdResolutionDomainsError" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "paths": { + "items": { + "$ref": "#/definitions/v7IdResolutionDomainsPath" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7IdResolutionDomainsError": { + "additionalProperties": false, + "description": "Object describes the failed resolution of an id.", + "properties": { + "field": { + "description": "Identifies the type of id.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "field_value": { + "description": "A requested id that encountered an error during resolution.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "message": { + "description": "Error message describes the failed resolution.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7IdResolutionDomainsExtended": { + "additionalProperties": false, + "properties": { + "paths": { + "items": { + "$ref": "#/definitions/v7IdResolutionDomainsPath" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7IdResolutionDomainsPath": { + "description": "Maps a domain id to a file path.", + "properties": { + "domain": { + "description": "Domain ID. The domain ID assigned to a directory.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The full path associated with the domain id. null if the domain id cannot be resolved to a path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7IdResolutionLins": { + "additionalProperties": false, + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of id resolution errors that occurred during the bulk resolution. This list is included with a successful response.", + "items": { + "$ref": "#/definitions/v7IdResolutionDomainsError" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "paths": { + "items": { + "$ref": "#/definitions/v7IdResolutionLinsPath" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7IdResolutionLinsExtended": { + "additionalProperties": false, + "properties": { + "paths": { + "items": { + "$ref": "#/definitions/v7IdResolutionLinsPath" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7IdResolutionLinsPath": { + "description": "Maps a lin to a file path.", + "properties": { + "lin": { + "description": "Logical Inode Number (LIN). A 64-bit number which uniquely identifies a file throughout its life.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "path": { + "description": "The full path associated with the lin. null if the lin cannot be resolved to a path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7IdResolutionZone": { + "description": "Maps a zone id to a zone name.", + "properties": { + "zone_id": { + "description": "Zone ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "zone_name": { + "description": "The zone name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7IdResolutionZones": { + "additionalProperties": false, + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of id resolution errors that occurred during the bulk resolution. This list is included with a successful response.", + "items": { + "$ref": "#/definitions/v7IdResolutionDomainsError" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "zones": { + "items": { + "$ref": "#/definitions/v7IdResolutionZone" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7IdResolutionZonesExtended": { + "additionalProperties": false, + "properties": { + "zones": { + "items": { + "$ref": "#/definitions/v7IdResolutionZone" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7JobJob": { + "properties": { + "allow_dup": { + "description": "Whether or not to queue the job if one of the same type is already running or queued.", + "type": "boolean" + }, + "avscan_params": { + "$ref": "#/definitions/v10JobJobAvscanParams" + }, + "changelistcreate_params": { + "$ref": "#/definitions/v1JobJobChangelistcreateParams" + }, + "domainmark_params": { + "$ref": "#/definitions/v1JobJobDomainmarkParams" + }, + "esrsmftdownload_params": { + "$ref": "#/definitions/v1JobJobEsrsmftdownloadParams" + }, + "filepolicy_params": { + "$ref": "#/definitions/v10JobJobFilepolicyParams" + }, + "paths": { + "description": "For jobs which take paths, the IFS paths to pass to the job.", + "items": { + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "policy": { + "description": "Impact policy of this job instance.", + "maxLength": 254, + "minLength": 1, + "type": "string" + }, + "prepair_params": { + "$ref": "#/definitions/v1JobJobPrepairParams" + }, + "priority": { + "description": "Priority of this job instance; lower numbers preempt higher numbers.", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "smartpoolstree_params": { + "$ref": "#/definitions/v1JobJobSmartpoolstreeParams" + }, + "snaprevert_params": { + "$ref": "#/definitions/v1JobJobSnaprevertParams" + }, + "treedelete_params": { + "$ref": "#/definitions/v10JobJobTreedeleteParams" + }, + "type": { + "description": "Job type to queue.", + "maxLength": 100, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "v7JobJobSummary": { + "properties": { + "summary": { + "$ref": "#/definitions/v7JobJobSummarySummary" + } + }, + "type": "object" + }, + "v7JobJobSummarySummary": { + "properties": { + "cluster_is_degraded": { + "description": "Whether the cluster is in a degraded state. Note this is from the perspective of the node handling the query, which might be different from another node.", + "type": "boolean" + }, + "connected": { + "description": "Whether isi_job_d instances on all up nodes in the cluster are connected to the coordinator.", + "type": "boolean" + }, + "coordinator": { + "description": "The devid of the job engine coordinator.", + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "coordinator_lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "disconnected_nodes": { + "description": "If connected=false, this is the set of devids that are not connected to the coordinator.", + "items": { + "maximum": 65435, + "minimum": 1, + "type": "integer" + }, + "type": "array" + }, + "down_or_read_only_nodes": { + "description": "Whether the cluster has any down or read-only nodes. These nodes are not considered in the connected property.", + "type": "boolean" + }, + "job_d_enabled": { + "description": "Whether the isi_job_d is enabled.", + "type": "boolean" + }, + "next_jid": { + "description": "The job ID to be assigned to the next job.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "run_degraded": { + "description": "Whether the job engine would allow most jobs to run even when the cluster is in a degraded state.", + "type": "boolean" + }, + "stats_ready": { + "description": "Whether the coordinator has recently gathered statistics for all nodes in the cluster.", + "type": "boolean" + } + }, + "required": [ + "down_or_read_only_nodes", + "stats_ready", + "next_jid", + "coordinator", + "connected", + "cluster_is_degraded", + "run_degraded", + "job_d_enabled" + ], + "type": "object" + }, + "v7JobJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v10JobJobExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7JobReport": { + "properties": { + "flags": { + "description": "Event flags.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "fmt_type": { + "description": "A string representing the type of the 'value' property for formatting processing.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Job event ID.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "job_id": { + "description": "Job ID.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "job_type": { + "description": "Job Type.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "key": { + "description": "Event key name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "phase": { + "description": "Job phase number at time of event.", + "maximum": 15, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "job's status", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "time": { + "description": "Time of event in Unix epoch seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "value": { + "description": "Event value.", + "type": "string" + } + }, + "required": [ + "status", + "fmt_type", + "job_id", + "job_type", + "value", + "flags", + "key", + "time", + "phase", + "id" + ], + "type": "object" + }, + "v7JobReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v7JobReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7NfsSettingsGlobal": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v7NfsSettingsGlobalSettings" + } + }, + "type": "object" + }, + "v7NfsSettingsGlobalSettings": { + "description": "Specifies the global NFS configuration settings.", + "properties": { + "nfsv3_enabled": { + "description": "True if NFSv3 is enabled.", + "type": "boolean" + }, + "nfsv4_enabled": { + "description": "True if NFSv4 is enabled.", + "type": "boolean" + }, + "rpc_maxthreads": { + "description": "Specifies the maximum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "rpc_minthreads": { + "description": "Specifies the minimum number of threads in the nfsd thread pool.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "rquota_enabled": { + "description": "True if the rquota protocol is enabled.", + "type": "boolean" + }, + "service": { + "description": "True if the NFS service is enabled. When set to false, the NFS service is disabled.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_NFS_SETTINGS_GLOBAL" + }, + "v7NodeDriveconfig": { + "additionalProperties": false, + "properties": { + "nodes": { + "items": { + "$ref": "#/definitions/v7NodeDriveconfigNode" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7NodeDriveconfigExtended": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "instant_secure_erase": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigInstantSecureErase" + } + }, + "type": "object" + }, + "v7NodeDriveconfigNode": { + "description": "An object containing a node's drive subsystem XML configuration file.", + "properties": { + "alert": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAlert" + }, + "allow": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAllow" + }, + "automatic_replacement_recognition": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigAutomaticReplacementRecognition" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "instant_secure_erase": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigInstantSecureErase" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "log": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigLog" + }, + "reboot": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigReboot" + }, + "spin_wait": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigSpinWait" + }, + "stall": { + "$ref": "#/definitions/v10ClusterNodeDriveDConfigStall" + } + }, + "type": "object" + }, + "v7NodeDrives": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v7NodeDrivesNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7NodeDrivesNode": { + "description": "Information about this node's drives.", + "properties": { + "drives": { + "description": "List of the drives in this node.", + "items": { + "$ref": "#/definitions/v10ClusterNodeDrive" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7NodeInternalIpAddress": { + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + "items": { + "$ref": "#/definitions/v11NodeStatusError" + }, + "maxItems": 65535, + "minItems": 0, + "type": "array" + }, + "nodes": { + "description": "The responses from the individual nodes involved in this request.", + "items": { + "$ref": "#/definitions/v7NodeInternalIpAddressNode" + }, + "maxItems": 2147483647, + "minItems": 1, + "type": "array" + }, + "total": { + "description": "The total number of nodes responding.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7NodeInternalIpAddressNode": { + "properties": { + "error": { + "description": "Error message, if the HTTP status returned from this node was not 200.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Node ID (Device Number) of a node.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "internal_ip_address": { + "description": "IPv4 address in the format: xxx.xxx.xxx.xxx", + "maxLength": 45, + "minLength": 2, + "pattern": "^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$", + "type": "string" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "status": { + "description": "Status of the HTTP response from this node if not 200. If 200, this field does not appear.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "internal_ip_address" + ], + "type": "object" + }, + "v7PerformanceDataset": { + "additionalProperties": false, + "description": "A performance dataset configured to track different sets of performance workloads.", + "properties": { + "filters": { + "description": "Filtered metrics for configuring this dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 0, + "type": "array" + }, + "metrics": { + "description": "Performance metrics defining the dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 1, + "type": "array" + }, + "name": { + "description": "The name of the performance dataset. If a name is not specified then a default name is assigned. The default name will be an underscore separated list of the performance metrics and filters used to configure the dataset.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metrics" + ], + "type": "object" + }, + "v7PerformanceDatasetExtended": { + "additionalProperties": false, + "description": "A performance dataset configured to track different sets of performance workloads.", + "properties": { + "creation_time": { + "description": "Timestamp of when the dataset was created.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "filter_count": { + "description": "Number of filters applied to this dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "filters": { + "description": "Filtered metrics for configuring this dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset, and performance metrics used by the default system performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "job_type", + "system_name" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "Unique identifier for the configured dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metrics": { + "description": "Performance metrics defining the dataset.", + "items": { + "description": "Performance metrics that can be used to configure a performance dataset, and performance metrics used by the default system performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "job_type", + "system_name" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 1, + "type": "array" + }, + "name": { + "description": "The name of the performance dataset. If a name is not specified then a default name is assigned. The default name will be an underscore separated list of the performance metrics and filters used to configure the dataset.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "statkey": { + "description": "Key for use in viewing associated raw statistics under the endpoints /statistics/history and /statistics/current.", + "maxLength": 29, + "minLength": 29, + "type": "string" + }, + "workload_count": { + "description": "Number of workloads pinned to this dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "name", + "filter_count", + "creation_time", + "metrics", + "statkey", + "workload_count", + "filters", + "id" + ], + "type": "object" + }, + "v7PerformanceDatasets": { + "additionalProperties": false, + "properties": { + "datasets": { + "items": { + "$ref": "#/definitions/v7PerformanceDatasetExtended" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7PerformanceDatasetsExtended": { + "additionalProperties": false, + "properties": { + "datasets": { + "items": { + "$ref": "#/definitions/v7PerformanceDatasetExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v7PerformanceMetric": { + "additionalProperties": false, + "description": "A performance metric.", + "properties": { + "datatype": { + "description": "The data type of the performance metric.", + "enum": [ + "integer", + "string" + ], + "type": "string" + }, + "description": { + "description": "Text description of the performance metric.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Performance metrics that can be used to configure a performance dataset, and performance metrics used by the default system performance dataset.", + "enum": [ + "groupname", + "local_address", + "path", + "protocol", + "remote_address", + "share_name", + "username", + "zone_name", + "job_type", + "system_name" + ], + "type": "string" + }, + "system_only": { + "description": "A 'system_only' metric is reserved for use by the system. This metric cannot be used to configure a new dataset.", + "type": "boolean" + }, + "value_set": { + "description": "The set of applicable values for the metric.", + "type": "string" + } + }, + "type": "object" + }, + "v7PerformanceMetrics": { + "additionalProperties": false, + "properties": { + "metrics": { + "items": { + "$ref": "#/definitions/v7PerformanceMetric" + }, + "maxItems": 10, + "minItems": 10, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7PerformanceMetricsExtended": { + "additionalProperties": false, + "properties": { + "metrics": { + "items": { + "$ref": "#/definitions/v7PerformanceMetric" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v7PoolsPoolInterfaces": { + "additionalProperties": false, + "properties": { + "interfaces": { + "items": { + "$ref": "#/definitions/v7PoolsPoolInterfacesInterface" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7PoolsPoolInterfacesInterface": { + "properties": { + "id": { + "description": "Unique interface ID.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ip_addrs": { + "description": "List of IP addresses", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lnn": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "name": { + "description": "The name of the interface.", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "nic_name": { + "description": "NIC name", + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "owners": { + "description": "List of owners (membership)", + "items": { + "$ref": "#/definitions/v7PoolsPoolInterfacesInterfaceOwner" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Status of the interface", + "enum": [ + "up", + "no_carrier", + "active", + "inactive", + "disabled", + "unknown" + ], + "type": "string" + }, + "type": { + "description": "Interface type. The '*gige' types stand for 'gigabit ethernet'. 'gige' itself is occasionally also referred to in other places as 'ext' for 'external'. 'ib' and 'ib_qdr' are internal Infiniband interface types. 'vlan' and 'vmxnet3' are virtual interface types that appear on virtual nodes. 'loopback' is an interface for failover addresses and should only appear if failover is configured.", + "enum": [ + "any", + "gige", + "fastgige", + "10gige", + "25gige", + "40gige", + "100gige", + "mgmt", + "ib", + "ib_qdr", + "ib_fdr", + "aggregated", + "vlan", + "vmxnet3", + "loopback" + ], + "type": "string" + } + }, + "required": [ + "status", + "owners", + "name", + "nic_name", + "ip_addrs", + "lnn", + "type", + "id" + ], + "type": "object" + }, + "v7PoolsPoolInterfacesInterfaceOwner": { + "properties": { + "groupnet": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "ip_addrs": { + "description": "List of IP addresses in this owner", + "items": { + "maxLength": 40, + "minLength": 1, + "pattern": "(^([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])(\\.([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])){3}$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5}::([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?$|^[0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){7}$)", + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "pool": { + "maxLength": 32, + "minLength": 1, + "type": "string" + }, + "subnet": { + "maxLength": 32, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersAds": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v7ProvidersAdsAdsItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersAdsAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "extra_expected_spns": { + "description": "List of additional SPNs to expect beyond what automatic checking routines might find", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "forest": { + "description": "Specifies the Active Directory forest.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname": { + "description": "Specifies the fully qualified hostname stored in the machine account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "instance": { + "description": "Specifies Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_account": { + "description": "Specifies the machine account name when creating a SAM account with Active Directory.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "netbios_domain": { + "description": "Specifies the NetBIOS domain name associated with the machine account.", + "maxLength": 15, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "primary_domain": { + "description": "Specifies the AD domain to which the provider is joined.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "site": { + "description": "Specifies the site for the Active Directory.", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "system": { + "description": "If set to true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersAdsAdsItemExtended": { + "allOf": [ + { + "$ref": "#/definitions/v7ProvidersAdsAdsItem" + }, + { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "recommended_spns": { + "description": "Configuration recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "spns": { + "description": "Currently configured SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "v7ProvidersAdsExtended": { + "additionalProperties": false, + "properties": { + "ads": { + "items": { + "$ref": "#/definitions/v7ProvidersAdsAdsItemExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersAdsIdParams": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "domain_controller": { + "description": "Specifies the domain controller to which the authentication service should send requests", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "extra_expected_spns": { + "description": "List of additional SPNs to expect beyond what automatic checking routines might find", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "password": { + "description": "Specifies the password used during domain join.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "reset_schannel": { + "description": "Resets the secure channel to the primary domain.", + "type": "boolean" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "spns": { + "description": "Currently configured SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "description": "Specifies the user name that has permission to join a machine to the given domain.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersAdsItem": { + "description": "Specifies the properties for an ADS authentication provider.", + "properties": { + "allocate_gids": { + "description": "Allocates an ID for an unmapped Active Directory (ADS) group. ADS groups without GIDs can be proactively assigned a GID by the ID mapper. If the ID mapper option is disabled, GIDs are not proactively assigned, and when a primary group for a user does not include a GID, the system may allocate one. ", + "type": "boolean" + }, + "allocate_uids": { + "description": "Allocates a user ID for an unmapped Active Directory (ADS) user. ADS users without UIDs can be proactively assigned a UID by the ID mapper. IF the ID mapper option is disabled, UIDs are not proactively assigned, and when an identify for a user does not include a UID, the system may allocate one.", + "type": "boolean" + }, + "assume_default_domain": { + "description": "Enables lookup of unqualified user names in the primary domain.", + "type": "boolean" + }, + "authentication": { + "description": "Enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "controller_time": { + "description": "Specifies the current time for the domain controllers.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "dns_domain": { + "description": "Specifies the DNS search domain. Set this parameter if the DNS search domain has a unique name or address.", + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "domain_offline_alerts": { + "description": "Sends an alert if the domain goes offline.", + "type": "boolean" + }, + "extra_expected_spns": { + "description": "List of additional SPNs to expect beyond what automatic checking routines might find", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_groups": { + "description": "Sets list of groups that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Sets list of users that can be resolved.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "ignore_all_trusts": { + "description": "If set to true, ignores all trusted domains.", + "type": "boolean" + }, + "ignored_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to false.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "include_trusted_domains": { + "description": "Includes trusted domains when 'ignore_all_trusts' is set to true.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "instance": { + "description": "Specifies Active Directory provider instance.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "kerberos_hdfs_spn": { + "description": "Determines if connecting through HDFS with Kerberos.", + "type": "boolean" + }, + "kerberos_nfs_spn": { + "description": "Determines if connecting through NFS with Kerberos.", + "type": "boolean" + }, + "ldap_sign_and_seal": { + "description": "Enables encryption and signing on LDAP requests.", + "type": "boolean" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "lookup_domains": { + "description": "Limits user and group lookups to the specified domains.", + "items": { + "maxLength": 255, + "minLength": 2, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "lookup_groups": { + "description": "Looks up AD groups in other providers before allocating a group ID.", + "type": "boolean" + }, + "lookup_normalize_groups": { + "description": "Normalizes AD group names to lowercase before look up.", + "type": "boolean" + }, + "lookup_normalize_users": { + "description": "Normalize AD user names to lowercase before look up.", + "type": "boolean" + }, + "lookup_users": { + "description": "Looks up AD users in other providers before allocating a user ID.", + "type": "boolean" + }, + "machine_account": { + "description": "Specifies the machine account name when creating a SAM account with Active Directory.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "machine_password_changes": { + "description": "Enables periodic changes of the machine password for security.", + "type": "boolean" + }, + "machine_password_lifespan": { + "description": "Sets maximum age of a password in seconds.", + "maximum": 31536000, + "minimum": 3600, + "type": "integer" + }, + "name": { + "description": "Specifies the Active Directory provider name.", + "maxLength": 64, + "minLength": 1, + "type": "string" + }, + "node_dc_affinity": { + "description": "Specifies the domain controller for which the node has affinity.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "node_dc_affinity_timeout": { + "description": "Specifies the timeout for the domain controller for which the local node has affinity.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "nss_enumeration": { + "description": "Enables the Active Directory provider to respond to 'getpwent' and 'getgrent' requests.", + "type": "boolean" + }, + "organizational_unit": { + "description": "Specifies the organizational unit.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the password used during domain join.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "Check the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "sfu_support": { + "description": "Specifies whether to support RFC 2307 attributes on ADS domain controllers.", + "enum": [ + "none", + "rfc2307" + ], + "type": "string" + }, + "store_sfu_mappings": { + "description": "Stores SFU mappings permanently in the ID mapper.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user": { + "description": "Specifies the user name that has permission to join a machine to the given domain.", + "maxLength": 256, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "user", + "password", + "name" + ], + "type": "object" + }, + "v7ProvidersDuo": { + "properties": { + "settings": { + "$ref": "#/definitions/v7ProvidersDuoSettings" + } + }, + "type": "object" + }, + "v7ProvidersDuoExtended": { + "description": "Specifies the properties for the Duo provider.", + "properties": { + "autopush": { + "description": "Specifies if Duo automatically sends a push login request to the users phone.", + "type": "boolean" + }, + "enabled": { + "description": "Specifies if the Duo provider is enabled.", + "type": "boolean" + }, + "failmode": { + "description": "Specifies if Duo will fail \"safe\" (allow access) or \"secure\" (deny access) on configuration or service errors.", + "enum": [ + "safe", + "secure" + ], + "type": "string" + }, + "fallback_local_ip": { + "description": "Specifies if Duo will report the server IP if the client IP cannot be detected.", + "type": "boolean" + }, + "groups": { + "description": "Specifies a list of groups Duo is required for (default is all groups).", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "host": { + "description": "Specifies the API hostname.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "http_proxy": { + "description": "Specifies the HTTP proxy to use.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "https_timeout": { + "description": "Specifies the number of seconds to wait for HTTPS responses from Duo Security.", + "maximum": 600, + "minimum": 0, + "type": "integer" + }, + "ikey": { + "description": "Specifies the integration key.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9]*$", + "type": "string" + }, + "prompts": { + "description": "Specifies the maximum number of authentication prompts to display (1-3 default is 3).", + "maximum": 3, + "minimum": 1, + "type": "integer" + }, + "pushinfo": { + "description": "Specifies to include information in the Duo Push message.", + "type": "boolean" + }, + "skey": { + "description": "Specifies the secret key.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9]*$", + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersDuoSettings": { + "description": "Specifies the properties for the Duo provider.", + "properties": { + "autopush": { + "description": "Specifies if Duo automatically sends a push login request to the users phone.", + "type": "boolean" + }, + "enabled": { + "description": "Specifies if the Duo provider is enabled.", + "type": "boolean" + }, + "failmode": { + "description": "Specifies if Duo will fail \"safe\" (allow access) or \"secure\" (deny access) on configuration or service errors.", + "enum": [ + "safe", + "secure" + ], + "type": "string" + }, + "fallback_local_ip": { + "description": "Specifies if Duo will report the server IP if the client IP cannot be detected.", + "type": "boolean" + }, + "groups": { + "description": "Specifies a list of groups Duo is required for (default is all groups).", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "host": { + "description": "Specifies the API hostname.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "http_proxy": { + "description": "Specifies the HTTP proxy to use.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "https_timeout": { + "description": "Specifies the number of seconds to wait for HTTPS responses from Duo Security.", + "maximum": 600, + "minimum": 0, + "type": "integer" + }, + "ikey": { + "description": "Specifies the integration key.", + "maxLength": 256, + "minLength": 0, + "pattern": "^[A-Za-z0-9]*$", + "type": "string" + }, + "prompts": { + "description": "Specifies the maximum number of authentication prompts to display (1-3 default is 3).", + "maximum": 3, + "minimum": 1, + "type": "integer" + }, + "pushinfo": { + "description": "Specifies to include information in the Duo Push message.", + "type": "boolean" + } + }, + "required": [ + "pushinfo", + "ikey", + "fallback_local_ip", + "autopush", + "http_proxy", + "enabled", + "prompts", + "host", + "failmode", + "groups", + "https_timeout" + ], + "type": "object" + }, + "v7ProvidersFile": { + "additionalProperties": false, + "properties": { + "file": { + "items": { + "$ref": "#/definitions/v7ProvidersFileFileItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersFileFileItem": { + "description": "Specifies the properties for an authentication file provider", + "properties": { + "authentication": { + "description": "Enables authentication and identity mapping through the authentication provider.", + "type": "boolean" + }, + "create_home_directory": { + "description": "Automatically creates a home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "Enables the file provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "Enables the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "Enables the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which domains are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_file": { + "description": "Specifies the location of the file that contains information about the group.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "id": { + "description": "Specifies the file provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "modifiable_groups": { + "description": "Specifies the groups that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "modifiable_users": { + "description": "Specifies the users that can be modified in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "Specifies the name of the file provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_file": { + "description": "Specifies the path to a netgroups replacement file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "password_file": { + "description": "Specifies the location of the file containing information about users.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "restrict_modifiable": { + "description": "If true, checks the provider for filtered lists of modifiable and unmodifiable users and groups.", + "type": "boolean" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_groups": { + "description": "Specifies a group that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unmodifiable_users": { + "description": "Specifies a user that cannot be modified by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersKrb5": { + "additionalProperties": false, + "properties": { + "krb5": { + "items": { + "$ref": "#/definitions/v7ProvidersKrb5Krb5Item" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersKrb5Extended": { + "additionalProperties": false, + "properties": { + "krb5": { + "items": { + "$ref": "#/definitions/v7ProvidersKrb5Krb5ItemExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersKrb5Krb5Item": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the Kerberos provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPNs.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "Specifies the Kerberos provider password.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "recommended_spns": { + "description": "Specifies the recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed", + "type": "boolean" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersKrb5Krb5ItemExtended": { + "description": "Specifies properties for the Kerberos authentication provider.", + "properties": { + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the Kerberos provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "keytab_entries": { + "description": "Specifies the key information for the Kerberos SPNs.", + "items": { + "$ref": "#/definitions/v1ProvidersKrb5ItemKeytabEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "keytab_file": { + "description": "Specifies the path to a keytab file to import.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "manual_keying": { + "description": "If true, keys are managed manually. If false, keys are managed through kadmin.", + "type": "boolean" + }, + "name": { + "description": "Specifies the Kerberos provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "realm": { + "description": "Specifies the name of realm.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "recommended_spns": { + "description": "Specifies the recommended SPNs.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed", + "type": "boolean" + }, + "user": { + "description": "Specifies the name of the user that performs kadmin tasks.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersLdap": { + "additionalProperties": false, + "properties": { + "ldap": { + "items": { + "$ref": "#/definitions/v7ProvidersLdapLdapItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersLdapIdParams": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_lookup_method": { + "description": "Sets the method by which group member lookups are performed. Use caution when changing this option directly.", + "enum": [ + "default", + "rfc2307bis" + ], + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ssh_public_key_attribute": { + "description": "Sets the attribute name that indicates the SSH Public Key for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "template": { + "description": "Specifies template to be used to create the LDAP provider. The list of templates can be found at /auth/ldap-templates. Any fields directly defined in your request will override the template values.", + "enum": [ + "default", + "ldapsam", + "rfc2307", + "rfc2307bis", + "ad-idmu" + ], + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_password": { + "description": "Specifies the password for the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_lookup_method": { + "description": "Sets the method by which group member lookups are performed. Use caution when changing this option directly.", + "enum": [ + "default", + "rfc2307bis" + ], + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ssh_public_key_attribute": { + "description": "Sets the attribute name that indicates the SSH Public Key for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "template": { + "description": "Specifies template to be used to create the LDAP provider. The list of templates can be found at /auth/ldap-templates. Any fields directly defined in your request will override the template values.", + "enum": [ + "default", + "ldapsam", + "rfc2307", + "rfc2307bis", + "ad-idmu" + ], + "type": "string" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + } + }, + "required": [ + "base_dn", + "server_uris", + "name" + ], + "type": "object" + }, + "v7ProvidersLdapLdapItem": { + "description": "Specifies the properties for the LDAP authentication provider.", + "properties": { + "alternate_security_identities_attribute": { + "description": "Specifies the attribute name used when searching for alternate security identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "base_dn": { + "description": "Specifies the root of the tree in which to search identities.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_dn": { + "description": "Specifies the distinguished name for binding to the LDAP server.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "bind_mechanism": { + "description": "Specifies which bind mechanism to use when connecting to an LDAP server. The only supported option is the 'simple' value.", + "enum": [ + "simple", + "gssapi", + "digest-md5" + ], + "type": "string" + }, + "bind_timeout": { + "description": "Specifies the timeout in seconds when binding to an LDAP server.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "certificate_authority_file": { + "description": "Specifies the path to the root certificates file.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "cn_attribute": { + "description": "Specifies the canonical name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "create_home_directory": { + "description": "Automatically create the home directory on the first login.", + "type": "boolean" + }, + "crypt_password_attribute": { + "description": "Specifies the hashed password value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "email_attribute": { + "description": "Specifies the LDAP Email attribute.", + "maxLength": 64, + "minLength": 4, + "type": "string" + }, + "enabled": { + "description": "If true, enables the LDAP provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "gecos_attribute": { + "description": "Specifies the LDAP GECOS attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gid_attribute": { + "description": "Specifies the LDAP GID attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for groups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_filter": { + "description": "Specifies the LDAP filter for group objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_members_attribute": { + "description": "Specifies the LDAP Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "group_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "homedir_attribute": { + "description": "Specifies the LDAP Homedir attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Specifies the ID of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ignore_tls_errors": { + "description": "If true, continues over secure connections even if identity checks fail.", + "type": "boolean" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "member_lookup_method": { + "description": "Sets the method by which group member lookups are performed. Use caution when changing this option directly.", + "enum": [ + "default", + "rfc2307bis" + ], + "type": "string" + }, + "member_of_attribute": { + "description": "Specifies the LDAP Query Member Of attribute, which performs reverse membership queries.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the name of the LDAP provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name_attribute": { + "description": "Specifies the LDAP UID attribute, which is used as the login name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_base_dn": { + "description": "Specifies the distinguished name of the entry where LDAP searches for netgroups are started.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_filter": { + "description": "Specifies the LDAP filter for netgroup objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_members_attribute": { + "description": "Specifies the LDAP Netgroup Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "netgroup_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "netgroup_triple_attribute": { + "description": "Specifies the LDAP Netgroup Triple attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "nt_password_attribute": { + "description": "Specifies the LDAP NT Password attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the provider domain.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "require_secure_connection": { + "description": "Determines whether to continue over a non-TLS connection.", + "type": "boolean" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "search_scope": { + "description": "Specifies the default depth from the base DN to perform LDAP searches.", + "enum": [ + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "search_timeout": { + "description": "Specifies the search timeout period in seconds.", + "maximum": 3600, + "minimum": 10, + "type": "integer" + }, + "server_uris": { + "description": "Specifies the server URIs.", + "items": { + "maxLength": 2048, + "minLength": 4, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 1, + "type": "array" + }, + "shadow_expire_attribute": { + "description": "Sets the attribute name that indicates the absolute date to expire the account.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_flag_attribute": { + "description": "Sets the attribute name that indicates the section of the shadow map that is used to store the flag value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_inactive_attribute": { + "description": "Sets the attribute name that indicates the number of days of inactivity that is allowed for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_last_change_attribute": { + "description": "Sets the attribute name that indicates the last change of the shadow information.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_max_attribute": { + "description": "Sets the attribute name that indicates the maximum number of days a password can be valid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_min_attribute": { + "description": "Sets the attribute name that indicates the minimum number of days between shadow changes.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_user_filter": { + "description": "Sets LDAP filter for shadow user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shadow_warning_attribute": { + "description": "Sets the attribute name that indicates the number of days before the password expires to warn the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "shell_attribute": { + "description": "Specifies the LDAP Shell attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ssh_public_key_attribute": { + "description": "Sets the attribute name that indicates the SSH Public Key for the user.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "uid_attribute": { + "description": "Specifies the LDAP UID Number attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unfindable_groups": { + "description": "Specifies the groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unique_group_members_attribute": { + "description": "Sets the LDAP Unique Group Members attribute.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_base_dn": { + "description": "Specifies the distinguished name of the entry at which to start LDAP searches for users.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_filter": { + "description": "Specifies the LDAP filter for user objects.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "user_search_scope": { + "description": "Specifies the depth from the base DN to perform LDAP searches.", + "enum": [ + "default", + "base", + "onelevel", + "subtree", + "children" + ], + "type": "string" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersLocal": { + "additionalProperties": false, + "properties": { + "local": { + "items": { + "$ref": "#/definitions/v7ProvidersLocalLocalItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersLocalLocalItem": { + "description": "Specifies the properties for a local authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "id": { + "description": "Specifies the local provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "lockout_duration": { + "description": "Specifies the length of time in seconds that an account will be inaccessible after multiple failed login attempts.", + "maximum": 2592000, + "minimum": 0, + "type": "integer" + }, + "lockout_threshold": { + "description": "Specifies the number of failed login attempts necessary before an account is locked.", + "maximum": 50, + "minimum": 0, + "type": "integer" + }, + "lockout_window": { + "description": "Specifies the duration of time in seconds in which the number of failed attempts set in the 'lockout_threshold' parameter must be made before an account is locked.", + "maximum": 2592000, + "minimum": 0, + "type": "integer" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "machine_name": { + "description": "Specifies the domain for this provider through which users and groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "max_password_age": { + "description": "Specifies the maximum password age in seconds.", + "maximum": 86313600, + "minimum": 0, + "type": "integer" + }, + "min_password_age": { + "description": "Specifies the minimum password age in seconds.", + "maximum": 86313600, + "minimum": 0, + "type": "integer" + }, + "min_password_length": { + "description": "Specifies the minimum password length.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": { + "description": "Specifies the local provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_complexity": { + "description": "Specifies the conditions required for a password.", + "items": { + "enum": [ + "lowercase", + "uppercase", + "numeric", + "symbol", + "repeat" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "password_history_length": { + "description": "Specifies the number of previous passwords to store.", + "maximum": 24, + "minimum": 0, + "type": "integer" + }, + "password_prompt_time": { + "description": "Specifies the time in seconds remaining before a user will be prompted for a password change.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ProvidersNis": { + "additionalProperties": false, + "properties": { + "nis": { + "items": { + "$ref": "#/definitions/v7ProvidersNisNisItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ProvidersNisNisItem": { + "description": "Specifies the properties for an NIS authentication provider.", + "properties": { + "authentication": { + "description": "If true, enables authentication and identity management through the authentication provider.", + "type": "boolean" + }, + "balance_servers": { + "description": "If true, connects the provider to a random server.", + "type": "boolean" + }, + "check_online_interval": { + "description": "Specifies the time in seconds between provider online checks.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "create_home_directory": { + "description": "Automatically creates the home directory on the first login.", + "type": "boolean" + }, + "enabled": { + "description": "If true, enables the NIS provider.", + "type": "boolean" + }, + "enumerate_groups": { + "description": "If true, allows the provider to enumerate groups.", + "type": "boolean" + }, + "enumerate_users": { + "description": "If true, allows the provider to enumerate users.", + "type": "boolean" + }, + "findable_groups": { + "description": "Specifies the list of groups that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "findable_users": { + "description": "Specifies the list of users that can be resolved.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "group_domain": { + "description": "Specifies the domain for this provider through which groups are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "groupnet": { + "description": "Groupnet identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "home_directory_template": { + "description": "Specifies the path to the home directory template.", + "maxLength": 4096, + "minLength": 0, + "pattern": "^((\\/[^\\/[:cntrl:]]+)(\\/?))*$", + "type": "string" + }, + "hostname_lookup": { + "description": "If true, enables host name look ups.", + "type": "boolean" + }, + "id": { + "description": "Specifies the NIS provider ID.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "listable_groups": { + "description": "Specifies the groups that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "listable_users": { + "description": "Specifies the users that can be viewed in the provider.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "login_shell": { + "description": "Specifies the login shell path.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Specifies the NIS provider name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "nis_domain": { + "description": "Specifies the NIS domain name.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "normalize_groups": { + "description": "Normalizes group names to lowercase before look up.", + "type": "boolean" + }, + "normalize_users": { + "description": "Normalizes user names to lowercase before look up.", + "type": "boolean" + }, + "ntlm_support": { + "description": "Specifies which NTLM versions to support for users with NTLM-compatible credentials.", + "enum": [ + "all", + "v2only", + "none" + ], + "type": "string" + }, + "provider_domain": { + "description": "Specifies the domain for the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "request_timeout": { + "description": "Specifies the request timeout interval in seconds.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "restrict_findable": { + "description": "If true, checks the provider for filtered lists of findable and unfindable users and groups.", + "type": "boolean" + }, + "restrict_listable": { + "description": "If true, checks the provider for filtered lists of listable and unlistable users and groups.", + "type": "boolean" + }, + "retry_time": { + "description": "Specifies the timeout period in seconds after which a request will be retried.", + "maximum": 3600, + "minimum": 0, + "type": "integer" + }, + "servers": { + "description": "Adds an NIS server for this provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "status": { + "description": "Specifies the status of the provider.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "system": { + "description": "If true, indicates that this provider instance was created by OneFS and cannot be removed.", + "type": "boolean" + }, + "unfindable_groups": { + "description": "Specifies groups that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unfindable_users": { + "description": "Specifies users that cannot be resolved by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_groups": { + "description": "Specifies a group that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "unlistable_users": { + "description": "Specifies a user that cannot be listed by the provider.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "user_domain": { + "description": "Specifies the domain for this provider through which users are qualified.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ypmatch_using_tcp": { + "description": "If true, specifies TCP for YP Match operations.", + "type": "boolean" + }, + "zone_name": { + "description": "Specifies the name of the access zone in which this provider was created.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7QuotaNotification": { + "properties": { + "action_alert": { + "description": "Send alert when rule matches.", + "type": "boolean" + }, + "action_email_address": { + "description": "Email address(es) to be notified when quota notification rule matches.", + "items": { + "maxLength": 320, + "minLength": 5, + "type": "string" + }, + "maxItems": 170, + "type": "array" + }, + "action_email_owner": { + "description": "Email quota domain owner when rule matches.", + "type": "boolean" + }, + "condition": { + "description": "The condition detected.", + "enum": [ + "exceeded", + "denied", + "violated", + "expired" + ], + "maxLength": 8, + "minLength": 6, + "type": "string" + }, + "email_template": { + "description": "Path of optional /ifs template file used for email actions.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "holdoff": { + "description": "Time to wait between detections for rules triggered by user actions.", + "maximum": 2147483646, + "type": "integer" + }, + "schedule": { + "description": "Schedule for rules that repeatedly notify.", + "type": "string" + }, + "threshold": { + "description": "The quota threshold detected.", + "enum": [ + "hard", + "soft", + "advisory" + ], + "maxLength": 8, + "minLength": 4, + "type": "string" + } + }, + "required": [ + "threshold", + "condition" + ], + "type": "object" + }, + "v7QuotaNotificationExtended": { + "allOf": [ + { + "$ref": "#/definitions/v7QuotaNotification" + }, + { + "properties": { + "action_email_address": { + "description": "Email address(es) to be notified when quota notification rule matches.", + "items": { + "maxLength": 320, + "minLength": 5, + "type": "string" + }, + "maxItems": 170, + "type": "array" + }, + "id": { + "description": "The system ID given to the rule.", + "maxLength": 17, + "minLength": 11, + "pattern": "^[a-z]+-[a-z]+", + "type": "string" + } + }, + "required": [ + "action_email_address", + "id" + ], + "type": "object" + } + ] + }, + "v7QuotaNotifications": { + "additionalProperties": false, + "properties": { + "notifications": { + "items": { + "$ref": "#/definitions/v7QuotaNotificationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7QuotaQuota": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise a accounting quota.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the quota.", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "linked": { + "description": "For user, group and directory quotas, true if the quota is linked and controlled by a parent default-* quota. Linked quotas cannot be modified until they are unlinked.", + "type": "boolean" + }, + "notifications": { + "description": "Summary of notifications: 'custom' indicates one or more notification rules available from the notifications sub-resource; 'default' indicates system default rules are used; 'disabled' indicates that no notifications will be used for this quota.; 'badmap' indicates that notification rule has problem in rule map.", + "enum": [ + "custom", + "default", + "disabled", + "badmap" + ], + "maxLength": 8, + "minLength": 6, + "type": "string" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ready": { + "description": "True if the default resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholdsExtended" + }, + "thresholds_on": { + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v7QuotaQuotaUsage" + } + }, + "required": [ + "enforced", + "include_snapshots", + "container", + "usage", + "thresholds", + "linked", + "notifications", + "persona", + "ready", + "path", + "type", + "id" + ], + "type": "object" + }, + "v7QuotaQuotaUsage": { + "properties": { + "applogical": { + "description": "Bytes used by governed data apparent to application.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "applogical_ready": { + "description": "True if applogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "fslogical": { + "description": "Bytes used by governed data apparent to filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fslogical_ready": { + "description": "True if fslogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "inodes": { + "description": "Number of inodes (filesystem entities) used by governed data.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "inodes_ready": { + "description": "True if inodes resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "physical": { + "description": "Bytes used for governed data and filesystem overhead.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "physical_ready": { + "description": "True if physical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + } + }, + "required": [ + "inodes_ready", + "physical_ready", + "fslogical_ready", + "fslogical", + "applogical", + "applogical_ready", + "inodes", + "physical" + ], + "type": "object" + }, + "v7QuotaQuotas": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v7QuotaQuota" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7QuotaQuotasExtended": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v7QuotaQuota" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7QuotasQidNotification": { + "properties": { + "action_alert": { + "description": "Send alert when rule matches.", + "type": "boolean" + }, + "action_email_address": { + "description": "Email address(es) to be notified when quota notification rule matches.", + "items": { + "maxLength": 320, + "minLength": 5, + "type": "string" + }, + "maxItems": 170, + "type": "array" + }, + "action_email_owner": { + "description": "Email quota domain owner when rule matches.", + "type": "boolean" + }, + "email_template": { + "description": "Path of optional /ifs template file used for email actions.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "holdoff": { + "description": "Time to wait between detections for rules triggered by user actions.", + "maximum": 2147483646, + "type": "integer" + }, + "schedule": { + "description": "Schedule for rules that repeatedly notify.", + "type": "string" + } + }, + "type": "object" + }, + "v7QuotasQidNotifications": { + "additionalProperties": false, + "properties": { + "notifications": { + "items": { + "$ref": "#/definitions/v7QuotaNotificationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ReportSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v7ReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v7ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ReportsReportSubreports": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "subreports": { + "items": { + "$ref": "#/definitions/v7ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ReportsReportSubreportsSubreport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v7ReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v7ReportSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ServicePolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v7ServicePolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ServicePoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v7ServicePolicyExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ServicePolicy": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "linked_data_policies": { + "description": "A list of SyncIQ policy names/IDs whose source root directories will be used to filter service replication.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "replicated_services": { + "description": "A list of services to replicate.", + "items": { + "enum": [ + "quotas" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "target_host", + "name" + ], + "type": "object" + }, + "v7ServicePolicyExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "database_mirrored": { + "description": "If true, SyncIQ databases have been mirrored.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_data_policies": { + "description": "A list of SyncIQ policy names/IDs whose source root directories will be used to filter service replication.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "replicated_services": { + "description": "A list of services to replicate.", + "items": { + "enum": [ + "quotas" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_certificate_id": { + "description": "The ID of the source cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_domain_marked": { + "description": "If true, the source root path has been domain marked with a SyncIQ domain.", + "type": "boolean" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "encrypted", + "database_mirrored", + "last_success", + "source_domain_marked", + "id", + "target_host", + "source_certificate_id", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v7ServicePolicyExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "linked_data_policies": { + "description": "A list of SyncIQ policy names/IDs whose source root directories will be used to filter service replication.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "replicated_services": { + "description": "A list of services to replicate.", + "items": { + "enum": [ + "quotas" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v7ServicePolicyExtendedExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "database_mirrored": { + "description": "If true, SyncIQ databases have been mirrored.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_data_policies": { + "description": "A list of SyncIQ policy names/IDs whose source root directories will be used to filter service replication.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "replicated_services": { + "description": "A list of services to replicate.", + "items": { + "enum": [ + "quotas" + ], + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_certificate_id": { + "description": "The ID of the source cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_domain_marked": { + "description": "If true, the source root path has been domain marked with a SyncIQ domain.", + "type": "boolean" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "last_success", + "id", + "target_host", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v7ServiceTargetPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v7ServiceTargetPoliciesPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ServiceTargetPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v7ServiceTargetPoliciesPolicy" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ServiceTargetPoliciesPolicy": { + "properties": { + "failover_failback_state": { + "description": "The condition of this policy with respect to sync failover/failback.", + "enum": [ + "writes_disabled", + "enabling_writes", + "writes_enabled", + "disabling_writes", + "creating_resync_policy", + "resync_policy_created" + ], + "type": "string" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_job_state": { + "description": "The state of the last job run for this policy.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "type": "string" + }, + "last_source_coordinator_ip": { + "description": "The IP address from which a SyncIQ coordinator daemon most recently connected to this cluster to update it about the progress of a job for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "last_update_from_source": { + "description": "The last time this cluster was updated with sync information from the source cluster for this policy, in unix epoch seconds. Null if no such update has occurred yet.", + "type": "integer" + }, + "legacy_policy": { + "description": "Was this policy defined by a OneFS version earlier than 6.0? (Pre-6.0 policies did not have the target policy concept and canceling from the target side will not be available.)", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_cluster_guid": { + "description": "Unique identifier for the source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "name", + "source_cluster_guid", + "last_job_state", + "id", + "target_path", + "legacy_policy", + "source_host", + "last_update_from_source", + "last_source_coordinator_ip", + "failover_failback_state" + ], + "type": "object" + }, + "v7SettingsAcls": { + "properties": { + "acl_policy_settings": { + "$ref": "#/definitions/v7SettingsAclsAclPolicySettings" + } + }, + "type": "object" + }, + "v7SettingsAclsAclPolicySettings": { + "description": "ACL policies settings.", + "properties": { + "access": { + "description": "Access checks (chmod, chown).", + "enum": [ + "unix", + "windows" + ], + "type": "string" + }, + "calcmode": { + "description": "Displayed mode bits.", + "enum": [ + "approx", + "777" + ], + "type": "string" + }, + "calcmode_group": { + "description": "Approximate group mode bits when ACL exists.", + "enum": [ + "group_aces", + "group_only" + ], + "type": "string" + }, + "calcmode_owner": { + "description": "Approximate owner mode bits when ACL exists.", + "enum": [ + "owner_aces", + "owner_only" + ], + "type": "string" + }, + "calcmode_traverse": { + "description": "Require traverse rights in order to traverse directories with existing ACLs.", + "enum": [ + "require", + "ignore" + ], + "type": "string" + }, + "chmod": { + "description": "chmod on files with existing ACLs.", + "enum": [ + "remove", + "replace", + "replace_users_and_groups", + "merge", + "deny", + "ignore" + ], + "type": "string" + }, + "chmod_007": { + "description": "chmod (007) on files with existing ACLs.", + "enum": [ + "default", + "remove" + ], + "type": "string" + }, + "chmod_inheritable": { + "description": "ACLs created on directories by UNIX chmod.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "chown": { + "description": "chown/chgrp on files with existing ACLs.", + "enum": [ + "owner_group_and_acl", + "owner_group_only", + "ignore" + ], + "type": "string" + }, + "create_over_smb": { + "description": "ACL creation over SMB.", + "enum": [ + "allow", + "disallow" + ], + "type": "string" + }, + "dos_attr": { + "description": " Read only DOS attribute.", + "enum": [ + "deny_smb", + "deny_smb_and_nfs" + ], + "type": "string" + }, + "group_owner_inheritance": { + "description": "Group owner inheritance.", + "enum": [ + "native", + "parent", + "creator" + ], + "type": "string" + }, + "rwx": { + "description": "Treatment of 'rwx' permissions.", + "enum": [ + "retain", + "full_control" + ], + "type": "string" + }, + "synthetic_denies": { + "description": "Synthetic 'deny' ACEs.", + "enum": [ + "none", + "remove" + ], + "type": "string" + }, + "utimes": { + "description": "Access check (utimes)", + "enum": [ + "only_owner", + "owner_and_write" + ], + "type": "string" + } + }, + "type": "object" + }, + "v7SettingsCharacterEncodings": { + "properties": { + "settings": { + "$ref": "#/definitions/v7SettingsCharacterEncodingsSettings" + } + }, + "type": "object" + }, + "v7SettingsCharacterEncodingsExtended": { + "properties": { + "current_encoding": { + "description": "New filesystem character encoding.", + "enum": [ + "Windows-SJIS", + "Windows-949", + "Windows-1252", + "EUC-KR", + "EUC-JP", + "EUC-JP-MS", + "UTF-8-MAC", + "UTF-8", + "ISO-8859-1", + "ISO-8859-2", + "ISO-8859-3", + "ISO-8859-4", + "ISO-8859-5", + "ISO-8859-6", + "ISO-8859-7", + "ISO-8859-8", + "ISO-8859-9", + "ISO-8859-10", + "ISO-8859-13", + "ISO-8859-14", + "ISO-8859-15", + "ISO-8859-16" + ], + "type": "string" + } + }, + "type": "object" + }, + "v7SettingsCharacterEncodingsSettings": { + "properties": { + "current_encoding": { + "description": "Current filesystem character encoding.", + "enum": [ + "Windows-SJIS", + "Windows-949", + "Windows-1252", + "EUC-KR", + "EUC-JP", + "EUC-JP-MS", + "UTF-8-MAC", + "UTF-8", + "ISO-8859-1 (Latin-1)", + "ISO-8859-2 (Latin-2)", + "ISO-8859-3 (Latin-3)", + "ISO-8859-4 (Latin-4)", + "ISO-8859-5 (Cyrillic)", + "ISO-8859-6 (Arabic)", + "ISO-8859-7 (Greek)", + "ISO-8859-8 (Hebrew)", + "ISO-8859-9 (Latin-5)", + "ISO-8859-10 (Latin-6)", + "ISO-8859-13 (Latin-7)", + "ISO-8859-14 (Latin-8)", + "ISO-8859-15 (Latin-9)", + "ISO-8859-16 (Latin-10)" + ], + "type": "string" + }, + "default_encoding": { + "default": "UTF-8", + "description": "Default filesystem character encoding.", + "maxLength": 5, + "minLength": 5, + "type": "string" + }, + "encodings": { + "description": "A list of supported filesystem character encodings.", + "items": { + "description": "Filesystem character encoding.", + "enum": [ + "Windows-SJIS", + "Windows-949", + "Windows-1252", + "EUC-KR", + "EUC-JP", + "EUC-JP-MS", + "UTF-8-MAC", + "UTF-8", + "ISO-8859-1 (Latin-1)", + "ISO-8859-2 (Latin-2)", + "ISO-8859-3 (Latin-3)", + "ISO-8859-4 (Latin-4)", + "ISO-8859-5 (Cyrillic)", + "ISO-8859-6 (Arabic)", + "ISO-8859-7 (Greek)", + "ISO-8859-8 (Hebrew)", + "ISO-8859-9 (Latin-5)", + "ISO-8859-10 (Latin-6)", + "ISO-8859-13 (Latin-7)", + "ISO-8859-14 (Latin-8)", + "ISO-8859-15 (Latin-9)", + "ISO-8859-16 (Latin-10)" + ], + "type": "string" + }, + "maxItems": 22, + "minItems": 22, + "type": "array" + } + }, + "required": [ + "encodings", + "current_encoding", + "default_encoding" + ], + "type": "object" + }, + "v7SettingsGlobal": { + "properties": { + "settings": { + "$ref": "#/definitions/v7SettingsGlobalSettings" + } + }, + "type": "object" + }, + "v7SettingsGlobalSettings": { + "description": "Settings for Audit.", + "properties": { + "audited_zones": { + "description": "Specifies zones that are audited when the protocol_auditing_enabled property is enabled.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "cee_log_time": { + "description": "Specifies that events past a certain date are forwarded by the audit CEE forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS'.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "cee_server_uris": { + "description": "Specifies a list of Common Event Enabler (CEE) server URIs. Protocol audit logs are sent to these URIs for external processing.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "config_auditing_enabled": { + "description": "Specifies whether logging for API configuration changes are enabled.", + "type": "boolean" + }, + "config_syslog_enabled": { + "description": "Specifies whether configuration audit syslog messages are forwarded.", + "type": "boolean" + }, + "config_syslog_servers": { + "description": "Specifies a list of remote servers for audit logging of configuration changes. Audit logs are sent to syslog of these remote servers.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "hostname": { + "description": "Specifies the hostname that is reported in protocol events from this cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "protocol_auditing_enabled": { + "description": "Specifies if logging for the I/O stream is enabled.", + "type": "boolean" + }, + "protocol_syslog_servers": { + "description": "Specifies a list of remote servers for protocol audit logging. Protocol audit logs are sent to syslog of these remote servers.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "syslog_log_time": { + "description": "Specifies that events past a specified date are forwarded by the audit syslog forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS' format", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7SettingsNotifications": { + "additionalProperties": false, + "properties": { + "notifications": { + "items": { + "$ref": "#/definitions/v7QuotaNotificationExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_SETTINGS_NOTIFICATIONS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7SmbSettingsShare": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v7SmbSettingsShareSettings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "v7SmbSettingsShareSettings": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Specify level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_permissions": { + "description": "Set the create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "directory_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "Unix umask or mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on the share.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Allow oplock requests.", + "type": "boolean" + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "sparse_file": { + "description": "Enables sparse file.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone in which to update settings", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SETTINGS_SHARE" + }, + "v7SmbShare": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_path": { + "description": "Create path if does not exist.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "sparse_file": { + "description": "Enables sparse file.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share.", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "path", + "name" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "v7SmbShareExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "continuously_available": { + "description": "Specify if persistent opens are allowed on the share.", + "type": "boolean" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "id": { + "description": "Share ID.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "sparse_file": { + "description": "Enables sparse file.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zid": { + "description": "Numeric ID of the access zone which contains this SMB share", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "path", + "id", + "zid", + "name" + ], + "type": "object" + }, + "v7SmbShareExtendedExtended": { + "properties": { + "access_based_enumeration": { + "description": "Only enumerate files and folders the requesting user has access to.", + "type": "boolean" + }, + "access_based_enumeration_root_only": { + "description": "Access-based enumeration on only the root directory of the share.", + "type": "boolean" + }, + "allow_delete_readonly": { + "description": "Allow deletion of read-only files in the share.", + "type": "boolean" + }, + "allow_execute_always": { + "description": "Allows users to execute files they have read rights for.", + "type": "boolean" + }, + "allow_variable_expansion": { + "description": "Allow automatic expansion of variables for home directories.", + "type": "boolean" + }, + "auto_create_directory": { + "description": "Automatically create home directories.", + "type": "boolean" + }, + "browsable": { + "description": "Share is visible in net view and the browse list.", + "type": "boolean" + }, + "ca_timeout": { + "description": "Persistent open timeout for the share.", + "maximum": 6000, + "minimum": 2, + "type": "integer" + }, + "ca_write_integrity": { + "description": "Specify the level of write-integrity on continuously available shares.", + "enum": [ + "none", + "write-read-coherent", + "full" + ], + "type": "string" + }, + "change_notify": { + "description": "Level of change notification alerts on the share.", + "enum": [ + "all", + "norecurse", + "none" + ], + "type": "string" + }, + "create_permissions": { + "description": "Create permissions for new files and directories in share.", + "enum": [ + "default acl", + "inherit mode bits", + "use create mask and mode" + ], + "type": "string" + }, + "csc_policy": { + "description": "Client-side caching policy for the shares.", + "enum": [ + "manual", + "documents", + "programs", + "none" + ], + "type": "string" + }, + "description": { + "description": "Description for this SMB share.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "directory_create_mask": { + "description": "Directory create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "directory_create_mode": { + "description": "Directory create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mask": { + "description": "File create mask bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_create_mode": { + "description": "File create mode bits.", + "maximum": 511, + "minimum": 0, + "type": "integer" + }, + "file_filter_extensions": { + "description": "Specifies the list of file extensions.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "file_filter_type": { + "description": "Specifies if filter list is for deny or allow. Default is deny.", + "enum": [ + "deny", + "allow" + ], + "type": "string" + }, + "file_filtering_enabled": { + "description": "Enables file filtering on this zone.", + "type": "boolean" + }, + "hide_dot_files": { + "description": "Hide files and directories that begin with a period '.'.", + "type": "boolean" + }, + "host_acl": { + "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", + "items": { + "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '].", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "impersonate_guest": { + "description": "Specify the condition in which user access is done as the guest account.", + "enum": [ + "always", + "bad user", + "never" + ], + "type": "string" + }, + "impersonate_user": { + "description": "User account to be used as guest account.", + "maxLength": 511, + "minLength": 0, + "type": "string" + }, + "inheritable_path_acl": { + "description": "Set the inheritable ACL on the share path.", + "type": "boolean" + }, + "mangle_byte_start": { + "description": "Specifies the wchar_t starting point for automatic byte mangling.", + "maximum": 65535, + "minimum": 256, + "type": "integer" + }, + "mangle_map": { + "description": "Character mangle map.", + "items": { + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "name": { + "description": "Share name.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "ntfs_acl_support": { + "description": "Support NTFS ACLs on files and directories.", + "type": "boolean" + }, + "oplocks": { + "description": "Support oplocks.", + "type": "boolean" + }, + "path": { + "description": "Path of share within /ifs.", + "maxLength": 511, + "minLength": 1, + "type": "string" + }, + "permissions": { + "description": "Specifies an ordered list of permission modifications.", + "items": { + "$ref": "#/definitions/v1SmbSharePermission" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "run_as_root": { + "description": "Allow account to run as root.", + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "smb3_encryption_enabled": { + "description": "Enables SMB3 encryption for the share.", + "type": "boolean" + }, + "sparse_file": { + "description": "Enables sparse file.", + "type": "boolean" + }, + "strict_ca_lockout": { + "description": "Specifies if persistent opens would do strict lockout on the share.", + "type": "boolean" + }, + "strict_flush": { + "description": "Handle SMB flush operations.", + "type": "boolean" + }, + "strict_locking": { + "description": "Specifies whether byte range locks contend against SMB I/O.", + "type": "boolean" + }, + "zone": { + "description": "Name of the access zone to which to move this SMB share.", + "maxLength": 511, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v7SmbShares": { + "additionalProperties": false, + "properties": { + "digest": { + "description": "An identifier for a set of shares.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "shares": { + "items": { + "$ref": "#/definitions/v7SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMB_SHARES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v7SmbSharesExtended": { + "additionalProperties": false, + "properties": { + "shares": { + "items": { + "$ref": "#/definitions/v7SmbShareExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "shares" + ], + "type": "object" + }, + "v7SshSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v7SshSettingsSettings" + } + }, + "type": "object" + }, + "v7SshSettingsExtended": { + "description": "Specifies the properties for SSH authentication settings.", + "properties": { + "auth_settings_template": { + "description": "Specifies the configuration template for the supported method by which a user is authenticated.", + "enum": [ + "password", + "publickey", + "both", + "any", + "custom" + ], + "type": "string" + }, + "authentication_methods": { + "description": "Specifies the authentication methods that must be successfully completed for a user to be granted access.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "banner": { + "description": "Specifies file name to be used as SSH warning banner that is shown before the password prompt", + "maxLength": 4096, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "challenge_response_authentication": { + "description": "Specifies whether challenge-response authentication is allowed.", + "type": "boolean" + }, + "ciphers": { + "description": "Specifies the ciphers allowed for protocol version 2.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com)(,(aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com))*$", + "type": "string" + }, + "host_key_algorithms": { + "description": "Specifies the protocol version 2 host key algorithms the server offers.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "ignore_rhosts": { + "description": "If true, ignores .rhosts and .shosts files.", + "type": "boolean" + }, + "kex_algorithms": { + "description": "Specifies the available KEX algorithms.", + "maxLength": 4096, + "minLength": 18, + "pattern": "^(\\+?)(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521)(,(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521))*$", + "type": "string" + }, + "keyboard_interactive_authentication": { + "description": "Specifies whether to allow keyboard-interactive authentication.", + "type": "boolean" + }, + "log_level": { + "description": "Specifies the log level when logging messages from sshd(8).", + "enum": [ + "INFO", + "QUIET", + "FATAL", + "ERROR", + "VERBOSE", + "DEBUG", + "DEBUG1", + "DEBUG2", + "DEBUG3" + ], + "type": "string" + }, + "login_grace_time": { + "description": "Specifies the length of time in seconds before idle log in fails. If the value is 0, there is no time limit.", + "maximum": 600, + "minimum": 0, + "type": "integer" + }, + "macs": { + "description": "Specifies the available MAC algorithms.", + "maxLength": 4096, + "minLength": 8, + "pattern": "^(\\+?)(hmac-sha1|hmac-sha2-256|hmac-sha2-512|umac-128@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com)(,(hmac-sha1|hmac-sha2-256|hmac-sha2-512|umac-128@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com))*$", + "type": "string" + }, + "match": { + "description": "Specifies match blocks.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "max_auth_tries": { + "description": "Specifies the maximum number of authentication attempts per connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_sessions": { + "description": "Specifies the maximum number of open sessions permitted per network connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_startups": { + "description": "Specifies maximum number of unauthenticated connections.", + "maxLength": 11, + "minLength": 0, + "pattern": "^$|^([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9])$", + "type": "string" + }, + "password_authentication": { + "description": "Specifies whether password authentication is allowed.", + "type": "boolean" + }, + "permit_empty_passwords": { + "description": "Enable empty passwords if password authentication is allowed.", + "type": "boolean" + }, + "permit_root_login": { + "description": "Enable root SSH login.", + "type": "boolean" + }, + "port": { + "description": "Specifies the port sshd(8) should listen on", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "print_motd": { + "description": "Enable printing /etc/motd when a user logs in.", + "type": "boolean" + }, + "pubkey_accepted_key_types": { + "description": "Specifies the accepted public key types.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "pubkey_authentication": { + "description": "Specifies whether public key authentication is allowed.", + "type": "boolean" + }, + "strict_modes": { + "description": "Specifies if sshd(8) should check home directory permissions before accepting login.", + "type": "boolean" + }, + "subsystem": { + "description": "Specifies an external subsystem.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\\n]*$", + "type": "string" + }, + "syslog_facility": { + "description": "Specifies the facility code when logging messages from sshd(8).", + "enum": [ + "AUTH", + "DAEMON", + "USER", + "LOCAL0", + "LOCAL1", + "LOCAL2", + "LOCAL3", + "LOCAL4", + "LOCAL5", + "LOCAL6", + "LOCAL7" + ], + "type": "string" + }, + "tcp_keep_alive": { + "description": "Enable sending TCP keep alive messages.", + "type": "boolean" + }, + "use_dns": { + "description": "Specifies whether sshd should look up the remote host name.", + "type": "boolean" + }, + "use_pam": { + "description": "Enables the Pluggable Authentication Module interface.", + "type": "boolean" + } + }, + "type": "object" + }, + "v7SshSettingsSettings": { + "description": "Specifies the properties for SSH authentication settings.", + "properties": { + "auth_settings_template": { + "description": "Specifies the configuration template for the supported method by which a user is authenticated.", + "enum": [ + "password", + "publickey", + "both", + "any", + "custom" + ], + "type": "string" + }, + "authentication_methods": { + "description": "Specifies the authentication methods that must be successfully completed for a user to be granted access.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "banner": { + "description": "Specifies file name to be used as SSH warning banner that is shown before the password prompt", + "maxLength": 4096, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "challenge_response_authentication": { + "description": "Specifies whether challenge-response authentication is allowed.", + "type": "boolean" + }, + "ciphers": { + "description": "Specifies the ciphers allowed for protocol version 2.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(3des-cbc|aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com)(,(3des-cbc|aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com))*$", + "type": "string" + }, + "host_key_algorithms": { + "description": "Specifies the protocol version 2 host key algorithms the server offers.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "ignore_rhosts": { + "description": "If true, ignores .rhosts and .shosts files.", + "type": "boolean" + }, + "kex_algorithms": { + "description": "Specifies the available KEX algorithms.", + "maxLength": 4096, + "minLength": 18, + "pattern": "^(\\+?)(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521)(,(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521))*$", + "type": "string" + }, + "keyboard_interactive_authentication": { + "description": "Specifies whether to allow keyboard-interactive authentication.", + "type": "boolean" + }, + "log_level": { + "description": "Specifies the log level when logging messages from sshd(8).", + "enum": [ + "INFO", + "QUIET", + "FATAL", + "ERROR", + "VERBOSE", + "DEBUG", + "DEBUG1", + "DEBUG2", + "DEBUG3" + ], + "type": "string" + }, + "login_grace_time": { + "description": "Specifies the length of time in seconds before idle log in fails. If the value is 0, there is no time limit.", + "maximum": 600, + "minimum": 0, + "type": "integer" + }, + "macs": { + "description": "Specifies the available MAC algorithms.", + "maxLength": 4096, + "minLength": 8, + "pattern": "^(\\+?)(hmac-md5|hmac-md5-96|hmac-sha1|hmac-sha1-96|hmac-sha2-256|hmac-sha2-512|umac-64@openssh.com|umac-128@openssh.com|hmac-md5-etm@openssh.com|hmac-md5-96-etm@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha1-96-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com)(,(hmac-md5|hmac-md5-96|hmac-sha1|hmac-sha1-96|hmac-sha2-256|hmac-sha2-512|umac-64@openssh.com|umac-128@openssh.com|hmac-md5-etm@openssh.com|hmac-md5-96-etm@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha1-96-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com))*$", + "type": "string" + }, + "match": { + "description": "Specifies match blocks.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "max_auth_tries": { + "description": "Specifies the maximum number of authentication attempts per connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_sessions": { + "description": "Specifies the maximum number of open sessions permitted per network connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_startups": { + "description": "Specifies maximum number of unauthenticated connections.", + "maxLength": 11, + "minLength": 0, + "pattern": "^$|^([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9])$", + "type": "string" + }, + "password_authentication": { + "description": "Specifies whether password authentication is allowed.", + "type": "boolean" + }, + "permit_empty_passwords": { + "description": "Enable empty passwords if password authentication is allowed.", + "type": "boolean" + }, + "permit_root_login": { + "description": "Enable root SSH login.", + "type": "boolean" + }, + "port": { + "description": "Specifies the port sshd(8) should listen on", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "print_motd": { + "description": "Enable printing /etc/motd when a user logs in.", + "type": "boolean" + }, + "pubkey_accepted_key_types": { + "description": "Specifies the accepted public key types.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "pubkey_authentication": { + "description": "Specifies whether public key authentication is allowed.", + "type": "boolean" + }, + "strict_modes": { + "description": "Specifies if sshd(8) should check home directory permissions before accepting login.", + "type": "boolean" + }, + "subsystem": { + "description": "Specifies an external subsystem.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\\n]*$", + "type": "string" + }, + "syslog_facility": { + "description": "Specifies the facility code when logging messages from sshd(8).", + "enum": [ + "AUTH", + "DAEMON", + "USER", + "LOCAL0", + "LOCAL1", + "LOCAL2", + "LOCAL3", + "LOCAL4", + "LOCAL5", + "LOCAL6", + "LOCAL7" + ], + "type": "string" + }, + "tcp_keep_alive": { + "description": "Enable sending TCP keep alive messages.", + "type": "boolean" + }, + "use_dns": { + "description": "Specifies whether sshd should look up the remote host name.", + "type": "boolean" + }, + "use_pam": { + "description": "Enables the Pluggable Authentication Module interface.", + "type": "boolean" + } + }, + "type": "object" + }, + "v7SyncJob": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "workers": { + "description": "A list of workers for this job.", + "items": { + "$ref": "#/definitions/v15SyncJobWorker" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "workers", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v7SyncJobs": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v7SyncJob" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_JOBS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7SyncJobsExtended": { + "additionalProperties": false, + "properties": { + "jobs": { + "items": { + "$ref": "#/definitions/v7SyncJob" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7SyncPolicies": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v7SyncPolicyExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_POLICIES" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7SyncPoliciesExtended": { + "additionalProperties": false, + "properties": { + "policies": { + "items": { + "$ref": "#/definitions/v7SyncPolicyExtendedExtendedExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7SyncPolicy": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "target_host", + "name", + "target_path", + "action" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_POLICIES" + }, + "v7SyncPolicyExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "database_mirrored": { + "description": "If true, SyncIQ databases have been mirrored.", + "type": "boolean" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_set": { + "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET.", + "type": "boolean" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_certificate_id": { + "description": "The ID of the source cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_domain_marked": { + "description": "If true, the source root path has been domain marked with a SyncIQ domain.", + "type": "boolean" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "encrypted", + "database_mirrored", + "last_success", + "source_domain_marked", + "id", + "target_host", + "source_certificate_id", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v7SyncPolicyExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "enum": [ + false + ], + "type": "boolean" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password": { + "description": "The password for the target cluster. This field is not readable.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "type": "object" + }, + "v7SyncPolicyExtendedExtendedExtended": { + "description": "Specifies the properties of a policy.", + "properties": { + "accelerated_failback": { + "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.", + "type": "boolean" + }, + "action": { + "description": "If 'copy', source files will be copied to the target cluster. If 'sync', the target directory will be made an image of the source directory: Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "allow_copy_fb": { + "description": "If set to true, SyncIQ will allow a policy with copy action failback which is not supported by default.", + "type": "boolean" + }, + "bandwidth_reservation": { + "description": "The desired bandwidth reservation for this policy in kb/s. This feature will not activate unless a SyncIQ bandwidth rule is in effect.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "changelist": { + "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation.", + "type": "boolean" + }, + "check_integrity": { + "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received.", + "type": "boolean" + }, + "cloud_deep_copy": { + "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.", + "enum": [ + "deny", + "allow", + "force" + ], + "type": "string" + }, + "conflicted": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'.", + "type": "boolean" + }, + "database_mirrored": { + "description": "If true, SyncIQ databases have been mirrored.", + "type": "boolean" + }, + "delete_quotas": { + "description": "If true, forcibly remove quotas on the target after they have been removed on the source.", + "type": "boolean" + }, + "description": { + "description": "User-assigned description of this sync policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "disable_file_split": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. If true, the 7.2+ file splitting capability will be disabled.", + "type": "boolean" + }, + "disable_fofb": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable sync failover/failback.", + "type": "boolean" + }, + "disable_quota_tmp_dir": { + "description": "If set to true, SyncIQ will not create temporary quota directories to aid in replication to target paths which contain quotas.", + "type": "boolean" + }, + "disable_stf": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Enable/disable the 6.5+ STF based data transfer and uses only treewalk.", + "type": "boolean" + }, + "enable_hash_tmpdir": { + "description": "If true, syncs will use temporary working directory subdirectories to reduce lock contention.", + "type": "boolean" + }, + "enabled": { + "description": "If true, jobs will be automatically run based on this policy, according to its schedule.", + "type": "boolean" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "expected_dataloss": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Continue sending files even with the corrupted filesystem.", + "type": "boolean" + }, + "file_matching_pattern": { + "$ref": "#/definitions/v1SyncJobPolicyFileMatchingPattern" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet. If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set.", + "type": "boolean" + }, + "has_sync_state": { + "description": "This field is false if the policy is in its initial sync state and true otherwise. Setting this field to false will reset the policy's sync state.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "ignore_recursive_quota": { + "description": "If set to true, SyncIQ will not check the recursive quota in target paths to aid in replication to target paths which contain no quota but target cluster has lots of quotas.", + "type": "boolean" + }, + "job_delay": { + "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds).", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_job_state": { + "description": "This is the state of the most recent job for this policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "last_started": { + "description": "The most recent time a job was started for this policy. Value is null if the policy has never been run.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "last_success": { + "description": "Timestamp of last known successfully completed synchronization. Value is null if the policy has never completed successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "linked_service_policies": { + "description": "A list of service replication policies that this data replication policy will be associated with.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "log_level": { + "description": "Severity an event must reach before it is logged.", + "enum": [ + "fatal", + "error", + "notice", + "info", + "copy", + "debug", + "trace" + ], + "type": "string" + }, + "log_removed_files": { + "description": "If true, the system will log any files or directories that are deleted due to a sync.", + "type": "boolean" + }, + "name": { + "description": "User-assigned name of this sync policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "next_run": { + "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds. This field is null if the job is not scheduled.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "password_set": { + "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET.", + "type": "boolean" + }, + "priority": { + "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0.", + "maximum": 1, + "minimum": 0, + "type": "integer" + }, + "report_max_age": { + "description": "Length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "report_max_count": { + "description": "Maximum number of policy reports that will be stored on the system.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "restrict_target_network": { + "description": "If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean" + }, + "rpo_alert": { + "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "schedule": { + "description": "The schedule on which new jobs will be run for this policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "service_policy": { + "description": "If true, this is a service replication policy.", + "type": "boolean" + }, + "skip_lookup": { + "description": "Skip DNS lookup of target IPs.", + "type": "boolean" + }, + "skip_when_source_unmodified": { + "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed.", + "type": "boolean" + }, + "snapshot_sync_existing": { + "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken).", + "type": "boolean" + }, + "snapshot_sync_pattern": { + "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\").", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "source_certificate_id": { + "description": "The ID of the source cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "source_domain_marked": { + "description": "If true, the source root path has been domain marked with a SyncIQ domain.", + "type": "boolean" + }, + "source_exclude_directories": { + "description": "Directories that will be excluded from the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_include_directories": { + "description": "Directories that will be included in the sync. Modifying this field will result in a full synchronization of all data.", + "items": { + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "source_root_path": { + "description": "The root directory on the source cluster the files will be synced from. Modifying this field will result in a full synchronization of all data.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "source_snapshot_archive": { + "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync.", + "type": "boolean" + }, + "source_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the source cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the source cluster before a sync.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_certificate_id": { + "description": "The ID of the target cluster certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_compare_initial_sync": { + "description": "If true, the target creates diffs against the original sync.", + "type": "boolean" + }, + "target_detect_modifications": { + "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs.", + "type": "boolean" + }, + "target_host": { + "description": "Hostname or IP address of sync target cluster. Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "target_snapshot_alias": { + "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "target_snapshot_archive": { + "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions.", + "type": "boolean" + }, + "target_snapshot_expiration": { + "description": "The length of time in seconds to keep snapshots on the target cluster.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshot_pattern": { + "description": "The name pattern for snapshots taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "workers_per_node": { + "description": "The number of worker threads on a node performing a sync.", + "maximum": 20, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "source_root_path", + "last_success", + "id", + "target_host", + "schedule", + "name", + "enabled", + "target_path" + ], + "type": "object" + }, + "v7SyncReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy": { + "$ref": "#/definitions/v1SyncJobPolicy" + }, + "policy_action": { + "description": "This is the action the policy is configured to perform.", + "enum": [ + "copy", + "sync" + ], + "type": "string" + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "policy", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "source_directories_visited", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "error_net_files_skipped", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "policy_action", + "running_chunks", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v7SyncReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v7SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7SyncReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v7SyncReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7SyncSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v7SyncSettingsSettings" + } + }, + "type": "object" + }, + "v7SyncSettingsExtended": { + "description": "Global SyncIQ settings.", + "properties": { + "bandwidth_reservation_reserve_absolute": { + "description": "The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidth_reservation_reserve_percentage.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bandwidth_reservation_reserve_percentage": { + "description": "The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.", + "maximum": 99, + "minimum": 1, + "type": "integer" + }, + "cluster_certificate_id": { + "description": "The ID of this cluster's certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_CLUSTER_CERTIFICATE_ID" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "encryption_required": { + "description": "If true, requires all SyncIQ policies to utilize encrypted communications.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_ENCRYPTION_REQUIRED" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "renegotiation_period": { + "description": "If specified, the duration to persist encrypted connection before forcing a renegotiation.", + "maximum": 2147483646, + "minimum": 60, + "type": "integer" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "rpo_alerts": { + "description": "If disabled, no RPO alerts will be generated.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_RPO_ALERTS" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "use_workers_per_node": { + "description": "If enabled, SyncIQ will use the deprecated workers_per_node field with worker pools functionality and limit workers accordingly.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS" + }, + "v7SyncSettingsSettings": { + "description": "Global SyncIQ settings.", + "properties": { + "bandwidth_reservation_reserve_absolute": { + "description": "The amount of SyncIQ bandwidth to reserve in kb/s for policies that did not specify a bandwidth reservation. This field takes precedence over bandwidth_reservation_reserve_percentage.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bandwidth_reservation_reserve_percentage": { + "description": "The percentage of SyncIQ bandwidth to reserve for policies that did not specify a bandwidth reservation.", + "maximum": 99, + "minimum": 1, + "type": "integer" + }, + "cluster_certificate_id": { + "description": "The ID of this cluster's certificate being used for encryption.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_CLUSTER_CERTIFICATE_ID" + }, + "encryption_cipher_list": { + "description": "The cipher list being used with encryption. For SyncIQ targets, this list serves as a list of supported ciphers. For SyncIQ sources, the list of ciphers will be attempted to be used in order.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "encryption_required": { + "description": "If true, requires all SyncIQ policies to utilize encrypted communications.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_ENCRYPTION_REQUIRED" + }, + "force_interface": { + "description": "NOTE: This field should not be changed without the help of PowerScale support. Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet.", + "type": "boolean" + }, + "max_concurrent_jobs": { + "description": "The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.", + "maximum": 1000, + "minimum": 0, + "type": "integer" + }, + "ocsp_address": { + "description": "The address of the OCSP responder to which to connect.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "ocsp_issuer_certificate_id": { + "description": "The ID of the certificate authority that issued the certificate whose revocation status is being checked.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "renegotiation_period": { + "description": "If specified, the duration to persist encrypted connection before forcing a renegotiation.", + "maximum": 2147483646, + "minimum": 60, + "type": "integer" + }, + "report_email": { + "description": "Email sync reports to these addresses.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "report_max_age": { + "description": "The default length of time (in seconds) a policy report will be stored.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_AGE" + }, + "report_max_count": { + "description": "The default maximum number of reports to retain for a policy.", + "maximum": 2000, + "minimum": 1, + "type": "integer", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_REPORT_SETTINGS_REPORT_MAX_COUNT" + }, + "restrict_target_network": { + "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation. If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone. If you specify false, replication policies are not restricted to specific nodes on the target cluster.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_DEFAULT_POLICY_SETTINGS_RESTRICT_TARGET_NETWORK" + }, + "rpo_alerts": { + "description": "If disabled, no RPO alerts will be generated.", + "type": "boolean", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_GLOBAL_SETTINGS_RPO_ALERTS" + }, + "service": { + "description": "Specifies if the SyncIQ service currently on, paused, or off. If paused, all sync jobs will be paused. If turned off, all jobs will be canceled.", + "enum": [ + "on", + "off", + "paused" + ], + "type": "string", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS_SERVICE" + }, + "service_history_max_age": { + "description": "Maximum age of service information to maintain, in seconds.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_history_max_count": { + "description": "Maximum number of historical service information records to maintain.", + "maximum": 2000, + "minimum": 1, + "type": "integer" + }, + "source_network": { + "$ref": "#/definitions/v1SyncPolicySourceNetwork" + }, + "tw_chkpt_interval": { + "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "use_workers_per_node": { + "description": "If enabled, SyncIQ will use the deprecated workers_per_node field with worker pools functionality and limit workers accordingly.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SYNCIQ_SETTINGS" + }, + "v7TargetReport": { + "properties": { + "action": { + "description": "The action to be taken by this job.", + "enum": [ + "resync_prep", + "allow_write", + "allow_write_revert", + "test", + "run", + "none" + ], + "type": "string" + }, + "ads_streams_replicated": { + "description": "The number of ads streams replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "block_specs_replicated": { + "description": "The number of block specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_recoverable": { + "description": "The number of bytes recoverable by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "bytes_transferred": { + "description": "The number of bytes that have been transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "char_specs_replicated": { + "description": "The number of char specs replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "committed_files": { + "description": "The number of WORM committed files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "corrected_lins": { + "description": "The number of LINs corrected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dead_node": { + "description": "This field is true if the node running this job is dead.", + "type": "boolean" + }, + "directories_replicated": { + "description": "The number of directories replicated.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_changed": { + "description": "The number of directories changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_deleted": { + "description": "The number of directories deleted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_moved": { + "description": "The number of directories moved by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dirs_new": { + "description": "The number of directories created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "duration": { + "description": "The amount of time in seconds between when the job was started and when it ended. If the job has not yet ended, this is the amount of time since the job started. This field is null if the job has not yet started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "encrypted": { + "description": "If true, syncs will be encrypted.", + "type": "boolean" + }, + "end_time": { + "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "The primary error message for this job.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "error_checksum_files_skipped": { + "description": "The number of files with checksum errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_io_files_skipped": { + "description": "The number of files with io errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error_net_files_skipped": { + "description": "The number of files with network errors skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "errors": { + "description": "A list of error messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "failed_chunks": { + "description": "Tyhe number of data chunks that failed transmission.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fifos_replicated": { + "description": "The number of fifos replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_data_bytes": { + "description": "The number of bytes transferred that belong to files.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_changed": { + "description": "The number of files changed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_linked": { + "description": "The number of files linked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_new": { + "description": "The number of files created by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_selected": { + "description": "The number of files selected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_transferred": { + "description": "The number of files transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_unlinked": { + "description": "The number of files unlinked by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "files_with_ads_replicated": { + "description": "The number of files with ads replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "flipped_lins": { + "description": "The number of LINs flipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hard_links_replicated": { + "description": "The number of hard links replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_fixed": { + "description": "The number of hash exceptions fixed by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "hash_exceptions_found": { + "description": "The number of hash exceptions found by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "A unique identifier for this object.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "job_id": { + "description": "The ID of the job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins_total": { + "description": "The number of LINs transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_source": { + "description": "The total number of bytes sent to the source by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "network_bytes_to_target": { + "description": "The total number of bytes sent to the target by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "new_files_replicated": { + "description": "The number of new files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "num_retransmitted_files": { + "description": "The number of files that have been retransmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phases": { + "description": "Data for each phase of this job.", + "items": { + "$ref": "#/definitions/v1SyncJobPhase" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "policy_id": { + "description": "The ID of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "quotas_deleted": { + "description": "The number of quotas removed from the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "regular_files_replicated": { + "description": "The number of regular files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "resynced_lins": { + "description": "The number of LINs resynched by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "retransmitted_files": { + "description": "The files that have been retransmitted by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "retry": { + "description": "The number of times the job has been retried.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "running_chunks": { + "description": "The number of data chunks currently being transmitted.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "service_report": { + "description": "Data for each component exported as part of service replication.", + "items": { + "$ref": "#/definitions/v15SyncJobServiceReportItem" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "sockets_replicated": { + "description": "The number of sockets replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_bytes_recovered": { + "description": "The number of bytes recovered on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_created": { + "description": "The number of directories created on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_deleted": { + "description": "The number of directories deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_linked": { + "description": "The number of directories linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_unlinked": { + "description": "The number of directories unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_directories_visited": { + "description": "The number of directories visited on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_deleted": { + "description": "The number of files deleted on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_linked": { + "description": "The number of files linked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_files_unlinked": { + "description": "The number of files unlinked on the source.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "source_host": { + "description": "Hostname or IP address of sync source cluster.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "sparse_data_bytes": { + "description": "The number of sparse data bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "start_time": { + "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "state": { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "subreport_count": { + "description": "The number of subreports that are available for this job report.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "succeeded_chunks": { + "description": "The number of data chunks that have been transmitted successfully.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "symlinks_replicated": { + "description": "The number of symlinks replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "sync_type": { + "description": "The type of sync being performed by this job.", + "enum": [ + "invalid", + "legacy", + "initial", + "incremental", + "upgrade", + "fofb", + "domainmark" + ], + "type": "string" + }, + "target_bytes_recovered": { + "description": "The number of bytes recovered on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_created": { + "description": "The number of directories created on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_deleted": { + "description": "The number of directories deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_linked": { + "description": "The number of directories linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_directories_unlinked": { + "description": "The number of directories unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_deleted": { + "description": "The number of files deleted on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_linked": { + "description": "The number of files linked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_files_unlinked": { + "description": "The number of files unlinked on the target.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "target_path": { + "description": "Absolute filesystem path on the target cluster for the sync destination.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "target_snapshots": { + "description": "The target snapshots created by this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "total_chunks": { + "description": "The total number of data chunks transmitted by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_data_bytes": { + "description": "The total number of bytes transferred by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_exported_services": { + "description": "The total number of components exported as part of service replication.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_files": { + "description": "The number of files affected by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_network_bytes": { + "description": "The total number of bytes sent over the network by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "total_phases": { + "description": "The total number of phases for this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "unchanged_data_bytes": { + "description": "The number of bytes unchanged by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "up_to_date_files_skipped": { + "description": "The number of up-to-date files skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "updated_files_replicated": { + "description": "The number of updated files replicated by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_conflict_files_skipped": { + "description": "The number of files with user conflicts skipped by this job.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "warnings": { + "description": "A list of warning messages for this job.", + "items": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "uniqueItems": false + }, + "worm_committed_file_conflicts": { + "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "files_new", + "error_io_files_skipped", + "encrypted", + "policy_name", + "target_directories_unlinked", + "network_bytes_to_source", + "hash_exceptions_fixed", + "failed_chunks", + "dirs_moved", + "error_net_files_skipped", + "fifos_replicated", + "source_directories_linked", + "start_time", + "target_directories_linked", + "dead_node", + "source_bytes_recovered", + "retransmitted_files", + "lins_total", + "new_files_replicated", + "dirs_changed", + "total_phases", + "files_unlinked", + "sockets_replicated", + "end_time", + "bytes_transferred", + "regular_files_replicated", + "file_data_bytes", + "target_directories_deleted", + "hash_exceptions_found", + "duration", + "sparse_data_bytes", + "running_chunks", + "phases", + "errors", + "resynced_lins", + "bytes_recoverable", + "state", + "committed_files", + "block_specs_replicated", + "sync_type", + "job_id", + "source_host", + "corrected_lins", + "action", + "target_files_unlinked", + "total_data_bytes", + "symlinks_replicated", + "source_files_unlinked", + "total_chunks", + "files_with_ads_replicated", + "target_files_deleted", + "dirs_new", + "files_selected", + "num_retransmitted_files", + "target_snapshots", + "unchanged_data_bytes", + "target_bytes_recovered", + "user_conflict_files_skipped", + "target_files_linked", + "files_transferred", + "source_directories_visited", + "target_path", + "network_bytes_to_target", + "error", + "directories_replicated", + "total_network_bytes", + "source_directories_deleted", + "target_directories_created", + "id", + "quotas_deleted", + "flipped_lins", + "char_specs_replicated", + "updated_files_replicated", + "source_directories_unlinked", + "ads_streams_replicated", + "total_files", + "source_files_linked", + "warnings", + "source_directories_created", + "hard_links_replicated", + "succeeded_chunks", + "files_changed", + "retry", + "worm_committed_file_conflicts", + "error_checksum_files_skipped", + "subreport_count", + "dirs_deleted", + "files_linked", + "up_to_date_files_skipped", + "source_files_deleted", + "policy_id" + ], + "type": "object" + }, + "v7TargetReports": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v7TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SYNCIQ_TARGET_REPORTS" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7TargetReportsExtended": { + "additionalProperties": false, + "properties": { + "reports": { + "items": { + "$ref": "#/definitions/v7TargetReport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7TargetReportsRidSubreports": { + "additionalProperties": false, + "properties": { + "subreports": { + "items": { + "$ref": "#/definitions/v7ReportsReportSubreportsSubreport" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7UpgradeCluster": { + "description": "Cluster wide upgrade status info.", + "properties": { + "cluster_overview": { + "$ref": "#/definitions/v12UpgradeClusterClusterOverview" + }, + "cluster_state": { + "description": "The different states of an upgrade, rollback, or assessment. One of the following values: 'committed', 'upgraded', 'partially upgraded', 'upgrading', 'rolling back', 'assessing', 'error'", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "committed_features": { + "$ref": "#/definitions/v12UpgradeClusterCommittedFeatures" + }, + "current_process": { + "description": "The current upgrade activity.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "finish_time": { + "description": "The time when a rollback, assessment or upgrade has finished completely. Use ISO 8601 standard. Null if the cluster_state is not 'upgraded'.", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs. Null if the cluster_state is 'committed' or 'upgraded.'", + "maxLength": 4096, + "minLength": 5, + "type": "string" + }, + "node_median_time": { + "description": "The median time (seconds) to complete each node so far during this upgrade. Before the first node in an upgrade has completed this key will have an associated null value.", + "type": "integer" + }, + "onefs_version_current": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "onefs_version_upgrade": { + "$ref": "#/definitions/v12UpgradeClusterOnefsVersionCurrent" + }, + "patch_action": { + "description": "The most recent patch action performed.", + "maxLength": 128, + "minLength": 3, + "type": "string" + }, + "patch_name": { + "description": "The patch with the most recent patch action.", + "maxLength": 128, + "minLength": 0, + "type": "string" + }, + "start_time": { + "description": "The time when an upgrade, rollback, or assessment was started. Use ISO 8601 standard. Null if the cluster_state is 'committed' or 'partially upgraded.'", + "maxLength": 128, + "minLength": 4, + "type": "string" + }, + "upgrade_is_committed": { + "description": "True if upgrade is committed.", + "type": "boolean" + }, + "upgrade_process_state": { + "description": "The different states of upgrade process. One of the following values: 'Not started', 'Running', 'Pausing', 'Paused'. ", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "upgrade_settings": { + "$ref": "#/definitions/v12UpgradeClusterUpgradeSettings" + }, + "upgrade_triggered_time": { + "description": "Time at which upgrade was originally requested.", + "maxLength": 128, + "minLength": 4, + "type": "string" + } + }, + "type": "object" + }, + "v7WormDomain": { + "properties": { + "autocommit_offset": { + "description": "Specifies the autocommit time period for the domain in seconds. After a file is in the domain without being modified for the specified time period, the file is automatically committed. If this parameter is set to null, there is no autocommit time, and files must be committed manually.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_retention": { + "description": "Specifies the default amount of time, in seconds, that a file in this domain will be protected for. The default retention period is applied if no retention date is manually set on the file. This parameter can also be set to 'forever', 'use_min' (which applies the 'min_retention' option), or 'use_max' (which applies the 'max_retention' option).", + "enum": [ + "use_min", + "use_max", + "forever" + ], + "type": "string" + }, + "exclusions": { + "description": "A list of directories excluded from WORM protection. In a POST/PUT request this collection specifies the directories that the user wishes to create SmartLock exclusion directories on underneath this SmartLock directory. In a GET request this collection specifies all of the exclusion directories that exist underneath this SmartLock directory.", + "items": { + "$ref": "#/definitions/v7WormDomainExclusion" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "max_retention": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "enum": [ + "forever" + ], + "type": "string" + }, + "min_retention": { + "description": "Specifies the minimum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a shorter retention period. If this parameter is set to null, this minimum value is not enforced. This parameter can also be set to 'forever'.", + "enum": [ + "forever" + ], + "type": "string" + }, + "override_date": { + "description": "Specifies the override retention date for the domain. If this date is later than the retention date for any committed file, the file will remain protected until the override retention date.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "Specifies the root path of this domain. Files in this directory and all sub-directories will be protected.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "privileged_delete": { + "description": "When this value is set to 'on', files in this domain can be deleted through the privileged delete feature. If this value is set to 'disabled', privileged file deletes are permanently disabled and cannot be turned on again.", + "enum": [ + "on", + "off", + "disabled" + ], + "type": "string" + }, + "set_pending_delete": { + "description": "If true, the domain is irreversibly marked for deletion. This is used for compliance domains and allows compliance store directories to be deleted, while disallowing the creation or committing of new/existing files.", + "type": "boolean" + }, + "type": { + "description": "Specifies whether the domain is an enterprise domain or a compliance domain. Compliance domains can not be created on enterprise clusters. Enterprise and compliance domains can be created on compliance clusters.", + "enum": [ + "enterprise", + "compliance", + "compliance (legacy)" + ], + "type": "string" + } + }, + "required": [ + "path" + ], + "type": "object" + }, + "v7WormDomainExclusion": { + "properties": { + "id": { + "description": "Specifies the system-assigned ID for the WORM exclusion domain.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lin": { + "description": "Specifies the logical inode number (LIN) for the root of this domain.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "Specifies the root path of this domain. Files in this directory and all sub-directories will not be protected.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v7WormDomainExtended": { + "properties": { + "autocommit_offset": { + "description": "Specifies the autocommit time period for the domain in seconds. After a file is in the domain without being modified for the specified time period, the file is automatically committed. If this parameter is set to null, there is no autocommit time, and files must be committed manually.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "default_retention": { + "description": "Specifies the default amount of time, in seconds, that a file in this domain will be protected for. The default retention period is applied if no retention date is manually set on the file. This parameter can also be set to 'forever', 'use_min' (which applies the 'min_retention' option), or 'use_max' (which applies the 'max_retention' option).", + "enum": [ + "use_min", + "use_max", + "forever" + ], + "type": "string" + }, + "exclusions": { + "description": "A list of directories excluded from WORM protection. In a POST/PUT request this collection specifies the directories that the user wishes to create SmartLock exclusion directories on underneath this SmartLock directory. In a GET request this collection specifies all of the exclusion directories that exist underneath this SmartLock directory.", + "items": { + "$ref": "#/definitions/v7WormDomainExclusion" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "max_retention": { + "description": "Specifies the maximum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a longer retention period. If this parameter is set to null, an infinite length retention period is set.", + "enum": [ + "forever" + ], + "type": "string" + }, + "min_retention": { + "description": "Specifies the minimum amount of time, in seconds, that a file in this domain will be protected. This setting will override the retention period of any file committed with a shorter retention period. If this parameter is set to null, this minimum value is not enforced. This parameter can also be set to 'forever'.", + "enum": [ + "forever" + ], + "type": "string" + }, + "override_date": { + "description": "Specifies the override retention date for the domain. If this date is later than the retention date for any committed file, the file will remain protected until the override retention date.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "privileged_delete": { + "description": "When this value is set to 'on', files in this domain can be deleted through the privileged delete feature. If this value is set to 'disabled', privileged file deletes are permanently disabled and cannot be turned on again.", + "enum": [ + "on", + "off", + "disabled" + ], + "type": "string" + }, + "set_pending_delete": { + "description": "If true, the domain is irreversibly marked for deletion. This is used for compliance domains and allows compliance store directories to be deleted, while disallowing the creation or committing of new/existing files.", + "type": "boolean" + }, + "type": { + "description": "Specifies whether the domain is an enterprise domain or a compliance domain. Compliance domains can not be created on enterprise clusters. Enterprise and compliance domains can be created on compliance clusters.", + "enum": [ + "enterprise", + "compliance", + "compliance (legacy)" + ], + "type": "string" + } + }, + "type": "object" + }, + "v7WormDomains": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/Createv7WormDomainResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7WormDomainsExtended": { + "additionalProperties": false, + "properties": { + "domains": { + "items": { + "$ref": "#/definitions/Createv7WormDomainResponse" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ZoneGroup": { + "description": "Maps a gsid/gid to a groupname.", + "properties": { + "gid": { + "description": "Specifies a numeric group identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "groupname": { + "description": "The groupname associated with the gsid/gid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "gsid": { + "description": "Specifies a group security identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ZoneGroups": { + "additionalProperties": false, + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of id resolution errors that occurred during the bulk resolution. This list is included with a successful response.", + "items": { + "$ref": "#/definitions/v7IdResolutionDomainsError" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "groups": { + "items": { + "$ref": "#/definitions/v7ZoneGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v7ZoneUser": { + "description": "Maps an sid/uid to a username.", + "properties": { + "sid": { + "description": "Specifies a security identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "uid": { + "description": "Specifies a numeric user identifier.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "username": { + "description": "The username associated with the sid/uid.", + "maxLength": 255, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v7ZoneUsers": { + "additionalProperties": false, + "properties": { + "errors": { + "additionalProperties": false, + "description": "A list of id resolution errors that occurred during the bulk resolution. This list is included with a successful response.", + "items": { + "$ref": "#/definitions/v7IdResolutionDomainsError" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/definitions/v7ZoneUser" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ZonesZidGroups": { + "additionalProperties": false, + "properties": { + "groups": { + "items": { + "$ref": "#/definitions/v7ZoneGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v7ZonesZidUsers": { + "additionalProperties": false, + "properties": { + "users": { + "items": { + "$ref": "#/definitions/v7ZoneUser" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v8ChangelistEntries": { + "additionalProperties": false, + "properties": { + "entries": { + "items": { + "$ref": "#/definitions/v8ChangelistEntry" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v8ChangelistEntry": { + "properties": { + "atime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "btime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "change_types": { + "description": "The types of change for this entry.", + "items": { + "enum": [ + "ENTRY_MODIFIED", + "ENTRY_ADDED", + "ENTRY_REMOVED", + "ENTRY_PATH_CHANGED", + "ENTRY_HAS_ADS", + "ENTRY_ADS", + "ENTRY_HAS_HARDLINKS", + "ENTRY_PARENT_REMOVED", + "ENTRY_PATH_LOOKUP_REQ", + "ENTRY_WORM_COMMITTED" + ], + "type": "string" + }, + "maxItems": 9, + "minItems": 1, + "type": "array" + }, + "ctime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "data_pool": { + "description": "The data disk pool ID of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "file_type": { + "description": "Type of file.", + "enum": [ + "(REMOVED)", + "regular", + "directory", + "symlink", + "fifo", + "socket", + "char device", + "block device", + "unknown" + ], + "type": "string" + }, + "gid": { + "description": "The Group ID defined flags of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "id": { + "description": "The ID of the changelist entry.", + "maxLength": 20, + "minLength": 1, + "type": "string" + }, + "lin": { + "description": "The LIN number of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metadata_pool": { + "description": "The metadata disk pool ID of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "mtime": { + "$ref": "#/definitions/v10ChangelistEntryCtime" + }, + "parent_lin": { + "description": "The Parent LIN number of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "The relative path to the file associated with the entry.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "physical_size": { + "description": "The physical size of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "size": { + "description": "The size of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid": { + "description": "The User ID flags of the file associated with the entry.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "user_flags": { + "description": "The user defined flags of the file associated with the entry.", + "items": { + "enum": [ + "sappnd", + "arch", + "schg", + "sunlnk", + "snapshot", + "uappnd", + "uarch", + "hidden", + "uchg", + "nodump", + "uunlnk", + "offline", + "opaque", + "rdonly", + "reparse", + "sparse", + "system", + "inherit", + "writecache", + "wcinherit", + "noindex", + "ssmartlinked", + "noscow", + "scachedsmartlink", + "shasntfsacl", + "shasntfsog", + "sparentsupgraded", + "sbackupsparse", + "ads", + "hasads", + "wcendurant" + ], + "type": "string" + }, + "maxItems": 32, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "parent_lin", + "file_type", + "lin", + "physical_size", + "metadata_pool", + "gid", + "data_pool", + "path", + "uid", + "id", + "size" + ], + "type": "object" + }, + "v8ChangelistsChangelistEntries": { + "additionalProperties": false, + "properties": { + "entries": { + "items": { + "$ref": "#/definitions/v8ChangelistEntry" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v8FsaIndex": { + "properties": { + "index": { + "items": { + "description": "The name of an FSA index table.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "maxItems": 1024, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "index" + ], + "type": "object" + }, + "v8IndexNameLins": { + "additionalProperties": false, + "properties": { + "lins": { + "items": { + "$ref": "#/definitions/v8NameLin" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "v8NameLin": { + "properties": { + "atime": { + "description": "The Unix epoch time of the file access.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "btime": { + "description": "The Unix epoch time of the file birth.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "ctime": { + "description": "The Unix epoch time of the file creation.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "flags": { + "description": "Bitmap of flags representing file or directory attributes.", + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "gid": { + "description": "Group ID of the file.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lin": { + "description": "Logical Inode Number of file or directory.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "link_count": { + "description": "Link count of file.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "logical_size": { + "description": "Logical file size in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "max_snapid": { + "description": "Maximum Snapshot ID for file.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "min_snapid": { + "description": "Minimum Snapshot ID for file.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "mode": { + "description": "Mode bits (Unix file permissions) on the file.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "mtime": { + "description": "The Unix epoch time of the file modification.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of file or directory.", + "maxLength": 256, + "minLength": 0, + "type": "string" + }, + "parent_lin": { + "description": "Parent Logical Inode Number of file or directory.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "path": { + "description": "Path of file or directory.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "physical_size": { + "description": "Physical file size in bytes.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "uid": { + "description": "User ID of the file.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "max_snapid", + "logical_size", + "ctime", + "physical_size", + "lin", + "min_snapid", + "btime", + "gid", + "flags", + "mode", + "mtime", + "uid", + "atime", + "parent_lin", + "link_count", + "name" + ], + "type": "object" + }, + "v8NameLins": { + "additionalProperties": false, + "properties": { + "length": { + "description": "The number of entries in the output.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "lins": { + "items": { + "$ref": "#/definitions/v8NameLin" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "required": [ + "length" + ], + "type": "object" + }, + "v8QuotaQuota": { + "properties": { + "container": { + "description": "If true, SMB shares using the quota directory see the quota thresholds as share size.", + "type": "boolean" + }, + "efficiency_ratio": { + "description": "Represents the ratio of logical space provided to physical space used. This accounts for protection overhead, metadata, and compression ratios for the data.", + "maximum": 1.79769e+308, + "minimum": 0, + "type": "number", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_EFFICIENCYRATIO" + }, + "enforced": { + "description": "True if the quota provides enforcement, otherwise a accounting quota.", + "type": "boolean" + }, + "id": { + "description": "The system ID given to the quota.", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "include_snapshots": { + "description": "If true, quota governs snapshot data as well as head data.", + "type": "boolean" + }, + "linked": { + "description": "For user, group and directory quotas, true if the quota is linked and controlled by a parent default-* quota. Linked quotas cannot be modified until they are unlinked.", + "type": "boolean" + }, + "notifications": { + "description": "Summary of notifications: 'custom' indicates one or more notification rules available from the notifications sub-resource; 'default' indicates system default rules are used; 'disabled' indicates that no notifications will be used for this quota.; 'badmap' indicates that notification rule has problem in rule map.", + "enum": [ + "custom", + "default", + "disabled", + "badmap" + ], + "maxLength": 8, + "minLength": 6, + "type": "string" + }, + "path": { + "description": "The /ifs path governed.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "persona": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "ready": { + "description": "True if the default resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "thresholds": { + "$ref": "#/definitions/v12QuotaQuotaThresholdsExtended" + }, + "thresholds_on": { + "description": "Thresholds apply on quota accounting metric.", + "enum": [ + "applogicalsize", + "fslogicalsize", + "physicalsize" + ], + "type": "string", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_THRESHOLDSON" + }, + "type": { + "description": "The type of quota.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v8QuotaQuotaUsage" + } + }, + "required": [ + "enforced", + "include_snapshots", + "container", + "usage", + "thresholds", + "persona", + "linked", + "notifications", + "ready", + "path", + "type", + "id" + ], + "type": "object" + }, + "v8QuotaQuotaUsage": { + "properties": { + "applogical": { + "description": "Bytes used by governed data apparent to application.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "applogical_ready": { + "description": "True if applogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "fslogical": { + "description": "Bytes used by governed data apparent to filesystem.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "fslogical_ready": { + "description": "True if fslogical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "fsphysical": { + "description": "Physical data usage adjusted to account for shadow store efficiency", + "maximum": 2147483646, + "minimum": 0, + "type": "integer", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT_USAGE_FSPHYSICAL" + }, + "fsphysical_ready": { + "description": "True if fsphysical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "inodes": { + "description": "Number of inodes (filesystem entities) used by governed data.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "inodes_ready": { + "description": "True if inodes resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "physical": { + "description": "Bytes used for governed data and filesystem overhead.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "physical_ready": { + "description": "True if physical resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + }, + "shadow_refs": { + "description": "Number of shadow references (cloned, deduplicated or packed filesystem blocks) used by governed data.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "shadow_refs_ready": { + "description": "True if shadow_refs resource accounting is accurate on the quota. If false, this quota is waiting on completion of a QuotaScan job.", + "type": "boolean" + } + }, + "required": [ + "inodes_ready", + "physical_ready", + "fslogical_ready", + "fsphysical_ready", + "fslogical", + "applogical", + "shadow_refs", + "applogical_ready", + "shadow_refs_ready", + "inodes", + "physical" + ], + "type": "object" + }, + "v8QuotaQuotas": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v8QuotaQuota" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_QUOTA_QUOTAMANAGEMENT" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + } + }, + "type": "object" + }, + "v8QuotaQuotasExtended": { + "additionalProperties": false, + "properties": { + "quotas": { + "items": { + "$ref": "#/definitions/v8QuotaQuota" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v8RoleMembers": { + "additionalProperties": false, + "properties": { + "members": { + "items": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v8SshSettings": { + "additionalProperties": false, + "properties": { + "settings": { + "$ref": "#/definitions/v8SshSettingsSettings" + } + }, + "type": "object" + }, + "v8SshSettingsExtended": { + "description": "Specifies the properties for SSH authentication settings.", + "properties": { + "auth_settings_template": { + "description": "Specifies the configuration template for the supported method by which a user is authenticated.", + "enum": [ + "password", + "publickey", + "both", + "any", + "custom" + ], + "type": "string" + }, + "authentication_methods": { + "description": "Specifies the authentication methods that must be successfully completed for a user to be granted access.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "banner": { + "description": "Specifies file name to be used as SSH warning banner that is shown before the password prompt", + "maxLength": 4096, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "ca_signature_algorithms": { + "description": "Specifies which algorithms are allowed for signing of certificates by certificate authorities (CAs).", + "maxLength": 4096, + "minLength": 0, + "pattern": "^(\\+?)(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|rsa-sha2-512|rsa-sha2-256|ssh-rsa)(,(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|rsa-sha2-512|rsa-sha2-256|ssh-rsa))*$", + "type": "string" + }, + "challenge_response_authentication": { + "description": "Specifies whether challenge-response authentication is allowed.", + "type": "boolean" + }, + "ciphers": { + "description": "Specifies the ciphers allowed for protocol version 2.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com)(,(aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com))*$", + "type": "string" + }, + "host_key_algorithms": { + "description": "Specifies the protocol version 2 host key algorithms the server offers.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "ignore_rhosts": { + "description": "If true, ignores .rhosts and .shosts files.", + "type": "boolean" + }, + "kex_algorithms": { + "description": "Specifies the available KEX algorithms.", + "maxLength": 4096, + "minLength": 18, + "pattern": "^(\\+?)(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521)(,(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521))*$", + "type": "string" + }, + "keyboard_interactive_authentication": { + "description": "Specifies whether to allow keyboard-interactive authentication.", + "type": "boolean" + }, + "log_level": { + "description": "Specifies the log level when logging messages from sshd(8).", + "enum": [ + "INFO", + "QUIET", + "FATAL", + "ERROR", + "VERBOSE", + "DEBUG", + "DEBUG1", + "DEBUG2", + "DEBUG3" + ], + "type": "string" + }, + "login_grace_time": { + "description": "Specifies the length of time in seconds before idle log in fails. If the value is 0, there is no time limit.", + "maximum": 600, + "minimum": 0, + "type": "integer" + }, + "macs": { + "description": "Specifies the available MAC algorithms.", + "maxLength": 4096, + "minLength": 8, + "pattern": "^(\\+?)(hmac-sha1|hmac-sha2-256|hmac-sha2-512|umac-128@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com)(,(hmac-sha1|hmac-sha2-256|hmac-sha2-512|umac-128@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com))*$", + "type": "string" + }, + "match": { + "description": "Specifies match blocks.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "max_auth_tries": { + "description": "Specifies the maximum number of authentication attempts per connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_sessions": { + "description": "Specifies the maximum number of open sessions permitted per network connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_startups": { + "description": "Specifies maximum number of unauthenticated connections.", + "maxLength": 11, + "minLength": 0, + "pattern": "^$|^([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9])$", + "type": "string" + }, + "password_authentication": { + "description": "Specifies whether password authentication is allowed.", + "type": "boolean" + }, + "permit_empty_passwords": { + "description": "Enable empty passwords if password authentication is allowed.", + "type": "boolean" + }, + "permit_root_login": { + "description": "Enable root SSH login.", + "type": "boolean" + }, + "port": { + "description": "Specifies the port sshd(8) should listen on", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "print_motd": { + "description": "Enable printing /etc/motd when a user logs in.", + "type": "boolean" + }, + "pubkey_accepted_key_types": { + "description": "Specifies the accepted public key types.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "pubkey_authentication": { + "description": "Specifies whether public key authentication is allowed.", + "type": "boolean" + }, + "strict_modes": { + "description": "Specifies if sshd(8) should check home directory permissions before accepting login.", + "type": "boolean" + }, + "subsystem": { + "description": "Specifies an external subsystem.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\\n]*$", + "type": "string" + }, + "syslog_facility": { + "description": "Specifies the facility code when logging messages from sshd(8).", + "enum": [ + "AUTH", + "DAEMON", + "USER", + "LOCAL0", + "LOCAL1", + "LOCAL2", + "LOCAL3", + "LOCAL4", + "LOCAL5", + "LOCAL6", + "LOCAL7" + ], + "type": "string" + }, + "tcp_keep_alive": { + "description": "Enable sending TCP keep alive messages.", + "type": "boolean" + }, + "use_dns": { + "description": "Specifies whether sshd should look up the remote host name.", + "type": "boolean" + }, + "use_pam": { + "description": "Enables the Pluggable Authentication Module interface.", + "type": "boolean" + } + }, + "type": "object" + }, + "v8SshSettingsSettings": { + "description": "Specifies the properties for SSH authentication settings.", + "properties": { + "auth_settings_template": { + "description": "Specifies the configuration template for the supported method by which a user is authenticated.", + "enum": [ + "password", + "publickey", + "both", + "any", + "custom" + ], + "type": "string" + }, + "authentication_methods": { + "description": "Specifies the authentication methods that must be successfully completed for a user to be granted access.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "banner": { + "description": "Specifies file name to be used as SSH warning banner that is shown before the password prompt", + "maxLength": 4096, + "minLength": 0, + "pattern": "^[^\n]*$", + "type": "string" + }, + "ca_signature_algorithms": { + "description": "Specifies which algorithms are allowed for signing of certificates by certificate authorities (CAs).", + "maxLength": 4096, + "minLength": 0, + "pattern": "^(\\+?)(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|rsa-sha2-512|rsa-sha2-256|ssh-rsa)(,(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-ed25519|rsa-sha2-512|rsa-sha2-256|ssh-rsa))*$", + "type": "string" + }, + "challenge_response_authentication": { + "description": "Specifies whether challenge-response authentication is allowed.", + "type": "boolean" + }, + "ciphers": { + "description": "Specifies the ciphers allowed for protocol version 2.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(3des-cbc|aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com)(,(3des-cbc|aes128-cbc|aes192-cbc|aes256-cbc|aes128-ctr|aes192-ctr|aes256-ctr|aes128-gcm@openssh\\.com|aes256-gcm@openssh\\.com|chacha20-poly1305@openssh\\.com))*$", + "type": "string" + }, + "host_key_algorithms": { + "description": "Specifies the protocol version 2 host key algorithms the server offers.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "ignore_rhosts": { + "description": "If true, ignores .rhosts and .shosts files.", + "type": "boolean" + }, + "kex_algorithms": { + "description": "Specifies the available KEX algorithms.", + "maxLength": 4096, + "minLength": 18, + "pattern": "^(\\+?)(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521)(,(curve25519-sha256|curve25519-sha256@libssh\\.org|diffie-hellman-group1-sha1|diffie-hellman-group14-sha1|diffie-hellman-group14-sha256|diffie-hellman-group16-sha512|diffie-hellman-group18-sha512|diffie-hellman-group-exchange-sha1|diffie-hellman-group-exchange-sha256|ecdh-sha2-nistp256|ecdh-sha2-nistp384|ecdh-sha2-nistp521))*$", + "type": "string" + }, + "keyboard_interactive_authentication": { + "description": "Specifies whether to allow keyboard-interactive authentication.", + "type": "boolean" + }, + "log_level": { + "description": "Specifies the log level when logging messages from sshd(8).", + "enum": [ + "INFO", + "QUIET", + "FATAL", + "ERROR", + "VERBOSE", + "DEBUG", + "DEBUG1", + "DEBUG2", + "DEBUG3" + ], + "type": "string" + }, + "login_grace_time": { + "description": "Specifies the length of time in seconds before idle log in fails. If the value is 0, there is no time limit.", + "maximum": 600, + "minimum": 0, + "type": "integer" + }, + "macs": { + "description": "Specifies the available MAC algorithms.", + "maxLength": 4096, + "minLength": 8, + "pattern": "^(\\+?)(hmac-md5|hmac-md5-96|hmac-sha1|hmac-sha1-96|hmac-sha2-256|hmac-sha2-512|umac-64@openssh.com|umac-128@openssh.com|hmac-md5-etm@openssh.com|hmac-md5-96-etm@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha1-96-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com)(,(hmac-md5|hmac-md5-96|hmac-sha1|hmac-sha1-96|hmac-sha2-256|hmac-sha2-512|umac-64@openssh.com|umac-128@openssh.com|hmac-md5-etm@openssh.com|hmac-md5-96-etm@openssh.com|hmac-sha1-etm@openssh.com|hmac-sha1-96-etm@openssh.com|hmac-sha2-256-etm@openssh.com|hmac-sha2-512-etm@openssh.com|umac-64-etm@openssh.com|umac-128-etm@openssh.com))*$", + "type": "string" + }, + "match": { + "description": "Specifies match blocks.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "max_auth_tries": { + "description": "Specifies the maximum number of authentication attempts per connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_sessions": { + "description": "Specifies the maximum number of open sessions permitted per network connection.", + "maximum": 1024, + "minimum": 0, + "type": "integer" + }, + "max_startups": { + "description": "Specifies maximum number of unauthenticated connections.", + "maxLength": 11, + "minLength": 0, + "pattern": "^$|^([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9]):([0-9]|[0-9][0-9]|[0-9][0-9][0-9])$", + "type": "string" + }, + "password_authentication": { + "description": "Specifies whether password authentication is allowed.", + "type": "boolean" + }, + "permit_empty_passwords": { + "description": "Enable empty passwords if password authentication is allowed.", + "type": "boolean" + }, + "permit_root_login": { + "description": "Enable root SSH login.", + "type": "boolean" + }, + "port": { + "description": "Specifies the port sshd(8) should listen on", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "print_motd": { + "description": "Enable printing /etc/motd when a user logs in.", + "type": "boolean" + }, + "pubkey_accepted_key_types": { + "description": "Specifies the accepted public key types.", + "maxLength": 4096, + "minLength": 7, + "pattern": "^(\\+?)(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com)(,(ssh-ed25519|ssh-ed25519-cert-v01@openssh\\.com|ssh-rsa|ssh-dss|ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-rsa-cert-v01@openssh\\.com|ssh-dss-cert-v01@openssh\\.com|ecdsa-sha2-nistp256-cert-v01@openssh\\.com|ecdsa-sha2-nistp384-cert-v01@openssh\\.com|ecdsa-sha2-nistp521-cert-v01@openssh\\.com))*$", + "type": "string" + }, + "pubkey_authentication": { + "description": "Specifies whether public key authentication is allowed.", + "type": "boolean" + }, + "strict_modes": { + "description": "Specifies if sshd(8) should check home directory permissions before accepting login.", + "type": "boolean" + }, + "subsystem": { + "description": "Specifies an external subsystem.", + "maxLength": 1024, + "minLength": 0, + "pattern": "^[^\\n]*$", + "type": "string" + }, + "syslog_facility": { + "description": "Specifies the facility code when logging messages from sshd(8).", + "enum": [ + "AUTH", + "DAEMON", + "USER", + "LOCAL0", + "LOCAL1", + "LOCAL2", + "LOCAL3", + "LOCAL4", + "LOCAL5", + "LOCAL6", + "LOCAL7" + ], + "type": "string" + }, + "tcp_keep_alive": { + "description": "Enable sending TCP keep alive messages.", + "type": "boolean" + }, + "use_dns": { + "description": "Specifies whether sshd should look up the remote host name.", + "type": "boolean" + }, + "use_pam": { + "description": "Enables the Pluggable Authentication Module interface.", + "type": "boolean" + } + }, + "type": "object" + }, + "v9ClusterUnblock": { + "description": "Unblock parallel upgrade.", + "properties": { + "unblock": { + "type": "boolean" + } + }, + "required": [ + "unblock" + ], + "type": "object" + }, + "v9ClusterUpgradeItem": { + "description": "The settings necessary to start an upgrade.", + "properties": { + "install_image_id": { + "description": "The ID of the signed artifact stored in the catalog.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "install_image_path": { + "description": "The location (path) of the upgrade image which must be within /ifs.", + "maxLength": 4096, + "minLength": 1, + "type": "string" + }, + "nodes_to_rolling_upgrade": { + "description": "The nodes (to be) scheduled for upgrade ordered by queue position number. Null if the cluster_state is 'partially upgraded' or upgrade_type is 'simultaneous'. One of the following values: [, , ... ], 'all', null", + "items": { + "description": "The lnn of the node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 99999, + "minItems": 0, + "type": "array" + }, + "patch_paths": { + "description": "List of additional patches to install during the upgrade.", + "items": { + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "type": "array" + }, + "skip_optional": { + "description": "Used to indicate that the pre-upgrade check should be skipped.", + "type": "boolean" + }, + "upgrade_type": { + "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous, parallel'", + "enum": [ + "rolling", + "parallel", + "simultaneous" + ], + "type": "string" + } + }, + "required": [ + "upgrade_type" + ], + "type": "object" + }, + "v9DatasetFilter": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v9DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v9DatasetFilterExtended": { + "additionalProperties": false, + "description": "Once a dataset is configured using metrics, a filter can be specified to produce a list of top workloads based on the remaining non-filtered metrics for those workloads matching the filtered metrics.", + "properties": { + "creation_time": { + "description": "Timestamp of when the filter was applied.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the filter configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The filter ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v9DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the filter. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v9DatasetFilterMetricValues": { + "additionalProperties": false, + "description": "Configurable metrics.", + "properties": { + "export_id": { + "description": "NFS export ID", + "maximum": 2147483646, + "minimum": 0, + "type": "number" + }, + "groupname": { + "description": "groupname", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "local_address": { + "description": "Local IPv4, IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "path": { + "description": "Path of tracked directory", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "protocol": { + "description": "The protocol used for the request", + "enum": [ + "smb1", + "smb2", + "nfs3", + "nfs4" + ], + "type": "string" + }, + "remote_address": { + "description": "Client IPv4 or IPv6 address, address range, or subnet.", + "maxLength": 91, + "minLength": 1, + "pattern": "^[0-9a-fA-F:./-]*$", + "type": "string" + }, + "share_name": { + "description": "SMB share name", + "maxLength": 320, + "minLength": 1, + "type": "string" + }, + "username": { + "description": "username", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "zone_name": { + "description": "The zone name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "v9DatasetFilterMetricValuesExtended": { + "allOf": [ + { + "$ref": "#/definitions/v9DatasetFilterMetricValues" + }, + { + "description": "Performance metric values that can be used to pin workloads and apply filters, and performance metric values that are used to display information about the system performance dataset.", + "properties": { + "job_type": { + "description": "The job type.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "system_name": { + "description": "The system name", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "v9DatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v9DatasetFilterExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v9DatasetWorkload": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "metric_values": { + "$ref": "#/definitions/v9DatasetFilterMetricValues" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "metric_values" + ], + "type": "object" + }, + "v9DatasetWorkloadExtended": { + "additionalProperties": false, + "description": "A workload that can be pinned to a dataset for viewing.", + "properties": { + "creation_time": { + "description": "Timestamp of when the workload was pinned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dataset_id": { + "description": "Unique identifier of the associated dataset.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "error": { + "description": "If this field is present, then there was an error fetching the workload configuration.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "id": { + "description": "The workload ID. Unique and automatically assigned.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "metric_values": { + "$ref": "#/definitions/v9DatasetFilterMetricValuesExtended" + }, + "name": { + "description": "The name of the workload. User specified.", + "maxLength": 80, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "v9DatasetWorkloads": { + "additionalProperties": false, + "properties": { + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "workloads": { + "items": { + "$ref": "#/definitions/v9DatasetWorkloadExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v9DatasetsDatasetFilters": { + "additionalProperties": false, + "properties": { + "filters": { + "items": { + "$ref": "#/definitions/v9DatasetFilterExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "filters" + ], + "type": "object" + }, + "v9DatasetsDatasetWorkloads": { + "additionalProperties": false, + "properties": { + "workloads": { + "items": { + "$ref": "#/definitions/v9DatasetWorkloadExtended" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "workloads" + ], + "type": "object" + }, + "v9EventEventgroupDefinitions": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v9EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + }, + "resume": { + "description": "Provide this token as the 'resume' query argument to continue listing results.", + "maxLength": 8192, + "minLength": 0, + "type": "string" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v9EventEventgroupDefinitionsEventgroup-Definition": { + "description": "Description of an eventgroup that can occur and be detected.", + "properties": { + "category": { + "description": "ID of eventgroup category: all, 100000000 (SYS_DISK_EVENTS), 200000000 (NODE_STATUS_EVENTS), 300000000 (REBOOT_EVENTS), 400000000 (SW_EVENTS), 500000000 (QUOTA_EVENTS), 600000000 (SNAP_EVENTS), 700000000 (WINNET_EVENTS), 800000000 (FILESYS_EVENTS), 900000000 (HW_EVENTS), 1100000000 (CPOOL_EVENTS).", + "enum": [ + "all", + "100000000", + "200000000", + "300000000", + "400000000", + "500000000", + "600000000", + "700000000", + "800000000", + "900000000", + "1100000000", + "Unknown" + ], + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Human readable description - may contain value placeholders.", + "type": "string" + }, + "id": { + "description": "Unique Identifier.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Name for eventgroup.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "no_ignore": { + "description": "True if event should not be ignored.", + "type": "boolean" + } + }, + "type": "object" + }, + "v9EventEventgroupDefinitionsExtended": { + "additionalProperties": false, + "properties": { + "eventgroup-definitions": { + "items": { + "$ref": "#/definitions/v9EventEventgroupDefinitionsEventgroup-Definition" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v9HdfsSettings": { + "properties": { + "settings": { + "$ref": "#/definitions/v9HdfsSettingsSettings" + } + }, + "type": "object" + }, + "v9HdfsSettingsSettings": { + "description": "This is schema that contains HDFS protocol properties.", + "properties": { + "ambari_metrics_collector": { + "description": "Ambari metrics collector.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "ambari_namenode": { + "description": "NameNode of Ambari server.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "ambari_server": { + "description": "Ambari server", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "authentication_mode": { + "description": "Type of authentication for HDFS protocol.", + "enum": [ + "simple_only", + "kerberos_only" + ], + "type": "string" + }, + "data_transfer_cipher": { + "description": "Encryption algorithm to use for data transfer (if any).", + "enum": [ + "none", + "aes_128_ctr", + "aes_192_ctr", + "aes_256_ctr" + ], + "type": "string" + }, + "default_block_size": { + "description": "Block size (size=2**value) reported by HDFS server.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "default_checksum_type": { + "description": "Checksum type reported by HDFS server.", + "enum": [ + "none", + "crc32", + "crc32c" + ], + "type": "string" + }, + "odp_version": { + "description": "ODP stack repository version number.", + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "root_directory": { + "description": "HDFS root directory.", + "maxLength": 4096, + "minLength": 4, + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + "service": { + "description": "Enable or disable the HDFS service.", + "type": "boolean" + }, + "webhdfs_enabled": { + "description": "Enable or disable WebHDFS.", + "type": "boolean" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_HDFS_SETTINGS" + }, + "v9ResultDirPoolsUsage": { + "properties": { + "begin_time": { + "description": "Unix Epoch time of start of results collection job.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_depth": { + "description": "Directory depth.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "dir_usage": { + "$ref": "#/definitions/v9ResultDirPoolsUsageDirUsage" + }, + "storage_pool_type": { + "description": "The type of the storage pool.", + "enum": [ + "node_pool" + ], + "type": "string" + }, + "usage_data": { + "description": "Disk usage classified by specified storage pool type.", + "items": { + "description": "Disk usage by the named storage pool.", + "properties": { + "ads_cnt": { + "description": "Number of alternate data streams.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_cnt": { + "description": "Number of directories.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "file_cnt": { + "description": "Number of files.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum": { + "description": "Logical pool usage by directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum_overflow": { + "description": "Logical size sum of overflow in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of the storage pool.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "other_cnt": { + "description": "Other count.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "phys_size_sum": { + "description": "Physical pool usage by directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "type": "object" + }, + "maxItems": 128, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "usage_data", + "dir_usage", + "storage_pool_type", + "dir_depth", + "begin_time" + ], + "type": "object" + }, + "v9ResultDirPoolsUsageDirUsage": { + "description": "Disk usage by the current directory.", + "properties": { + "ads_cnt": { + "description": "Number of alternate data streams.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "dir_cnt": { + "description": "Number of directories.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "file_cnt": { + "description": "Number of files.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "lin": { + "description": "Logical inode number.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "log_size_sum": { + "description": "Logical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "log_size_sum_overflow": { + "description": "Logical size sum of overflow in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "name": { + "description": "Name of directory.", + "maxLength": 4096, + "minLength": 0, + "type": "string" + }, + "other_cnt": { + "description": "Other count.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + }, + "parent": { + "description": "Parent directory inode.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "phys_size_sum": { + "description": "Physical size directory in bytes.", + "maximum": 2147483646, + "minimum": -2147483646, + "type": "integer" + } + }, + "type": "object" + }, + "v9StoragepoolNodepool": { + "properties": { + "assess": { + "description": "Test that the action is possible", + "type": "boolean" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "lnns": { + "description": "The node membership change requested for this node pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The node pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "node_type_ids": { + "description": "The node types that are part of this pool.", + "items": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "protection_policy": { + "description": "The node pool protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "tier": { + "description": "The name or ID of the node pool's tier, if it is in a tier.", + "type": "string" + } + }, + "required": [ + "name", + "lnns" + ], + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "v9StoragepoolNodepoolExtended": { + "properties": { + "can_disable_l3": { + "description": "Indicates if disabling L3 is possible.", + "type": "boolean" + }, + "can_enable_l3": { + "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives.", + "type": "boolean" + }, + "health_flags": { + "description": "An array of containing any health issues with this pool. If the pool is healthy, the list is empty.", + "items": { + "enum": [ + "underprovisioned", + "missing_drives", + "devices_down", + "devices_smartfailed", + "waiting_repair" + ], + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "The system ID given to the node pool.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "l3_status": { + "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", + "enum": [ + "l3", + "storage", + "migrating" + ], + "type": "string" + }, + "lnns": { + "description": "The nodes that are part of this node pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "manual": { + "description": "Whether or not the node pool is manually managed.", + "type": "boolean" + }, + "name": { + "description": "The node pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "node_type_ids": { + "description": "The node types that are part of this pool.", + "items": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "protection_policy": { + "description": "The underlying protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "tier": { + "description": "The name (if named) or system ID of the node pool's tier, if it is in a tier. Otherwise null.", + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v1StoragepoolNodepoolUsage" + } + }, + "required": [ + "name", + "lnns", + "l3_status", + "manual", + "can_enable_l3", + "l3", + "can_disable_l3", + "tier", + "node_type_ids", + "id" + ], + "type": "object" + }, + "v9StoragepoolNodepoolExtendedExtended": { + "properties": { + "assess": { + "description": "Test that the action is possible", + "type": "boolean" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "lnns": { + "description": "The node membership change requested for this node pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "name": { + "description": "The node pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "node_type_ids": { + "description": "The node types that are part of this pool.", + "items": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "protection_policy": { + "description": "The node pool protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "tier": { + "description": "The name or ID of the node pool's tier, if it is in a tier.", + "type": "string" + } + }, + "type": "object", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "v9StoragepoolNodepools": { + "additionalProperties": false, + "properties": { + "nodepools": { + "items": { + "$ref": "#/definitions/v9StoragepoolNodepoolExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODEPOOLS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v9StoragepoolNodepoolsExtended": { + "additionalProperties": false, + "properties": { + "nodepools": { + "items": { + "$ref": "#/definitions/v9StoragepoolNodepoolExtended" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v9StoragepoolNodetype": { + "properties": { + "id": { + "description": "The system ID given to the nodetype.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "lnns": { + "description": "The nodes that are part of this nodetype.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "manual": { + "description": "Whether or not the nodetype is in a manually managed node pool.", + "type": "boolean" + }, + "product_name": { + "description": "The product name of the node type.", + "maxLength": 255, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "product_name", + "manual", + "id", + "lnns" + ], + "type": "object" + }, + "v9StoragepoolNodetypes": { + "additionalProperties": false, + "properties": { + "nodetypes": { + "items": { + "$ref": "#/definitions/v9StoragepoolNodetype" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_NODETYPES" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + }, + "v9StoragepoolNodetypesExtended": { + "additionalProperties": false, + "properties": { + "nodetypes": { + "items": { + "$ref": "#/definitions/v9StoragepoolNodetype" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array" + } + }, + "type": "object" + }, + "v9StoragepoolStoragepool": { + "properties": { + "can_disable_l3": { + "description": "Indicates if disabling L3 is possible.", + "type": "boolean" + }, + "can_enable_l3": { + "description": "Indicates if enabling L3 is possible. L3 cannot be enabled if there are unprovisioned drives.", + "type": "boolean" + }, + "children": { + "description": "The names or IDs of the pool's children.", + "items": { + "type": "string" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "health_flags": { + "description": "An array of containing any health issues with this pool. If the pool is healthy, the list is empty. Only appears on 'nodepool' type storagepools.", + "items": { + "enum": [ + "underprovisioned", + "missing_drives", + "devices_down", + "devices_smartfailed", + "waiting_repair" + ], + "type": "string" + }, + "maxItems": 5, + "minItems": 0, + "type": "array" + }, + "id": { + "description": "The system ID given to the pool.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "l3": { + "description": "Use SSDs in this node pool for L3 cache.", + "type": "boolean" + }, + "l3_status": { + "description": "'storage' if the 'l3' option is disabled. If the l3 option is enabled, 'migrating' if any SSDs in this node pool have not yet been migrated to L3. If all SSDs have been migrated, 'l3'.", + "enum": [ + "l3", + "storage", + "migrating" + ], + "type": "string" + }, + "lnns": { + "description": "The nodes that are part of this pool.", + "items": { + "description": "Logical Node Number (LNN) of a node.", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "manual": { + "description": "Whether or not the node pool is manually managed.", + "type": "boolean" + }, + "name": { + "description": "The pool name.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "node_type_ids": { + "description": "The node types that are part of this pool.", + "items": { + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "maxItems": 2147483647, + "minItems": 0, + "type": "array" + }, + "protection_policy": { + "description": "The underlying protection policy.", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "The pool type.", + "enum": [ + "tier", + "nodepool" + ], + "type": "string" + }, + "usage": { + "$ref": "#/definitions/v1StoragepoolNodepoolUsage" + } + }, + "required": [ + "name", + "lnns", + "node_type_ids", + "type", + "id" + ], + "type": "object" + }, + "v9StoragepoolStoragepools": { + "additionalProperties": false, + "properties": { + "storagepools": { + "items": { + "$ref": "#/definitions/v9StoragepoolStoragepool" + }, + "maxItems": 2147483646, + "minItems": 0, + "type": "array", + "x-privilege": "ISI_PRIV_SMARTPOOLS_STORAGEPOOL_POOLDETAILS" + }, + "total": { + "description": "Total number of items available.", + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + } + }, + "type": "object" + } + }, + "host": "YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080", + "info": { + "contact": { + "email": "support@dell.com", + "name": "PowerScale OneFS API Team", + "url": "https://github.com/Isilon/isilon_sdk" + }, + "description": "PowerScale OneFS RESTful API detailed description for supported endpoints.", + "title": "PowerScale OneFS API Documentation", + "version": "15" + }, + "paths": { + "/namespace": { + "get": { + "description": "Retrieves the namespace access points available for the authenticated user.", + "operationId": "listAccessPoints", + "parameters": [ + { + "description": "Protocol versions that are supported for the current namespace access server.", + "in": "query", + "name": "versions", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List namespace access points.", + "schema": { + "$ref": "#/definitions/NamespaceAccessPoints" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/AccessPointName={AccessPointName}": { + "delete": { + "description": "Deletes a namespace access point. Only root users can delete namespace access points.", + "operationId": "deleteAccessPoint", + "parameters": [ + { + "description": "Access point name.", + "in": "path", + "name": "AccessPointName", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Deleted access point.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Creates a namespace access point in the file system. Only root users can create or change namespace access points.", + "operationId": "createAccessPoint", + "parameters": [ + { + "description": "Access point name.", + "in": "path", + "name": "AccessPointName", + "required": true, + "type": "string" + }, + { + "description": "Access point parameters model.", + "in": "body", + "name": "AccessPoint", + "required": true, + "schema": { + "$ref": "#/definitions/AccessPointCreateParams" + } + } + ], + "responses": { + "200": { + "description": "Created access point.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/DirectoryCopyTarget={DirectoryCopyTarget}": { + "put": { + "description": "Recursively copies a directory to a specified destination path. Symbolic links are copied as regular files.", + "operationId": "copyDirectory", + "parameters": [ + { + "description": "Directory copy destination relative to /.", + "in": "path", + "name": "DirectoryCopyTarget", + "required": true, + "type": "string" + }, + { + "description": "Specifies the full path to the source directory.", + "in": "header", + "name": "x-isi-ifs-copy-source", + "required": true, + "type": "string" + }, + { + "description": "Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS from the header, when set to true.", + "in": "query", + "name": "overwrite", + "type": "boolean" + }, + { + "description": "Specifies if the contents of a directory should be merged with an existing directory with the same name.", + "in": "query", + "name": "merge", + "type": "boolean" + }, + { + "description": "Specifies whether to continue the copy operation on remaining objects when there is a conflict or error.", + "in": "query", + "name": "continue", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Copied directory.", + "schema": { + "$ref": "#/definitions/CopyErrors" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/DirectoryMetadataPath={DirectoryMetadataPath}": { + "get": { + "description": "Retrieves the attribute information for a specified directory with the metadata query argument.", + "operationId": "getDirectoryMetadata", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "DirectoryMetadataPath", + "required": true, + "type": "string" + }, + { + "description": "Show directory metadata.", + "in": "query", + "name": "metadata", + "required": true, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Get directory metadata.", + "schema": { + "$ref": "#/definitions/NamespaceMetadataList" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Sets attributes on a specified directory with the metadata query argument.", + "operationId": "setDirectoryMetadata", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "DirectoryMetadataPath", + "required": true, + "type": "string" + }, + { + "description": "Set directory metadata.", + "in": "query", + "name": "metadata", + "required": true, + "type": "boolean" + }, + { + "description": "Directory metadata parameters model.", + "in": "body", + "name": "DirectoryMetadata", + "required": true, + "schema": { + "$ref": "#/definitions/NamespaceMetadata" + } + } + ], + "responses": { + "200": { + "description": "Set metadata on directory.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/DirectoryPath={DirectoryPath}": { + "delete": { + "description": "Deletes the directory at the specified path.", + "operationId": "deleteDirectory", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "DirectoryPath", + "required": true, + "type": "string" + }, + { + "description": "Deletes directories recursively, when set to true.", + "in": "query", + "name": "recursive", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Deleted directory.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "get": { + "description": "Retrieves a list of files and subdirectories from a directory.", + "operationId": "getDirectoryContents", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "DirectoryPath", + "required": true, + "type": "string" + }, + { + "description": "Specifies which object attributes are displayed.", + "in": "query", + "name": "detail", + "type": "string" + }, + { + "description": "Specifies the maximum number of objects to send to the client.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Specifies a token to return in the JSON result to indicate when there is a next page.", + "in": "query", + "name": "resume", + "type": "string" + }, + { + "description": "Specifies one or more attributes to sort on the directory entries.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Specifies the sort direction. This value can be either ascending (ASC) or descending (DESC).", + "in": "query", + "name": "dir", + "type": "string" + }, + { + "description": "Specifies the object type to return, which can be one of the following values: container, object, pipe, character_device, block_device, symbolic_link, socket, or whiteout_file.", + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Specifies if hidden objects are returned.", + "in": "query", + "name": "hidden", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List directory objects.", + "schema": { + "$ref": "#/definitions/NamespaceObjects" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "head": { + "description": "Retrieves the attribute information for a specified directory without transferring the contents of the directory.", + "operationId": "getDirectoryAttributes", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "DirectoryPath", + "required": true, + "type": "string" + }, + { + "description": "Returns only files that were modified since the specified time. If no files were modified since this time, a 304 message is returned.", + "in": "header", + "name": "If-Modified-Since", + "type": "string" + }, + { + "description": "Returns only files that were not modified since the specified time. If there are no unmodified files since this time, a 412 message is returned to indicate that the precondition failed.", + "in": "header", + "name": "If-Unmodified-Since", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get attribute information for directory.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "post": { + "description": "Moves a directory from an existing source to a new destination path.", + "operationId": "moveDirectory", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "DirectoryPath", + "required": true, + "type": "string" + }, + { + "description": "Specifies the full path for the destination directory.", + "in": "header", + "name": "x-isi-ifs-set-location", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Move directory.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Creates a directory with a specified path.", + "operationId": "createDirectory", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "DirectoryPath", + "required": true, + "type": "string" + }, + { + "default": "container", + "description": "Specifies the resource type.", + "in": "header", + "name": "x-isi-ifs-target-type", + "required": true, + "type": "string" + }, + { + "default": "0700", + "description": "Specifies a pre-defined ACL value or POSIX mode with a string in octal string format.", + "in": "header", + "name": "x-isi-ifs-access-control", + "type": "string" + }, + { + "description": "Specifies a pre-defined ACL value or POSIX mode with a string.", + "in": "header", + "name": "x-isi-ifs-node-pool-name", + "type": "string" + }, + { + "description": "Specifies the OneFS node pool name.", + "in": "query", + "name": "recursive", + "type": "boolean" + }, + { + "description": "Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS from the header, when set to true.", + "in": "query", + "name": "overwrite", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Create directory.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/FileCopyTarget={FileCopyTarget}": { + "put": { + "description": "Copies a file to the specified destination path.", + "operationId": "copyFile", + "parameters": [ + { + "description": "File copy destination relative to /.", + "in": "path", + "name": "FileCopyTarget", + "required": true, + "type": "string" + }, + { + "description": "Specifies the full path to the source file.", + "in": "header", + "name": "x-isi-ifs-copy-source", + "required": true, + "type": "string" + }, + { + "description": "You must set this parameter to true in order to clone a file.", + "in": "query", + "name": "clone", + "type": "boolean" + }, + { + "description": "Specifies a snapshot name to clone the file from.", + "in": "query", + "name": "snapshot", + "type": "string" + }, + { + "description": "Specifies if an existing file should be overwritten by a new file with the same name.", + "in": "query", + "name": "overwrite", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Copied file.", + "schema": { + "$ref": "#/definitions/CopyErrors" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/FileMetadataPath={FileMetadataPath}": { + "get": { + "description": "Retrieves the attribute information for a specified file with the metadata query argument.", + "operationId": "getFileMetadata", + "parameters": [ + { + "description": "File path relative to /.", + "in": "path", + "name": "FileMetadataPath", + "required": true, + "type": "string" + }, + { + "description": "Show file metadata.", + "in": "query", + "name": "metadata", + "required": true, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Get file metadata.", + "schema": { + "$ref": "#/definitions/NamespaceMetadataList" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Sets attributes on a specified file with the metadata query argument through the JSON body.", + "operationId": "setFileMetadata", + "parameters": [ + { + "description": "File path relative to /.", + "in": "path", + "name": "FileMetadataPath", + "required": true, + "type": "string" + }, + { + "description": "Set file metadata.", + "in": "query", + "name": "metadata", + "required": true, + "type": "boolean" + }, + { + "description": "File metadata parameters model.", + "in": "body", + "name": "FileMetadata", + "required": true, + "schema": { + "$ref": "#/definitions/NamespaceMetadata" + } + } + ], + "responses": { + "200": { + "description": "Set metadata on file.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/FilePath={FilePath}": { + "delete": { + "description": "Deletes the specified file.", + "operationId": "deleteFile", + "parameters": [ + { + "description": "File path relative to /.", + "in": "path", + "name": "FilePath", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Deleted file.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "get": { + "description": "Retrieves the contents of a file from a specified path. Note that file streaming is not supported.", + "operationId": "getFileContents", + "parameters": [ + { + "description": "File path relative to /.", + "in": "path", + "name": "FilePath", + "required": true, + "type": "string" + }, + { + "description": "Returns the specified range bytes of an object. ", + "in": "header", + "name": "Range", + "type": "string" + }, + { + "description": "Returns only files that were modified since the specified time. If no files were modified since this time, a 304 message is returned.", + "in": "header", + "name": "If-Modified-Since", + "type": "string" + }, + { + "description": "Returns only files that were not modified since the specified time. If there are no unmodified files since this time, a 412 message is returned to indicate that the precondition failed.", + "in": "header", + "name": "If-Unmodified-Since", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get file objects.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "head": { + "description": "Retrieves the attribute information for a specified file.", + "operationId": "getFileAttributes", + "parameters": [ + { + "description": "File path relative to /.", + "in": "path", + "name": "FilePath", + "required": true, + "type": "string" + }, + { + "description": "Returns only files that were modified since the specified time. If no files were modified since this time, a 304 message is returned.", + "in": "header", + "name": "If-Modified-Since", + "type": "string" + }, + { + "description": "Returns only files that were not modified since the specified time. If there are no unmodified files since this time, a 412 message is returned to indicate that the precondition failed.", + "in": "header", + "name": "If-Unmodified-Since", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get attribute information for file.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "post": { + "description": "Moves a file to a destination path that does not yet exist.", + "operationId": "moveFile", + "parameters": [ + { + "description": "File path relative to /.", + "in": "path", + "name": "FilePath", + "required": true, + "type": "string" + }, + { + "description": "Specifies the full path for the destination file. ", + "in": "header", + "name": "x-isi-ifs-set-location", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Moved file.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Creates a file object with a given path. Note that file streaming is not supported.", + "operationId": "createFile", + "parameters": [ + { + "description": "File path relative to /.", + "in": "path", + "name": "FilePath", + "required": true, + "type": "string" + }, + { + "default": "object", + "description": "Specifies the resource type.", + "in": "header", + "name": "x-isi-ifs-target-type", + "required": true, + "type": "string" + }, + { + "default": "0600", + "description": "Specifies a pre-defined ACL value or POSIX mode with a string in octal string format.", + "in": "header", + "name": "x-isi-ifs-access-control", + "type": "string" + }, + { + "description": "Specifies the content encoding that was applied to the object content, so that decoding can be applied when retrieving the content.", + "in": "header", + "name": "Content-Encoding", + "type": "string" + }, + { + "default": "binary/octet-stream", + "description": "Specifies a standard MIME-type description of the content format.", + "in": "header", + "name": "Content-Type", + "type": "string" + }, + { + "description": "Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS from the header, when set to true.", + "in": "query", + "name": "overwrite", + "type": "boolean" + }, + { + "description": "The contents of the file object.", + "in": "body", + "name": "FileContents", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Created file object.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/NamespacePath={NamespacePath}": { + "get": { + "description": "Retrieves the access control list for a namespace object.", + "operationId": "getAcl", + "parameters": [ + { + "description": "Namespace path relative to /.", + "in": "path", + "name": "NamespacePath", + "required": true, + "type": "string" + }, + { + "description": "Show access control lists.", + "in": "query", + "name": "acl", + "required": true, + "type": "boolean" + }, + { + "description": "Indicates that the operation is on the access point instead of the store path.", + "in": "query", + "name": "nsaccess", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Get namespace ACL.", + "schema": { + "$ref": "#/definitions/NamespaceAcl" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Sets the access control list for a namespace.", + "operationId": "setAcl", + "parameters": [ + { + "description": "Namespace path relative to /.", + "in": "path", + "name": "NamespacePath", + "required": true, + "type": "string" + }, + { + "description": "Update access control lists.", + "in": "query", + "name": "acl", + "required": true, + "type": "boolean" + }, + { + "description": "Indicates that the operation is on the access point instead of the store path.", + "in": "query", + "name": "nsaccess", + "type": "boolean" + }, + { + "description": "Namespace ACL parameters model.", + "in": "body", + "name": "NamespaceAcl", + "required": true, + "schema": { + "$ref": "#/definitions/NamespaceAcl" + } + } + ], + "responses": { + "200": { + "description": "Set namespace ACL.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/QueryPath={QueryPath}": { + "post": { + "description": "Query objects by system-defined and user-defined attributes in a directory.", + "operationId": "queryDirectory", + "parameters": [ + { + "description": "Directory path relative to /.", + "in": "path", + "name": "QueryPath", + "required": true, + "type": "string" + }, + { + "description": "Enable directory query.", + "in": "query", + "name": "query", + "required": true, + "type": "boolean" + }, + { + "description": "Specifies the maximum number of objects to send to the client. You can set the value to a negative number to retrieve all objects.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Specifies which object attributes are displayed. If the detail parameter is excluded, only the name of the object is returned.", + "in": "query", + "name": "detail", + "type": "string" + }, + { + "description": "Specifies a token to return in the JSON result to indicate when there is a next page.", + "in": "query", + "name": "resume", + "type": "string" + }, + { + "description": "Specifies one or more attributes to sort on the directory entries.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Specifies the sort direction. This value can be either ascending (ASC) or descending (DESC).", + "in": "query", + "name": "dir", + "type": "string" + }, + { + "description": "Specifies the object type to return, which can be one of the following values: container, object, pipe, character_device, block_device, symbolic_link, socket, or whiteout_file.", + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Specifies if hidden objects are returned.", + "in": "query", + "name": "hidden", + "type": "boolean" + }, + { + "description": "Specifies the maximum directory level depth to search for objects.", + "in": "query", + "name": "max-depth", + "type": "integer" + }, + { + "description": "Directory query parameters model.", + "in": "body", + "name": "DirectoryQuery", + "required": true, + "schema": { + "$ref": "#/definitions/DirectoryQuery" + } + } + ], + "responses": { + "200": { + "description": "Directory query results.", + "schema": { + "$ref": "#/definitions/NamespaceObjects" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/{AccessPoint}/{ContainerPath}": { + "delete": { + "description": "Deletes the directory at the specified path.", + "operationId": "deleteDirectoryWithAccessPointContainerPath", + "parameters": [ + { + "description": "Access point.", + "in": "path", + "name": "AccessPoint", + "required": true, + "type": "string" + }, + { + "description": "Directory path relative to access point.", + "in": "path", + "name": "ContainerPath", + "required": true, + "type": "string" + }, + { + "description": "Deletes directories recursively, when set to true.", + "in": "query", + "name": "recursive", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Deleted directory.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "get": { + "description": "Retrieves a list of files and subdirectories from a directory.", + "operationId": "getDirectoryWithAccessPointContainerPath", + "parameters": [ + { + "description": "Access point.", + "in": "path", + "name": "AccessPoint", + "required": true, + "type": "string" + }, + { + "description": "Container path relative to access point.", + "in": "path", + "name": "ContainerPath", + "required": true, + "type": "string" + }, + { + "description": "Specifies which object attributes are displayed.", + "in": "query", + "name": "detail", + "type": "string" + }, + { + "description": "Specifies the maximum number of objects to send to the client.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Specifies a token to return in the JSON result to indicate when there is a next page.", + "in": "query", + "name": "resume", + "type": "string" + }, + { + "description": "Specifies one or more attributes to sort on the directory entries.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Specifies the sort direction. This value can be either ascending (ASC) or descending (DESC).", + "in": "query", + "name": "dir", + "type": "string" + }, + { + "description": "Specifies the object type to return, which can be one of the following values: container, object, pipe, character_device, block_device, symbolic_link, socket, or whiteout_file.", + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Specifies if hidden objects are returned.", + "in": "query", + "name": "hidden", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List directory objects.", + "schema": { + "$ref": "#/definitions/NamespaceObjects" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "post": { + "description": "Moves a directory from an existing source to a new destination path.", + "operationId": "moveDirectoryWithAccessPointContainerPath", + "parameters": [ + { + "description": "Access point.", + "in": "path", + "name": "AccessPoint", + "required": true, + "type": "string" + }, + { + "description": "Directory path relative to access point.", + "in": "path", + "name": "ContainerPath", + "required": true, + "type": "string" + }, + { + "description": "Specifies the full path for the destination directory.", + "in": "header", + "name": "x-isi-ifs-set-location", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Move directory.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Creates a directory with a specified accesspoint and container path.", + "operationId": "createDirectoryWithAccessPointContainerPath", + "parameters": [ + { + "description": "Access point.", + "in": "path", + "name": "AccessPoint", + "required": true, + "type": "string" + }, + { + "description": "Directory path relative to access point.", + "in": "path", + "name": "ContainerPath", + "required": true, + "type": "string" + }, + { + "default": "container", + "description": "Specifies the resource type.", + "in": "header", + "name": "x-isi-ifs-target-type", + "required": true, + "type": "string" + }, + { + "default": "0700", + "description": "Specifies a pre-defined ACL value or POSIX mode with a string in octal string format.", + "in": "header", + "name": "x-isi-ifs-access-control", + "type": "string" + }, + { + "description": "Specifies a pre-defined ACL value or POSIX mode with a string.", + "in": "header", + "name": "x-isi-ifs-node-pool-name", + "type": "string" + }, + { + "description": "Specifies the OneFS node pool name.", + "in": "query", + "name": "recursive", + "type": "boolean" + }, + { + "description": "Deletes and replaces the existing user attributes and ACLs of the directory with user-specified attributes and ACLS from the header, when set to true.", + "in": "query", + "name": "overwrite", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Create directory using accesspoint and container path", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/namespace/{WormFilePath}": { + "get": { + "description": "Retrieves the WORM retention date and committed state of the file.", + "operationId": "getWormProperties", + "parameters": [ + { + "description": "Write once read many file path relative to /.", + "in": "path", + "name": "WormFilePath", + "required": true, + "type": "string" + }, + { + "description": "View WORM properties", + "in": "query", + "name": "worm", + "required": true, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "WORM file properties.", + "schema": { + "$ref": "#/definitions/WormProperties" + } + } + }, + "tags": [ + "Namespace" + ] + }, + "put": { + "description": "Sets the retention period and commits a file in a SmartLock directory.", + "operationId": "setWormProperties", + "parameters": [ + { + "description": "Write once read many file path relative to /.", + "in": "path", + "name": "WormFilePath", + "required": true, + "type": "string" + }, + { + "description": "View WORM properties", + "in": "query", + "name": "worm", + "required": true, + "type": "boolean" + }, + { + "description": "WORM parameters model.", + "in": "body", + "name": "WormProperties", + "required": true, + "schema": { + "$ref": "#/definitions/WormCreateParams" + } + } + ], + "responses": { + "200": { + "description": "WORM file properties.", + "schema": { + "$ref": "#/definitions/Empty" + } + } + }, + "tags": [ + "Namespace" + ] + } + }, + "/platform/1/audit/settings": { + "get": { + "description": "View Global Audit settings.", + "operationId": "getAuditv1AuditSettings", + "parameters": [], + "responses": { + "200": { + "description": "View Global Audit settings.", + "schema": { + "$ref": "#/definitions/v1AuditSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "put": { + "description": "Modify Global Audit settings.", + "operationId": "updateAuditv1AuditSettings", + "parameters": [ + { + "in": "body", + "name": "v1AuditSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuditSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/1/audit/topics": { + "get": { + "description": "Retrieve a list of audit topics.", + "operationId": "listAuditv1AuditTopics", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve a list of audit topics.", + "schema": { + "$ref": "#/definitions/v1AuditTopics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "post": { + "description": "Create a new audit topic.", + "operationId": "createAuditv1AuditTopic", + "parameters": [ + { + "in": "body", + "name": "v1AuditTopic", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuditTopic" + } + } + ], + "responses": { + "200": { + "description": "Create a new audit topic.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/1/audit/topics/{v1AuditTopicId}": { + "delete": { + "description": "Delete the audit topic.", + "operationId": "deleteAuditv1AuditTopic", + "parameters": [ + { + "description": "Delete the audit topic.", + "in": "path", + "name": "v1AuditTopicId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "get": { + "description": "Retrieve the audit topic information.", + "operationId": "getAuditv1AuditTopic", + "parameters": [ + { + "description": "Retrieve the audit topic information.", + "in": "path", + "name": "v1AuditTopicId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the audit topic information.", + "schema": { + "$ref": "#/definitions/v1AuditTopics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "put": { + "description": "Modify the audit topic.", + "operationId": "updateAuditv1AuditTopic", + "parameters": [ + { + "in": "body", + "name": "v1AuditTopic", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuditTopicExtendedExtended" + } + }, + { + "description": "Modify the audit topic.", + "in": "path", + "name": "v1AuditTopicId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/1/auth/access/{v1AuthAccessUser}": { + "get": { + "description": "Determine user's access rights to a file", + "operationId": "getAuthv1AuthAccessUser", + "parameters": [ + { + "description": "Path to the file. Must be within /ifs.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "SMB share name", + "in": "query", + "name": "share", + "type": "string" + }, + { + "description": "Access zone the user is in.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Show the user's numeric identifier.", + "in": "query", + "name": "numeric", + "type": "boolean" + }, + { + "description": "Determine user's access rights to a file", + "in": "path", + "name": "v1AuthAccessUser", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Determine user's access rights to a file", + "schema": { + "$ref": "#/definitions/v1AuthAccess" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/groups": { + "delete": { + "description": "Flush the groups cache.", + "operationId": "deleteAuthv1AuthGroups", + "parameters": [ + { + "description": "If true, only flush cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Filter groups by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter groups by provider.", + "in": "query", + "name": "provider", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "List all groups.", + "operationId": "listAuthv1AuthGroups", + "parameters": [ + { + "description": "Filter groups by domain.", + "in": "query", + "name": "domain", + "type": "string" + }, + { + "description": "Filter groups by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, only return cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Filter groups by name prefix.", + "in": "query", + "name": "filter", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter groups by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Enumerate all groups that a group is a member of.", + "in": "query", + "name": "query_member_of", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List all groups.", + "schema": { + "$ref": "#/definitions/v1AuthGroups" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new group.", + "operationId": "createAuthv1AuthGroup", + "parameters": [ + { + "description": "Skip validation checks when creating a group.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Optional provider type.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v1AuthGroup", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthGroup" + } + } + ], + "responses": { + "200": { + "description": "Create a new group.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/groups/{Group}/members": { + "get": { + "description": "List all the members of the group.", + "operationId": "listAuthGroupsv1GroupMembers", + "parameters": [ + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter group members by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter group members by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "path", + "name": "Group", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the members of the group.", + "schema": { + "$ref": "#/definitions/v1GroupMembers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthGroups" + ] + }, + "post": { + "description": "Add a member to the group.", + "operationId": "createAuthGroupsv1GroupMember", + "parameters": [ + { + "description": "Filter group members by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter group members by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v1GroupMember", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + { + "in": "path", + "name": "Group", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a member to the group.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthGroups" + ] + } + }, + "/platform/1/auth/groups/{Group}/members/{v1GroupsGroupMemberId}": { + "delete": { + "description": "Remove the member from the group.", + "operationId": "deleteAuthv1GroupsGroupMember", + "parameters": [ + { + "description": "Filter group members by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter group members by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Remove the member from the group.", + "in": "path", + "name": "v1GroupsGroupMemberId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Group", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/groups/{v1AuthGroupId}": { + "delete": { + "description": "Delete the group.", + "operationId": "deleteAuthv1AuthGroup", + "parameters": [ + { + "description": "If true, flush the group from the cache.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Filter groups by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter groups by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Delete the group.", + "in": "path", + "name": "v1AuthGroupId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the group information.", + "operationId": "getAuthv1AuthGroup", + "parameters": [ + { + "description": "If true, only return cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Enumerate all groups that a group is a member of.", + "in": "query", + "name": "query_member_of", + "type": "boolean" + }, + { + "description": "Filter groups by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter groups by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Retrieve the group information.", + "in": "path", + "name": "v1AuthGroupId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the group information.", + "schema": { + "$ref": "#/definitions/v1AuthGroupsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the group.", + "operationId": "updateAuthv1AuthGroup", + "parameters": [ + { + "description": "Changes to the group ID can result in loss of access to the file system. To mitigate this risk of lost access, the force option is required for group ID changes.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Optional provider type.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v1AuthGroup", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthGroupExtendedExtended" + } + }, + { + "description": "Modify the group.", + "in": "path", + "name": "v1AuthGroupId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/id": { + "get": { + "description": "Retrieve the current security token.", + "operationId": "getAuthv1AuthId", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the current security token.", + "schema": { + "$ref": "#/definitions/v1AuthId" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/mapping/identities": { + "delete": { + "description": "Flush the entire idmap cache.", + "operationId": "deleteAuthv1MappingIdentities", + "parameters": [ + { + "description": "Filter to apply when deleting identity mappings.", + "enum": [ + "auto", + "external" + ], + "in": "query", + "name": "filter", + "type": "string" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete mapping instead of flush mapping cache.", + "in": "query", + "name": "remove", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Manually set or modify a mapping between two personae.", + "operationId": "createAuthv1MappingIdentities", + "parameters": [ + { + "description": "Create a bi-directional mapping from source to target and target to source.", + "in": "query", + "name": "2way", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Replace existing mappings.", + "in": "query", + "name": "replace", + "type": "boolean" + }, + { + "in": "body", + "name": "v1MappingIdentities", + "required": true, + "schema": { + "$ref": "#/definitions/v1MappingIdentities" + } + } + ], + "responses": { + "200": { + "description": "Manually set or modify a mapping between two personae.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/mapping/identities/{v1MappingIdentityId}": { + "delete": { + "description": "Flush the entire idmap cache.", + "operationId": "deleteAuthv1MappingIdentity", + "parameters": [ + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the bi-directional mapping from source to target and target to source.", + "in": "query", + "name": "2way", + "type": "boolean" + }, + { + "description": "Target identity persona.", + "in": "query", + "name": "target", + "type": "string" + }, + { + "description": "Delete mapping instead of flush mapping from cache.", + "in": "query", + "name": "remove", + "type": "boolean" + }, + { + "description": "Flush the entire idmap cache.", + "in": "path", + "name": "v1MappingIdentityId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve all identity mappings (uid, gid, sid, and on-disk) for the supplied source persona.", + "operationId": "getAuthv1MappingIdentity", + "parameters": [ + { + "description": "Idmap should attempt to create missing identity mappings.", + "in": "query", + "name": "nocreate", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve all identity mappings (uid, gid, sid, and on-disk) for the supplied source persona.", + "in": "path", + "name": "v1MappingIdentityId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve all identity mappings (uid, gid, sid, and on-disk) for the supplied source persona.", + "schema": { + "$ref": "#/definitions/v1MappingIdentitiesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Manually set or modify a mapping between two personae.", + "operationId": "createAuthv1MappingIdentity", + "parameters": [ + { + "description": "Desired mapping target to fetch/generate.", + "enum": [ + "uid", + "gid", + "sid" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1MappingIdentity", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "description": "Manually set or modify a mapping between two personae.", + "in": "path", + "name": "v1MappingIdentityId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Manually set or modify a mapping between two personae.", + "schema": { + "$ref": "#/definitions/v1MappingIdentitiesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/mapping/users/lookup": { + "get": { + "description": "Retrieve the user information.", + "operationId": "getAuthv1MappingUsersLookup", + "parameters": [ + { + "description": "The user's primary group ID.", + "in": "query", + "name": "primary_gid", + "type": "integer" + }, + { + "description": "The user ID.", + "in": "query", + "name": "uid", + "type": "integer" + }, + { + "description": "The zone the user belongs to.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "The IDs of the groups that the user belongs to.", + "in": "query", + "items": { + "type": "integer" + }, + "name": "gid", + "type": "array" + }, + { + "description": "The user name.", + "in": "query", + "name": "user", + "type": "string" + }, + { + "description": "The Kerberos principal name, of the form user@realm.", + "in": "query", + "name": "kerberos_principal", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the user information.", + "schema": { + "$ref": "#/definitions/v1MappingUsersLookup" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/mapping/users/rules": { + "get": { + "description": "Retrieve the user mapping rules.", + "operationId": "getAuthv1MappingUsersRules", + "parameters": [ + { + "description": "The zone to which the user mapping applies.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the user mapping rules.", + "schema": { + "$ref": "#/definitions/v1MappingUsersRules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the user mapping rules.", + "operationId": "updateAuthv1MappingUsersRules", + "parameters": [ + { + "description": "The zone to which the user mapping applies.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1MappingUsersRules", + "required": true, + "schema": { + "$ref": "#/definitions/v1MappingUsersRulesRules" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/netgroups/{v1AuthNetgroupId}": { + "get": { + "description": "Retrieve the user information.", + "operationId": "getAuthv1AuthNetgroup", + "parameters": [ + { + "description": "Ignore netgroup errors.", + "in": "query", + "name": "ignore_errors", + "type": "boolean" + }, + { + "description": "Perform recursive search.", + "in": "query", + "name": "recursive", + "type": "boolean" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Retrieve the user information.", + "in": "path", + "name": "v1AuthNetgroupId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the user information.", + "schema": { + "$ref": "#/definitions/v1AuthNetgroups" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/privileges": { + "get": { + "description": "List all privileges.", + "operationId": "getAuthv1AuthPrivileges", + "parameters": [], + "responses": { + "200": { + "description": "List all privileges.", + "schema": { + "$ref": "#/definitions/v1AuthPrivileges" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/ads": { + "get": { + "description": "List all ADS providers.", + "operationId": "listAuthv1ProvidersAds", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS providers.", + "schema": { + "$ref": "#/definitions/v1ProvidersAds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new ADS provider.", + "operationId": "createAuthv1ProvidersAdsItem", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersAdsItem", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersAdsItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new ADS provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/ads/{Id}/controllers": { + "get": { + "description": "List all ADS controllers.", + "operationId": "getAuthProvidersv1AdsProviderControllers", + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS controllers.", + "schema": { + "$ref": "#/definitions/v1AdsProviderControllers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthProviders" + ] + } + }, + "/platform/1/auth/providers/ads/{Id}/domains": { + "get": { + "description": "List all ADS domains.", + "operationId": "getAuthProvidersv1AdsProviderDomains", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS domains.", + "schema": { + "$ref": "#/definitions/v1AdsProviderDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthProviders" + ] + } + }, + "/platform/1/auth/providers/ads/{Id}/domains/{v1ProvidersAdsIdDomainId}": { + "get": { + "description": "Retrieve the ADS domain information.", + "operationId": "getAuthv1ProvidersAdsIdDomain", + "parameters": [ + { + "description": "Retrieve the ADS domain information.", + "in": "path", + "name": "v1ProvidersAdsIdDomainId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ADS domain information.", + "schema": { + "$ref": "#/definitions/v1AdsProviderDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/ads/{v1ProvidersAdsId}": { + "delete": { + "description": "Delete the ADS provider.", + "operationId": "deleteAuthv1ProvidersAdsById", + "parameters": [ + { + "description": "Delete the ADS provider.", + "in": "path", + "name": "v1ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the ADS provider.", + "operationId": "getAuthv1ProvidersAdsById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the ADS provider.", + "in": "path", + "name": "v1ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ADS provider.", + "schema": { + "$ref": "#/definitions/v1ProvidersAdsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the ADS provider.", + "operationId": "updateAuthv1ProvidersAdsById", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersAdsIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersAdsIdParams" + } + }, + { + "description": "Modify the ADS provider.", + "in": "path", + "name": "v1ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/file": { + "get": { + "description": "List all file providers.", + "operationId": "listAuthv1ProvidersFile", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all file providers.", + "schema": { + "$ref": "#/definitions/v1ProvidersFile" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new file provider.", + "operationId": "createAuthv1ProvidersFileItem", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersFileItem", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersFileItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new file provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/file/{v1ProvidersFileId}": { + "delete": { + "description": "Delete the file provider.", + "operationId": "deleteAuthv1ProvidersFileById", + "parameters": [ + { + "description": "Delete the file provider.", + "in": "path", + "name": "v1ProvidersFileId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the file provider.", + "operationId": "getAuthv1ProvidersFileById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the file provider.", + "in": "path", + "name": "v1ProvidersFileId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the file provider.", + "schema": { + "$ref": "#/definitions/v1ProvidersFile" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the file provider.", + "operationId": "updateAuthv1ProvidersFileById", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersFileIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersFileIdParams" + } + }, + { + "description": "Modify the file provider.", + "in": "path", + "name": "v1ProvidersFileId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/krb5": { + "get": { + "description": "List all KRB5 providers.", + "operationId": "listAuthv1ProvidersKrb5", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all KRB5 providers.", + "schema": { + "$ref": "#/definitions/v1ProvidersKrb5" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new KRB5 provider.", + "operationId": "createAuthv1ProvidersKrb5Item", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersKrb5Item", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersKrb5Item" + } + } + ], + "responses": { + "200": { + "description": "Create a new KRB5 provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/krb5/{v1ProvidersKrb5Id}": { + "delete": { + "description": "Delete the KRB5 provider.", + "operationId": "deleteAuthv1ProvidersKrb5ById", + "parameters": [ + { + "description": "Delete the KRB5 provider.", + "in": "path", + "name": "v1ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the KRB5 provider.", + "operationId": "getAuthv1ProvidersKrb5ById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the KRB5 provider.", + "in": "path", + "name": "v1ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the KRB5 provider.", + "schema": { + "$ref": "#/definitions/v1ProvidersKrb5Extended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the KRB5 provider.", + "operationId": "updateAuthv1ProvidersKrb5ById", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersKrb5IdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersKrb5IdParams" + } + }, + { + "description": "Modify the KRB5 provider.", + "in": "path", + "name": "v1ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/ldap": { + "get": { + "description": "List all LDAP providers.", + "operationId": "listAuthv1ProvidersLdap", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all LDAP providers.", + "schema": { + "$ref": "#/definitions/v1ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new LDAP provider.", + "operationId": "createAuthv1ProvidersLdapItem", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v1ProvidersLdapItem", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersLdapItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new LDAP provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/ldap/{v1ProvidersLdapId}": { + "delete": { + "description": "Delete the LDAP provider.", + "operationId": "deleteAuthv1ProvidersLdapById", + "parameters": [ + { + "description": "Delete the LDAP provider.", + "in": "path", + "name": "v1ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the LDAP provider.", + "operationId": "getAuthv1ProvidersLdapById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the LDAP provider.", + "in": "path", + "name": "v1ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the LDAP provider.", + "schema": { + "$ref": "#/definitions/v1ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the LDAP provider.", + "operationId": "updateAuthv1ProvidersLdapById", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v1ProvidersLdapIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersLdapIdParams" + } + }, + { + "description": "Modify the LDAP provider.", + "in": "path", + "name": "v1ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/local": { + "get": { + "description": "List all local providers.", + "operationId": "getAuthv1ProvidersLocal", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all local providers.", + "schema": { + "$ref": "#/definitions/v1ProvidersLocal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/local/{v1ProvidersLocalId}": { + "get": { + "description": "Retrieve the local provider.", + "operationId": "getAuthv1ProvidersLocalById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the local provider.", + "in": "path", + "name": "v1ProvidersLocalId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the local provider.", + "schema": { + "$ref": "#/definitions/v1ProvidersLocal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the local provider.", + "operationId": "updateAuthv1ProvidersLocalById", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersLocalIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersLocalIdParams" + } + }, + { + "description": "Modify the local provider.", + "in": "path", + "name": "v1ProvidersLocalId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/nis": { + "get": { + "description": "List all NIS providers.", + "operationId": "listAuthv1ProvidersNis", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NIS providers.", + "schema": { + "$ref": "#/definitions/v1ProvidersNis" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new NIS provider.", + "operationId": "createAuthv1ProvidersNisItem", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersNisItem", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersNisItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new NIS provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/nis/{v1ProvidersNisId}": { + "delete": { + "description": "Delete the NIS provider.", + "operationId": "deleteAuthv1ProvidersNisById", + "parameters": [ + { + "description": "Delete the NIS provider.", + "in": "path", + "name": "v1ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the NIS provider.", + "operationId": "getAuthv1ProvidersNisById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the NIS provider.", + "in": "path", + "name": "v1ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the NIS provider.", + "schema": { + "$ref": "#/definitions/v1ProvidersNis" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the NIS provider.", + "operationId": "updateAuthv1ProvidersNisById", + "parameters": [ + { + "in": "body", + "name": "v1ProvidersNisIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersNisIdParams" + } + }, + { + "description": "Modify the NIS provider.", + "in": "path", + "name": "v1ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/providers/summary": { + "get": { + "description": "Retrieve the summary information.", + "operationId": "getAuthv1ProvidersSummary", + "parameters": [ + { + "description": "Filter providers by zone.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the summary information.", + "schema": { + "$ref": "#/definitions/v1ProvidersSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/roles": { + "get": { + "description": "List all roles.", + "operationId": "listAuthv1AuthRoles", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all roles.", + "schema": { + "$ref": "#/definitions/v1AuthRoles" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new role.", + "operationId": "createAuthv1AuthRole", + "parameters": [ + { + "in": "body", + "name": "v1AuthRole", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthRole" + } + } + ], + "responses": { + "200": { + "description": "Create a new role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/roles/{Role}/members": { + "get": { + "description": "List all the members of the role.", + "operationId": "listAuthRolesv1RoleMembers", + "parameters": [ + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the members of the role.", + "schema": { + "$ref": "#/definitions/v1RoleMembers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + }, + "post": { + "description": "Add a member to the role.", + "operationId": "createAuthRolesv1RoleMember", + "parameters": [ + { + "in": "body", + "name": "v1RoleMember", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a member to the role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + } + }, + "/platform/1/auth/roles/{Role}/members/{v1RolesRoleMemberId}": { + "delete": { + "description": "Remove a member from the role.", + "operationId": "deleteAuthv1RolesRoleMember", + "parameters": [ + { + "description": "Remove a member from the role.", + "in": "path", + "name": "v1RolesRoleMemberId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/roles/{Role}/privileges": { + "get": { + "description": "List all privileges in the role.", + "operationId": "listAuthRolesv1RolePrivileges", + "parameters": [ + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all privileges in the role.", + "schema": { + "$ref": "#/definitions/v1RolePrivileges" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + }, + "post": { + "description": "Add a privilege to the role.", + "operationId": "createAuthRolesv1RolePrivilege", + "parameters": [ + { + "in": "body", + "name": "v1RolePrivilege", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + } + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a privilege to the role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + } + }, + "/platform/1/auth/roles/{Role}/privileges/{v1RolesRolePrivilegeId}": { + "delete": { + "description": "Remove a privilege from a role.", + "operationId": "deleteAuthv1RolesRolePrivilege", + "parameters": [ + { + "description": "Remove a privilege from a role.", + "in": "path", + "name": "v1RolesRolePrivilegeId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/roles/{v1AuthRoleId}": { + "delete": { + "description": "Delete the role.", + "operationId": "deleteAuthv1AuthRole", + "parameters": [ + { + "description": "Delete the role.", + "in": "path", + "name": "v1AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the role information.", + "operationId": "getAuthv1AuthRole", + "parameters": [ + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Retrieve the role information.", + "in": "path", + "name": "v1AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the role information.", + "schema": { + "$ref": "#/definitions/v1AuthRolesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the role.", + "operationId": "updateAuthv1AuthRole", + "parameters": [ + { + "in": "body", + "name": "v1AuthRole", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthRoleExtendedExtended" + } + }, + { + "description": "Modify the role.", + "in": "path", + "name": "v1AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/settings/global": { + "get": { + "description": "Retrieve the global settings.", + "operationId": "getAuthv1SettingsGlobal", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Zone which contains any per-zone settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the global settings.", + "schema": { + "$ref": "#/definitions/v1SettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the global settings.", + "operationId": "updateAuthv1SettingsGlobal", + "parameters": [ + { + "description": "Zone which contains any per-zone settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1SettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsGlobalGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/settings/krb5/defaults": { + "get": { + "description": "Retrieve the krb5 settings.", + "operationId": "getAuthv1SettingsKrb5Defaults", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the krb5 settings.", + "schema": { + "$ref": "#/definitions/v1SettingsKrb5Defaults" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the krb5 settings.", + "operationId": "updateAuthv1SettingsKrb5Defaults", + "parameters": [ + { + "in": "body", + "name": "v1SettingsKrb5Defaults", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsKrb5DefaultsKrb5Settings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/settings/krb5/domains": { + "get": { + "description": "Retrieve the krb5 settings for domains.", + "operationId": "listAuthv1SettingsKrb5Domains", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the krb5 settings for domains.", + "schema": { + "$ref": "#/definitions/v1SettingsKrb5Domains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new krb5 domain.", + "operationId": "createAuthv1SettingsKrb5Domain", + "parameters": [ + { + "in": "body", + "name": "v1SettingsKrb5Domain", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsKrb5Domain" + } + } + ], + "responses": { + "200": { + "description": "Create a new krb5 domain.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/settings/krb5/domains/{v1SettingsKrb5DomainId}": { + "delete": { + "description": "Remove a krb5 domain.", + "operationId": "deleteAuthv1SettingsKrb5Domain", + "parameters": [ + { + "description": "Remove a krb5 domain.", + "in": "path", + "name": "v1SettingsKrb5DomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "View the krb5 domain settings.", + "operationId": "getAuthv1SettingsKrb5Domain", + "parameters": [ + { + "description": "View the krb5 domain settings.", + "in": "path", + "name": "v1SettingsKrb5DomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View the krb5 domain settings.", + "schema": { + "$ref": "#/definitions/v1SettingsKrb5Domains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the krb5 domain settings.", + "operationId": "updateAuthv1SettingsKrb5Domain", + "parameters": [ + { + "in": "body", + "name": "v1SettingsKrb5Domain", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsKrb5DomainExtended" + } + }, + { + "description": "Modify the krb5 domain settings.", + "in": "path", + "name": "v1SettingsKrb5DomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/settings/krb5/realms": { + "get": { + "description": "Retrieve the krb5 settings for realms.", + "operationId": "listAuthv1SettingsKrb5Realms", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the krb5 settings for realms.", + "schema": { + "$ref": "#/definitions/v1SettingsKrb5Realms" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new krb5 realm.", + "operationId": "createAuthv1SettingsKrb5Realm", + "parameters": [ + { + "in": "body", + "name": "v1SettingsKrb5Realm", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsKrb5Realm" + } + } + ], + "responses": { + "200": { + "description": "Create a new krb5 realm.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/settings/krb5/realms/{v1SettingsKrb5RealmId}": { + "delete": { + "description": "Remove a realm.", + "operationId": "deleteAuthv1SettingsKrb5Realm", + "parameters": [ + { + "description": "Remove a realm.", + "in": "path", + "name": "v1SettingsKrb5RealmId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the krb5 settings for realms.", + "operationId": "getAuthv1SettingsKrb5Realm", + "parameters": [ + { + "description": "Retrieve the krb5 settings for realms.", + "in": "path", + "name": "v1SettingsKrb5RealmId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the krb5 settings for realms.", + "schema": { + "$ref": "#/definitions/v1SettingsKrb5Realms" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the krb5 realm settings.", + "operationId": "updateAuthv1SettingsKrb5Realm", + "parameters": [ + { + "in": "body", + "name": "v1SettingsKrb5Realm", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsKrb5RealmExtended" + } + }, + { + "description": "Modify the krb5 realm settings.", + "in": "path", + "name": "v1SettingsKrb5RealmId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/settings/mapping": { + "get": { + "description": "Retrieve the mapping settings.", + "operationId": "getAuthv1SettingsMapping", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Access zone which contains mapping settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the mapping settings.", + "schema": { + "$ref": "#/definitions/v1SettingsMapping" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the mapping settings.", + "operationId": "updateAuthv1SettingsMapping", + "parameters": [ + { + "description": "Access zone which contains mapping settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1SettingsMapping", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsMappingMappingSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/shells": { + "get": { + "description": "List all shells.", + "operationId": "getAuthv1AuthShells", + "parameters": [], + "responses": { + "200": { + "description": "List all shells.", + "schema": { + "$ref": "#/definitions/v1AuthShells" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/users": { + "delete": { + "description": "Flush the users cache.", + "operationId": "deleteAuthv1AuthUsers", + "parameters": [ + { + "description": "If true, only flush cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "List all users.", + "operationId": "listAuthv1AuthUsers", + "parameters": [ + { + "description": "Filter users by domain.", + "in": "query", + "name": "domain", + "type": "string" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, only return cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Filter users by name prefix.", + "in": "query", + "name": "filter", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Enumerate all users that a group is a member of.", + "in": "query", + "name": "query_member_of", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List all users.", + "schema": { + "$ref": "#/definitions/v1AuthUsers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new user.", + "operationId": "createAuthv1AuthUser", + "parameters": [ + { + "description": "Skip validation checks when creating user.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Optional provider type.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v1AuthUser", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthUser" + } + } + ], + "responses": { + "200": { + "description": "Create a new user.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/users/{v1AuthUserId}": { + "delete": { + "description": "Delete the user.", + "operationId": "deleteAuthv1AuthUser", + "parameters": [ + { + "description": "If true, flush the user from the cache.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Delete the user.", + "in": "path", + "name": "v1AuthUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the user information.", + "operationId": "getAuthv1AuthUser", + "parameters": [ + { + "description": "If true, only return cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Enumerate all users that a group is a member of.", + "in": "query", + "name": "query_member_of", + "type": "boolean" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Retrieve the user information.", + "in": "path", + "name": "v1AuthUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the user information.", + "schema": { + "$ref": "#/definitions/v1AuthUsersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the user.", + "operationId": "updateAuthv1AuthUser", + "parameters": [ + { + "description": "Changes to the user ID can result in loss of access to the file system. To mitigate this risk of lost access, the force option is required for user ID changes.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Optional provider type.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v1AuthUser", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthUserExtended" + } + }, + { + "description": "Modify the user.", + "in": "path", + "name": "v1AuthUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/wellknowns": { + "get": { + "description": "List all wellknown personas.", + "operationId": "getAuthv1AuthWellknowns", + "parameters": [], + "responses": { + "200": { + "description": "List all wellknown personas.", + "schema": { + "$ref": "#/definitions/v1AuthWellknowns" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/auth/wellknowns/{v1AuthWellknownId}": { + "get": { + "description": "Retrieve the wellknown persona.", + "operationId": "getAuthv1AuthWellknown", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the wellknown persona.", + "in": "path", + "name": "v1AuthWellknownId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the wellknown persona.", + "schema": { + "$ref": "#/definitions/v1AuthWellknowns" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/1/cluster/config": { + "get": { + "description": "Retrieve the cluster information.", + "operationId": "getClusterv1ClusterConfig", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the cluster information.", + "schema": { + "$ref": "#/definitions/v1ClusterConfig" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/1/cluster/email": { + "get": { + "description": "Get the cluster email notification settings.", + "operationId": "getClusterv1ClusterEmail", + "parameters": [], + "responses": { + "200": { + "description": "Get the cluster email notification settings.", + "schema": { + "$ref": "#/definitions/v1ClusterEmail" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify the cluster email notification settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateClusterv1ClusterEmail", + "parameters": [ + { + "in": "body", + "name": "v1ClusterEmail", + "required": true, + "schema": { + "$ref": "#/definitions/v1ClusterEmailExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/1/cluster/external-ips": { + "get": { + "description": "Retrieve the cluster IP addresses.", + "operationId": "getClusterv1ClusterExternalIps", + "parameters": [], + "responses": { + "200": { + "description": "The list of the cluster's external IP addresses.", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/1/cluster/identity": { + "get": { + "description": "Retrieve the login information.", + "operationId": "getClusterv1ClusterIdentity", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the login information.", + "schema": { + "$ref": "#/definitions/v1ClusterIdentity" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/1/cluster/owner": { + "get": { + "description": "Get the cluster contact info settings", + "operationId": "getClusterv1ClusterOwner", + "parameters": [], + "responses": { + "200": { + "description": "Get the cluster contact info settings", + "schema": { + "$ref": "#/definitions/v1ClusterOwner" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify the cluster contact info settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateClusterv1ClusterOwner", + "parameters": [ + { + "in": "body", + "name": "v1ClusterOwner", + "required": true, + "schema": { + "$ref": "#/definitions/v1ClusterOwner" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/1/cluster/statfs": { + "get": { + "description": "Retrieve the filesystem statistics.", + "operationId": "getClusterv1ClusterStatfs", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the filesystem statistics.", + "schema": { + "$ref": "#/definitions/v1ClusterStatfs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/1/cluster/time": { + "get": { + "description": "Retrieve the current cluster time.", + "operationId": "getClusterv1ClusterTime", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the current cluster time.", + "schema": { + "$ref": "#/definitions/v1ClusterTime" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/1/debug/stats": { + "delete": { + "description": "Clear per-resource statistics counters.", + "operationId": "deleteDebugv1DebugStats", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Debug" + ] + }, + "get": { + "description": "List cumulative call statistics for each resource.", + "operationId": "getDebugv1DebugStats", + "parameters": [], + "responses": { + "200": { + "description": "List cumulative call statistics for each resource.", + "schema": { + "$ref": "#/definitions/v1DebugStats" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Debug" + ] + } + }, + "/platform/1/dedupe/dedupe-summary": { + "get": { + "description": "Return summary information about dedupe.", + "operationId": "getDedupev1DedupeDedupeSummary", + "parameters": [], + "responses": { + "200": { + "description": "Return summary information about dedupe.", + "schema": { + "$ref": "#/definitions/v1DedupeDedupeSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Dedupe" + ] + } + }, + "/platform/1/dedupe/reports": { + "get": { + "description": "List dedupe reports.", + "operationId": "getDedupev1DedupeReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "enum": [ + "id", + "start_time", + "end_time" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Restrict the query to reports at or after the given time, in seconds since the Epoch.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Restrict the query to reports at or before the given time, in seconds since the Epoch.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Restrict the query to the given job ID.", + "in": "query", + "name": "job_id", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Restrict the query to the given job type.", + "enum": [ + "Dedupe", + "DedupeAssessment" + ], + "in": "query", + "name": "job_type", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List dedupe reports.", + "schema": { + "$ref": "#/definitions/v1DedupeReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Dedupe" + ] + } + }, + "/platform/1/dedupe/reports/{v1DedupeReportId}": { + "get": { + "description": "Retrieve a report for a single dedupe job.", + "operationId": "getDedupev1DedupeReport", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve a report for a single dedupe job.", + "in": "path", + "name": "v1DedupeReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a report for a single dedupe job.", + "schema": { + "$ref": "#/definitions/v1DedupeReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Dedupe" + ] + } + }, + "/platform/1/dedupe/settings": { + "get": { + "description": "Retrieve the dedupe settings.", + "operationId": "getDedupev1DedupeSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the dedupe settings.", + "schema": { + "$ref": "#/definitions/v1DedupeSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Dedupe" + ] + }, + "put": { + "description": "Modify the dedupe settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateDedupev1DedupeSettings", + "parameters": [ + { + "in": "body", + "name": "v1DedupeSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v1DedupeSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Dedupe" + ] + } + }, + "/platform/1/filepool/default-policy": { + "get": { + "description": "List default file pool policy.", + "operationId": "getFilepoolv1FilepoolDefaultPolicy", + "parameters": [], + "responses": { + "200": { + "description": "List default file pool policy.", + "schema": { + "$ref": "#/definitions/v1FilepoolDefaultPolicy" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "put": { + "description": "Set default file pool policy.", + "operationId": "updateFilepoolv1FilepoolDefaultPolicy", + "parameters": [ + { + "in": "body", + "name": "v1FilepoolDefaultPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/1/filepool/policies": { + "get": { + "description": "List all policies.", + "operationId": "listFilepoolv1FilepoolPolicies", + "parameters": [], + "responses": { + "200": { + "description": "List all policies.", + "schema": { + "$ref": "#/definitions/v1FilepoolPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "post": { + "description": "Create a new policy.", + "operationId": "createFilepoolv1FilepoolPolicy", + "parameters": [ + { + "in": "body", + "name": "v1FilepoolPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1FilepoolPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a new policy.", + "schema": { + "$ref": "#/definitions/Createv1FilepoolPolicyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/1/filepool/policies/{v1FilepoolPolicyId}": { + "delete": { + "description": "Delete file pool policy.", + "operationId": "deleteFilepoolv1FilepoolPolicy", + "parameters": [ + { + "description": "Delete file pool policy.", + "in": "path", + "name": "v1FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "get": { + "description": "Retrieve file pool policy information.", + "operationId": "getFilepoolv1FilepoolPolicy", + "parameters": [ + { + "description": "Retrieve file pool policy information.", + "in": "path", + "name": "v1FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve file pool policy information.", + "schema": { + "$ref": "#/definitions/v1FilepoolPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "put": { + "description": "Modify file pool policy. All input fields are optional, but one or more must be supplied.", + "operationId": "updateFilepoolv1FilepoolPolicy", + "parameters": [ + { + "in": "body", + "name": "v1FilepoolPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1FilepoolPolicyExtendedExtended" + } + }, + { + "description": "Modify file pool policy. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/1/filepool/templates": { + "get": { + "description": "List all templates.", + "operationId": "getFilepoolv1FilepoolTemplates", + "parameters": [], + "responses": { + "200": { + "description": "List all templates.", + "schema": { + "$ref": "#/definitions/v1FilepoolTemplates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/1/filepool/templates/{v1FilepoolTemplateId}": { + "get": { + "description": "List all templates.", + "operationId": "getFilepoolv1FilepoolTemplate", + "parameters": [ + { + "description": "List all templates.", + "in": "path", + "name": "v1FilepoolTemplateId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all templates.", + "schema": { + "$ref": "#/definitions/v1FilepoolTemplatesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/1/filesystem/settings/access-time": { + "get": { + "description": "Retrieve settings for access time.", + "operationId": "getFilesystemv1SettingsAccessTime", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve settings for access time.", + "schema": { + "$ref": "#/definitions/v1SettingsAccessTime" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + }, + "put": { + "description": "Set settings for access time.", + "operationId": "updateFilesystemv1SettingsAccessTime", + "parameters": [ + { + "in": "body", + "name": "v1SettingsAccessTime", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsAccessTimeExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + } + }, + "/platform/1/filesystem/settings/character-encodings": { + "get": { + "description": "Retrieve current cluster character encoding settings.", + "operationId": "getFilesystemv1SettingsCharacterEncodings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve current cluster character encoding settings.", + "schema": { + "$ref": "#/definitions/v1SettingsCharacterEncodings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + }, + "put": { + "description": "Set current character encoding.", + "operationId": "updateFilesystemv1SettingsCharacterEncodings", + "parameters": [ + { + "in": "body", + "name": "v1SettingsCharacterEncodings", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsCharacterEncodingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + } + }, + "/platform/1/fsa/results": { + "get": { + "description": "List all results.", + "operationId": "getFsav1FsaResults", + "parameters": [], + "responses": { + "200": { + "description": "List all results.", + "schema": { + "$ref": "#/definitions/v1FsaResults" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/1/fsa/results/{v1FsaResultId}": { + "delete": { + "description": "Delete the result set.", + "operationId": "deleteFsav1FsaResult", + "parameters": [ + { + "description": "Delete the result set.", + "in": "path", + "name": "v1FsaResultId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + }, + "get": { + "description": "Retrieve result set information.", + "operationId": "getFsav1FsaResult", + "parameters": [ + { + "description": "Retrieve result set information.", + "in": "path", + "name": "v1FsaResultId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve result set information.", + "schema": { + "$ref": "#/definitions/v1FsaResultsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + }, + "put": { + "description": "Modify result set. Only the pinned property can be changed at this time.", + "operationId": "updateFsav1FsaResult", + "parameters": [ + { + "in": "body", + "name": "v1FsaResult", + "required": true, + "schema": { + "$ref": "#/definitions/v1FsaResultExtended" + } + }, + { + "description": "Modify result set. Only the pinned property can be changed at this time.", + "in": "path", + "name": "v1FsaResultId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/1/fsa/settings": { + "delete": { + "description": "Revert all settings to their defaults.", + "operationId": "deleteFsav1FsaSettings", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + }, + "get": { + "description": "List all settings.", + "operationId": "getFsav1FsaSettings", + "parameters": [ + { + "description": "If specified as effective or not specified, all fields are returned. If specified as user, only fields with non-default values are shown. If specified as default, the original values are returned.", + "enum": [ + "effective", + "user", + "default" + ], + "in": "query", + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v1FsaSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateFsav1FsaSettings", + "parameters": [ + { + "in": "body", + "name": "v1FsaSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v1FsaSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/1/job/events": { + "get": { + "description": "List job events.", + "operationId": "getJobv1JobEvents", + "parameters": [ + { + "description": "Restrict the query to events at or after the given time, in seconds since the Epoch.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Restrict the query to events before the given time, in seconds since the Epoch.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Restrict the query to the given job ID.", + "in": "query", + "name": "job_id", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Restrict the query to the given job type.", + "in": "query", + "name": "job_type", + "type": "string" + }, + { + "description": "Restrict the query to events containing the given state.", + "in": "query", + "items": { + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority", + "cancelled_user", + "cancelled_system", + "failed", + "succeeded", + "unknown" + ], + "type": "string" + }, + "name": "state", + "type": "array" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List job events.", + "schema": { + "$ref": "#/definitions/v1JobEvents" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/job-summary": { + "get": { + "description": "View job engine status.", + "operationId": "getJobv1JobJobSummary", + "parameters": [], + "responses": { + "200": { + "description": "View job engine status.", + "schema": { + "$ref": "#/definitions/v1JobJobSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/jobs": { + "get": { + "description": "List running and paused jobs.", + "operationId": "listJobv1JobJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, other arguments are ignored, and the query will return all results, unsorted, as quickly as possible.", + "in": "query", + "name": "batch", + "type": "boolean" + }, + { + "description": "Limit the results to jobs in the specified state.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List running and paused jobs.", + "schema": { + "$ref": "#/definitions/v1JobJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "post": { + "description": "Queue a new instance of a job type.", + "operationId": "createJobv1JobJob", + "parameters": [ + { + "in": "body", + "name": "v1JobJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1JobJob" + } + } + ], + "responses": { + "200": { + "description": "Queue a new instance of a job type.", + "schema": { + "$ref": "#/definitions/Createv1JobJobResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/jobs/{v1JobJobId}": { + "get": { + "description": "View a single job instance.", + "operationId": "getJobv1JobJob", + "parameters": [ + { + "description": "View a single job instance.", + "in": "path", + "name": "v1JobJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single job instance.", + "schema": { + "$ref": "#/definitions/v1JobJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "put": { + "description": "Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.", + "operationId": "updateJobv1JobJob", + "parameters": [ + { + "in": "body", + "name": "v1JobJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1JobJobExtendedExtended" + } + }, + { + "description": "Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1JobJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/policies": { + "get": { + "description": "List job impact policies.", + "operationId": "listJobv1JobPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List job impact policies.", + "schema": { + "$ref": "#/definitions/v1JobPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "post": { + "description": "Create a new job impact policy.", + "operationId": "createJobv1JobPolicy", + "parameters": [ + { + "in": "body", + "name": "v1JobPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1JobPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a new job impact policy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/policies/{v1JobPolicyId}": { + "delete": { + "description": "Delete a job impact policy. System policies may not be deleted.", + "operationId": "deleteJobv1JobPolicy", + "parameters": [ + { + "description": "Delete a job impact policy. System policies may not be deleted.", + "in": "path", + "name": "v1JobPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "get": { + "description": "View a single job impact policy.", + "operationId": "getJobv1JobPolicy", + "parameters": [ + { + "description": "View a single job impact policy.", + "in": "path", + "name": "v1JobPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single job impact policy.", + "schema": { + "$ref": "#/definitions/v1JobPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "put": { + "description": "Modify a job impact policy.", + "operationId": "updateJobv1JobPolicy", + "parameters": [ + { + "in": "body", + "name": "v1JobPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1JobPolicyExtendedExtended" + } + }, + { + "description": "Modify a job impact policy.", + "in": "path", + "name": "v1JobPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/reports": { + "get": { + "description": "List job reports.", + "operationId": "getJobv1JobReports", + "parameters": [ + { + "description": "Restrict the query to reports at or after the given time, in seconds since the Epoch.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Restrict the query to reports before the given time, in seconds since the Epoch.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Restrict the query to the given job ID.", + "in": "query", + "maximum": 2147483646, + "name": "job_id", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Restrict the query to the given job type.", + "in": "query", + "name": "job_type", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List job reports.", + "schema": { + "$ref": "#/definitions/v1JobReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/statistics": { + "get": { + "description": "View job engine statistics.", + "operationId": "getJobv1JobStatistics", + "parameters": [ + { + "description": "Restrict the query to the given node.", + "in": "query", + "name": "devid", + "type": "integer" + }, + { + "description": "Restrict the query to the given job ID.", + "in": "query", + "name": "job_id", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "View job engine statistics.", + "schema": { + "$ref": "#/definitions/v1JobStatistics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/types": { + "get": { + "description": "List job types.", + "operationId": "getJobv1JobTypes", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Whether to show all job types, including hidden ones. Defaults to false.", + "in": "query", + "name": "show_all", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List job types.", + "schema": { + "$ref": "#/definitions/v1JobTypes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/job/types/{v1JobTypeId}": { + "get": { + "description": "Retrieve job type information.", + "operationId": "getJobv1JobType", + "parameters": [ + { + "description": "Retrieve job type information.", + "in": "path", + "name": "v1JobTypeId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve job type information.", + "schema": { + "$ref": "#/definitions/v1JobTypesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "put": { + "description": "Modify the job type. All input fields are optional, but one or more must be supplied.", + "operationId": "updateJobv1JobType", + "parameters": [ + { + "in": "body", + "name": "v1JobType", + "required": true, + "schema": { + "$ref": "#/definitions/v1JobTypeExtended" + } + }, + { + "description": "Modify the job type. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1JobTypeId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/1/license/licenses": { + "get": { + "description": "Retrieve license information for all licensable products.", + "operationId": "listLicensev1LicenseLicenses", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve license information for all licensable products.", + "schema": { + "$ref": "#/definitions/v1LicenseLicenses" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + }, + "post": { + "description": "Install a new license key.", + "operationId": "createLicensev1LicenseLicense", + "parameters": [ + { + "in": "body", + "name": "v1LicenseLicense", + "required": true, + "schema": { + "$ref": "#/definitions/v1LicenseLicense" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + } + }, + "/platform/1/license/licenses/{v1LicenseLicenseId}": { + "get": { + "description": "Retrieve license information for the feature.", + "operationId": "getLicensev1LicenseLicense", + "parameters": [ + { + "description": "Retrieve license information for the feature.", + "in": "path", + "name": "v1LicenseLicenseId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve license information for the feature.", + "schema": { + "$ref": "#/definitions/v1LicenseLicenses" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + } + }, + "/platform/1/protocols/hdfs/proxyusers": { + "get": { + "description": "List all proxyusers.", + "operationId": "listProtocolsv1HdfsProxyusers", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Access zone which contains HDFS proxyusers.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all proxyusers.", + "schema": { + "$ref": "#/definitions/v1HdfsProxyusers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new HDFS proxyuser.", + "operationId": "createProtocolsv1HdfsProxyuser", + "parameters": [ + { + "description": "Access zone which contains HDFS proxyuser.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1HdfsProxyuser", + "required": true, + "schema": { + "$ref": "#/definitions/v1HdfsProxyuser" + } + } + ], + "responses": { + "200": { + "description": "Create a new HDFS proxyuser.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/hdfs/proxyusers/{Name}/members": { + "get": { + "description": "List all the members of the HDFS proxyuser.", + "operationId": "listProtocolsHdfsv1ProxyusersNameMembers", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "path", + "name": "Name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the members of the HDFS proxyuser.", + "schema": { + "$ref": "#/definitions/v1RoleMembers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ProtocolsHdfs" + ] + }, + "post": { + "description": "Add a member to the HDFS proxyuser.", + "operationId": "createProtocolsHdfsv1ProxyusersNameMember", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1ProxyusersNameMember", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + { + "in": "path", + "name": "Name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a member to the HDFS proxyuser.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ProtocolsHdfs" + ] + } + }, + "/platform/1/protocols/hdfs/proxyusers/{Name}/members/{v1HdfsProxyusersNameMemberId}": { + "delete": { + "description": "Remove a member from the HDFS proxyuser.", + "operationId": "deleteProtocolsv1HdfsProxyusersNameMember", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Remove a member from the HDFS proxyuser.", + "in": "path", + "name": "v1HdfsProxyusersNameMemberId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Name", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Create a new HDFS proxyuser.", + "operationId": "updateProtocolsv1HdfsProxyusersNameMember", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1HdfsProxyusersNameMember", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "description": "Create a new HDFS proxyuser.", + "in": "path", + "name": "v1HdfsProxyusersNameMemberId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Name", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/hdfs/proxyusers/{v1HdfsProxyuserId}": { + "delete": { + "description": "Delete an HDFS proxyuser.", + "operationId": "deleteProtocolsv1HdfsProxyuser", + "parameters": [ + { + "description": "Access zone which contains HDFS proxyuser.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete an HDFS proxyuser.", + "in": "path", + "name": "v1HdfsProxyuserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "View the proxyuser.", + "operationId": "getProtocolsv1HdfsProxyuser", + "parameters": [ + { + "description": "Access zone which contains HDFS proxyuser.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "View the proxyuser.", + "in": "path", + "name": "v1HdfsProxyuserId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View the proxyuser.", + "schema": { + "$ref": "#/definitions/v1HdfsProxyusersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify an HDFS proxyuser.", + "operationId": "updateProtocolsv1HdfsProxyuser", + "parameters": [ + { + "description": "Access zone which contains HDFS proxyuser.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1HdfsProxyuser", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "description": "Modify an HDFS proxyuser.", + "in": "path", + "name": "v1HdfsProxyuserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/hdfs/racks": { + "get": { + "description": "List all racks.", + "operationId": "listProtocolsv1HdfsRacks", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Access zone which contains HDFS racks.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all racks.", + "schema": { + "$ref": "#/definitions/v1HdfsRacks" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new HDFS rack.", + "operationId": "createProtocolsv1HdfsRack", + "parameters": [ + { + "description": "Access zone which contains HDFS rack.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1HdfsRack", + "required": true, + "schema": { + "$ref": "#/definitions/v1HdfsRack" + } + } + ], + "responses": { + "200": { + "description": "Create a new HDFS rack.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/hdfs/racks/{v1HdfsRackId}": { + "delete": { + "description": "Delete the HDFS rack.", + "operationId": "deleteProtocolsv1HdfsRack", + "parameters": [ + { + "description": "Access zone which contains HDFS rack.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the HDFS rack.", + "in": "path", + "name": "v1HdfsRackId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve the HDFS rack.", + "operationId": "getProtocolsv1HdfsRack", + "parameters": [ + { + "description": "Access zone which contains HDFS rack.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve the HDFS rack.", + "in": "path", + "name": "v1HdfsRackId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the HDFS rack.", + "schema": { + "$ref": "#/definitions/v1HdfsRacksExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the HDFS rack", + "operationId": "updateProtocolsv1HdfsRack", + "parameters": [ + { + "description": "Access zone which contains HDFS rack.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1HdfsRack", + "required": true, + "schema": { + "$ref": "#/definitions/v1HdfsRackExtendedExtended" + } + }, + { + "description": "Modify the HDFS rack", + "in": "path", + "name": "v1HdfsRackId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/check": { + "get": { + "description": "Retrieve NFS export validation information.", + "operationId": "getProtocolsv1NfsCheck", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve NFS export validation information.", + "schema": { + "$ref": "#/definitions/v1NfsCheckExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/exports": { + "get": { + "description": "List all NFS exports.", + "operationId": "listProtocolsv1NfsExports", + "parameters": [ + { + "description": "The field that will be used for sorting. Default is id.", + "enum": [ + "id", + "paths", + "description" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "If specified as effective or not specified, all export fields are shown. If specified as user, only fields with non-default values are shown.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Check for conflicts when listing exports.", + "in": "query", + "name": "check", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NFS exports.", + "schema": { + "$ref": "#/definitions/v1NfsExports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new NFS export.", + "operationId": "createProtocolsv1NfsExport", + "parameters": [ + { + "description": "If true, the export will be created even if it conflicts with another export.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v1NfsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v1NfsExport" + } + } + ], + "responses": { + "200": { + "description": "Create a new NFS export.", + "schema": { + "$ref": "#/definitions/Createv3EventEventResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/exports-summary": { + "get": { + "description": "Retrieve NFS export summary information.", + "operationId": "getProtocolsv1NfsExportsSummary", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve NFS export summary information.", + "schema": { + "$ref": "#/definitions/v1NfsExportsSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/exports/{v1NfsExportId}": { + "delete": { + "description": "Delete the export.", + "operationId": "deleteProtocolsv1NfsExport", + "parameters": [ + { + "description": "Delete the export.", + "in": "path", + "name": "v1NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve export information.", + "operationId": "getProtocolsv1NfsExport", + "parameters": [ + { + "description": "If specified as effective or not specified, all export fields are shown. If specified as user, only fields with non-default values are shown.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve export information.", + "in": "path", + "name": "v1NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve export information.", + "schema": { + "$ref": "#/definitions/v1NfsExportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the export. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv1NfsExport", + "parameters": [ + { + "description": "If true, the export will be updated even if that change conflicts with another export.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v1NfsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v1NfsExportExtendedExtended" + } + }, + { + "description": "Modify the export. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/nlm/locks": { + "get": { + "description": "List all NLM locks.", + "operationId": "getProtocolsv1NfsNlmLocks", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return locks created after the specified unix epoch time.", + "in": "query", + "name": "created", + "type": "string" + }, + { + "description": "Filter locks by the specified LIN in /ifs that is locked.", + "in": "query", + "name": "lin", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter locks by the specified client host name and IP address.", + "in": "query", + "name": "client", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter locks by the specified client ID.", + "in": "query", + "name": "client_id", + "type": "string" + }, + { + "description": "Filter locks by the specified path under /ifs.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NLM locks.", + "schema": { + "$ref": "#/definitions/v1NfsNlmLocks" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/nlm/sessions": { + "get": { + "description": "List all NLM sessions.", + "operationId": "getProtocolsv1NfsNlmSessions", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NLM sessions.", + "schema": { + "$ref": "#/definitions/v1NfsNlmSessions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/nlm/sessions/{v1NfsNlmSessionId}": { + "delete": { + "description": "Delete an NLM session.", + "operationId": "deleteProtocolsv1NfsNlmSession", + "parameters": [ + { + "description": "Delete an NLM session.", + "in": "path", + "name": "v1NfsNlmSessionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/nlm/waiters": { + "get": { + "description": "List all NLM lock waiters.", + "operationId": "getProtocolsv1NfsNlmWaiters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NLM lock waiters.", + "schema": { + "$ref": "#/definitions/v1NfsNlmWaiters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/reload": { + "post": { + "description": "Reload default NFS export configuration.", + "operationId": "createProtocolsv1NfsReloadItem", + "parameters": [ + { + "in": "body", + "name": "v1NfsReloadItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Reload default NFS export configuration.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/nfs/settings/export": { + "get": { + "description": "Retrieve export information.", + "operationId": "getProtocolsv1NfsSettingsExport", + "parameters": [ + { + "description": "If specified as effective or not specified, all fields are returned. If specified as user, only fields with non-default values are shown. If specified as default, the original values are returned.", + "enum": [ + "effective", + "user", + "default" + ], + "in": "query", + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve export information.", + "schema": { + "$ref": "#/definitions/v1NfsSettingsExport" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the default values for NFS exports. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv1NfsSettingsExport", + "parameters": [ + { + "in": "body", + "name": "v1NfsSettingsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v1NfsSettingsExportSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/openfiles": { + "get": { + "description": "List open files.", + "operationId": "getProtocolsv1SmbOpenfiles", + "parameters": [ + { + "description": "Order results by this field. Default is id.", + "enum": [ + "id", + "file", + "user", + "locks" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List open files.", + "schema": { + "$ref": "#/definitions/v1SmbOpenfiles" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/openfiles/{v1SmbOpenfileId}": { + "delete": { + "description": "Close the file in the SMB server.", + "operationId": "deleteProtocolsv1SmbOpenfile", + "parameters": [ + { + "description": "Close the file in the SMB server.", + "in": "path", + "name": "v1SmbOpenfileId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/sessions": { + "get": { + "description": "List open sessions.", + "operationId": "getProtocolsv1SmbSessions", + "parameters": [ + { + "description": "Order results by this field.", + "enum": [ + "computer", + "user", + "client_type", + "openfiles", + "active_time", + "idle_time", + "guest_login", + "encryption" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List open sessions.", + "schema": { + "$ref": "#/definitions/v1SmbSessions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/sessions/{Computer}/{v1SmbSessionsComputerUser}": { + "delete": { + "description": "Close the SMB session.", + "operationId": "deleteProtocolsv1SmbSessionsComputerUser", + "parameters": [ + { + "description": "Close the SMB session.", + "in": "path", + "name": "v1SmbSessionsComputerUser", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Computer", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/sessions/{v1SmbSessionId}": { + "delete": { + "description": "Close the SMB session.", + "operationId": "deleteProtocolsv1SmbSession", + "parameters": [ + { + "description": "Close the SMB session.", + "in": "path", + "name": "v1SmbSessionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/settings/global": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv1SmbSettingsGlobal", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v1SmbSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv1SmbSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v1SmbSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v1SmbSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/settings/share": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv1SmbSettingsShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Zone which contains these share settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v1SmbSettingsShare" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv1SmbSettingsShare", + "parameters": [ + { + "description": "Zone which contains these share settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1SmbSettingsShare", + "required": true, + "schema": { + "$ref": "#/definitions/v1SmbSettingsShareSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/shares": { + "delete": { + "description": "Delete multiple smb shares.", + "operationId": "deleteProtocolsv1SmbShares", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List all shares.", + "operationId": "listProtocolsv1SmbShares", + "parameters": [ + { + "description": "Order results by this field. Default is id.", + "enum": [ + "id", + "name", + "path", + "description" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 5000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all shares.", + "schema": { + "$ref": "#/definitions/v1SmbShares" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new share.", + "operationId": "createProtocolsv1SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v1SmbShare" + } + } + ], + "responses": { + "200": { + "description": "Create a new share.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/shares-summary": { + "get": { + "description": "Return summary information about shares.", + "operationId": "getProtocolsv1SmbSharesSummary", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Return summary information about shares.", + "schema": { + "$ref": "#/definitions/v1SmbSharesSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/protocols/smb/shares/{v1SmbShareId}": { + "delete": { + "description": "Delete the share.", + "operationId": "deleteProtocolsv1SmbShare", + "parameters": [ + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the share.", + "in": "path", + "name": "v1SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve share.", + "operationId": "getProtocolsv1SmbShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve share.", + "in": "path", + "name": "v1SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve share.", + "schema": { + "$ref": "#/definitions/v1SmbSharesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv1SmbShare", + "parameters": [ + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v1SmbShareExtendedExtended" + } + }, + { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/1/quota/license": { + "get": { + "description": "Retrieve license information.", + "operationId": "getQuotav1QuotaLicense", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve license information.", + "schema": { + "$ref": "#/definitions/v1LicenseLicenseExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/quotas": { + "delete": { + "description": "Delete all or matching quotas.", + "operationId": "deleteQuotav1QuotaQuotas", + "parameters": [ + { + "description": "Only delete quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only delete quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only delete user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Only delete quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only delete quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "operationId": "listQuotav1QuotaQuotas", + "parameters": [ + { + "description": "Only list quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only list quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If used with the path argument, match all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "If used with the path argument, match all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only list user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Set to true to only list quotas which have exceeded one or more of their thresholds.", + "in": "query", + "name": "exceeded", + "type": "boolean" + }, + { + "description": "Only list quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only list quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Use the named report as a source rather than the live quotas. See the /q/quota/reports resource for a list of valid reports.", + "in": "query", + "name": "report_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "schema": { + "$ref": "#/definitions/v1QuotaQuotas" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new quota.", + "operationId": "createQuotav1QuotaQuota", + "parameters": [ + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v1QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v1QuotaQuota" + } + } + ], + "responses": { + "200": { + "description": "Create a new quota.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/quotas-summary": { + "get": { + "description": "Return summary information about quotas.", + "operationId": "getQuotav1QuotaQuotasSummary", + "parameters": [], + "responses": { + "200": { + "description": "Return summary information about quotas.", + "schema": { + "$ref": "#/definitions/v1QuotaQuotasSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/quotas/{Qid}/notifications": { + "delete": { + "description": "Delete all quota specific rules. The quota will then use the global rules.", + "operationId": "deleteQuotaQuotasv1QuotaNotifications", + "parameters": [ + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + }, + "get": { + "description": "List all rules.", + "operationId": "listQuotaQuotasv1QuotaNotifications", + "parameters": [ + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all rules.", + "schema": { + "$ref": "#/definitions/v1QuotaNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + }, + "post": { + "description": "Create a new notification rule specific to this quota.", + "operationId": "createQuotaQuotasv1QuotaNotification", + "parameters": [ + { + "in": "body", + "name": "v1QuotaNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v1QuotaNotification" + } + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new notification rule specific to this quota.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + }, + "put": { + "description": "This method creates an empty set of rules so that the global rules are not used. The input must be an empty JSON object.", + "operationId": "updateQuotaQuotasv1QuotaNotifications", + "parameters": [ + { + "in": "body", + "name": "v1QuotaNotifications", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + } + }, + "/platform/1/quota/quotas/{Qid}/notifications/{v1QuotasQidNotificationId}": { + "delete": { + "description": "Delete the notification rule.", + "operationId": "deleteQuotav1QuotasQidNotification", + "parameters": [ + { + "description": "Delete the notification rule.", + "in": "path", + "name": "v1QuotasQidNotificationId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve notification rule information.", + "operationId": "getQuotav1QuotasQidNotification", + "parameters": [ + { + "description": "Retrieve notification rule information.", + "in": "path", + "name": "v1QuotasQidNotificationId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve notification rule information.", + "schema": { + "$ref": "#/definitions/v1QuotasQidNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav1QuotasQidNotification", + "parameters": [ + { + "in": "body", + "name": "v1QuotasQidNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v1QuotasQidNotification" + } + }, + { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1QuotasQidNotificationId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/quotas/{v1QuotaQuotaId}": { + "delete": { + "description": "Delete the quota.", + "operationId": "deleteQuotav1QuotaQuota", + "parameters": [ + { + "description": "Delete the quota.", + "in": "path", + "name": "v1QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve quota information.", + "operationId": "getQuotav1QuotaQuota", + "parameters": [ + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve quota information.", + "in": "path", + "name": "v1QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve quota information.", + "schema": { + "$ref": "#/definitions/v1QuotaQuotasExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav1QuotaQuota", + "parameters": [ + { + "in": "body", + "name": "v1QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v1QuotaQuotaExtendedExtended" + } + }, + { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/reports": { + "get": { + "description": "List all or matching reports.", + "operationId": "listQuotav1QuotaReports", + "parameters": [ + { + "description": "Order results by this field.", + "enum": [ + "time", + "generated", + "type" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Only list reports matching this source.", + "enum": [ + "manual", + "scheduled", + "all" + ], + "in": "query", + "name": "generated", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Only list reports matching this type.", + "enum": [ + "summary", + "detail", + "all" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching reports.", + "schema": { + "$ref": "#/definitions/v1QuotaReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new report. The type of this report is 'manual'; it is also sometimes called 'live' or 'ad-hoc'.", + "operationId": "createQuotav1QuotaReport", + "parameters": [ + { + "in": "body", + "name": "v1QuotaReport", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Create a new report. The type of this report is 'manual'; it is also sometimes called 'live' or 'ad-hoc'.", + "schema": { + "$ref": "#/definitions/Createv3EventEventResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/reports/{Rid}/about": { + "get": { + "description": "Retrieve report meta-data information.", + "operationId": "getQuotaReportsv1ReportAbout", + "parameters": [ + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve report meta-data information.", + "schema": { + "$ref": "#/definitions/v1QuotaReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaReports" + ] + } + }, + "/platform/1/quota/reports/{v1QuotaReportId}": { + "delete": { + "description": "Delete the report.", + "operationId": "deleteQuotav1QuotaReport", + "parameters": [ + { + "description": "Delete the report.", + "in": "path", + "name": "v1QuotaReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve report data (XML) or contents (meta-data).", + "operationId": "getQuotav1QuotaReport", + "parameters": [ + { + "description": "Display JSON meta-data contents instead of report data.", + "in": "query", + "name": "contents", + "type": "boolean" + }, + { + "description": "Retrieve report data (XML) or contents (meta-data).", + "in": "path", + "name": "v1QuotaReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve report data (XML) or contents (meta-data).", + "schema": { + "$ref": "#/definitions/v1QuotaReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/settings/mappings": { + "delete": { + "description": "Delete all rules.", + "operationId": "deleteQuotav1SettingsMappings", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all rules.", + "operationId": "listQuotav1SettingsMappings", + "parameters": [], + "responses": { + "200": { + "description": "List all rules.", + "schema": { + "$ref": "#/definitions/v1SettingsMappings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new rule. The new rule must not conflict with an existing rule (e.g. match both the type and domain fields).", + "operationId": "createQuotav1SettingsMapping", + "parameters": [ + { + "in": "body", + "name": "v1SettingsMapping", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsMappingCreateParams" + } + } + ], + "responses": { + "200": { + "description": "Create a new rule. The new rule must not conflict with an existing rule (e.g. match both the type and domain fields).", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/settings/mappings/{v1SettingsMappingId}": { + "delete": { + "description": "Delete the mapping.", + "operationId": "deleteQuotav1SettingsMapping", + "parameters": [ + { + "description": "Delete the mapping.", + "in": "path", + "name": "v1SettingsMappingId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve the mapping information.", + "operationId": "getQuotav1SettingsMapping", + "parameters": [ + { + "description": "Retrieve the mapping information.", + "in": "path", + "name": "v1SettingsMappingId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the mapping information.", + "schema": { + "$ref": "#/definitions/v1SettingsMappingsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify the mapping.", + "operationId": "updateQuotav1SettingsMapping", + "parameters": [ + { + "in": "body", + "name": "v1SettingsMapping", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsMappingExtendedExtended" + } + }, + { + "description": "Modify the mapping.", + "in": "path", + "name": "v1SettingsMappingId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/settings/notifications": { + "delete": { + "description": "Delete all rules.", + "operationId": "deleteQuotav1SettingsNotifications", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all rules.", + "operationId": "listQuotav1SettingsNotifications", + "parameters": [], + "responses": { + "200": { + "description": "List all rules.", + "schema": { + "$ref": "#/definitions/v1SettingsNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new global notification rule.", + "operationId": "createQuotav1SettingsNotification", + "parameters": [ + { + "in": "body", + "name": "v1SettingsNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v1QuotaNotification" + } + } + ], + "responses": { + "200": { + "description": "Create a new global notification rule.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/settings/notifications/{v1SettingsNotificationId}": { + "delete": { + "description": "Delete the notification rule.", + "operationId": "deleteQuotav1SettingsNotification", + "parameters": [ + { + "description": "Delete the notification rule.", + "in": "path", + "name": "v1SettingsNotificationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve notification rule information.", + "operationId": "getQuotav1SettingsNotification", + "parameters": [ + { + "description": "Retrieve notification rule information.", + "in": "path", + "name": "v1SettingsNotificationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve notification rule information.", + "schema": { + "$ref": "#/definitions/v1QuotasQidNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav1SettingsNotification", + "parameters": [ + { + "in": "body", + "name": "v1SettingsNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v1QuotasQidNotification" + } + }, + { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1SettingsNotificationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/quota/settings/reports": { + "get": { + "description": "List all settings.", + "operationId": "getQuotav1SettingsReports", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v1SettingsReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateQuotav1SettingsReports", + "parameters": [ + { + "in": "body", + "name": "v1SettingsReports", + "required": true, + "schema": { + "$ref": "#/definitions/v1SettingsReportsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/1/snapshot/aliases": { + "delete": { + "description": "Delete all or matching snapshot aliases.", + "operationId": "deleteSnapshotv1SnapshotAliases", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "List all or matching snapshot aliases.", + "operationId": "listSnapshotv1SnapshotAliases", + "parameters": [ + { + "description": "The field that will be used for sorting. Choices are id, name, snapshot, and created. Default is id.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching snapshot aliases.", + "schema": { + "$ref": "#/definitions/v1SnapshotAliases" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "post": { + "description": "Create a new snapshot alias.", + "operationId": "createSnapshotv1SnapshotAlias", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotAlias", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotAlias" + } + } + ], + "responses": { + "200": { + "description": "Create a new snapshot alias.", + "schema": { + "$ref": "#/definitions/Createv1SnapshotAliasResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/aliases/{v1SnapshotAliasId}": { + "delete": { + "description": "Delete the snapshot alias", + "operationId": "deleteSnapshotv1SnapshotAlias", + "parameters": [ + { + "description": "Delete the snapshot alias", + "in": "path", + "name": "v1SnapshotAliasId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "Retrieve snapshot alias information.", + "operationId": "getSnapshotv1SnapshotAlias", + "parameters": [ + { + "description": "Retrieve snapshot alias information.", + "in": "path", + "name": "v1SnapshotAliasId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve snapshot alias information.", + "schema": { + "$ref": "#/definitions/v1SnapshotAliasesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "put": { + "description": "Modify snapshot alias. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSnapshotv1SnapshotAlias", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotAlias", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotAliasExtendedExtended" + } + }, + { + "description": "Modify snapshot alias. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1SnapshotAliasId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/changelists": { + "get": { + "description": "List all changelists.", + "operationId": "getSnapshotv1SnapshotChangelists", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all changelists.", + "schema": { + "$ref": "#/definitions/v1SnapshotChangelists" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/changelists/{Changelist}/lins": { + "get": { + "description": "Get entries from a changelist.", + "operationId": "getSnapshotChangelistsv1ChangelistLins", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Changelist", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get entries from a changelist.", + "schema": { + "$ref": "#/definitions/v1ChangelistLins" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SnapshotChangelists" + ] + } + }, + "/platform/1/snapshot/changelists/{Changelist}/lins/{v1ChangelistsChangelistLinId}": { + "get": { + "description": "Get a single entry from the changelist.", + "operationId": "getSnapshotv1ChangelistsChangelistLin", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Get a single entry from the changelist.", + "in": "path", + "name": "v1ChangelistsChangelistLinId", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Changelist", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a single entry from the changelist.", + "schema": { + "$ref": "#/definitions/v1ChangelistLin" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/changelists/{v1SnapshotChangelistId}": { + "delete": { + "description": "Delete the specified changelist.", + "operationId": "deleteSnapshotv1SnapshotChangelist", + "parameters": [ + { + "description": "Delete the specified changelist.", + "in": "path", + "name": "v1SnapshotChangelistId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "Retrieve basic information on a changelist.", + "operationId": "getSnapshotv1SnapshotChangelist", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Retrieve basic information on a changelist.", + "in": "path", + "name": "v1SnapshotChangelistId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve basic information on a changelist.", + "schema": { + "$ref": "#/definitions/v1SnapshotChangelist" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/license": { + "get": { + "description": "Retrieve license information.", + "operationId": "getSnapshotv1SnapshotLicense", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve license information.", + "schema": { + "$ref": "#/definitions/v1LicenseLicenseExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/pending": { + "get": { + "description": "Return list of snapshots to be taken.", + "operationId": "getSnapshotv1SnapshotPending", + "parameters": [ + { + "description": "Return no more than this many result at once (see resume).", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Unix Epoch time to start generating matches. Default is now.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Limit output only to the named schedule.", + "in": "query", + "name": "schedule", + "type": "string" + }, + { + "description": "Unix Epoch time to end generating matches. Default is forever.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Return list of snapshots to be taken.", + "schema": { + "$ref": "#/definitions/v1SnapshotPending" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/repstates": { + "get": { + "description": "List all repstates.", + "operationId": "getSnapshotv1SnapshotRepstates", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all repstates.", + "schema": { + "$ref": "#/definitions/v1SnapshotRepstates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/repstates/{v1SnapshotRepstateId}": { + "delete": { + "description": "Delete the specified repstate.", + "operationId": "deleteSnapshotv1SnapshotRepstate", + "parameters": [ + { + "description": "Delete the specified repstate.", + "in": "path", + "name": "v1SnapshotRepstateId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "Retrieve basic information on a repstate.", + "operationId": "getSnapshotv1SnapshotRepstate", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Retrieve basic information on a repstate.", + "in": "path", + "name": "v1SnapshotRepstateId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve basic information on a repstate.", + "schema": { + "$ref": "#/definitions/v1SnapshotRepstate" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/schedules": { + "get": { + "description": "List all or matching schedules.", + "operationId": "listSnapshotv1SnapshotSchedules", + "parameters": [ + { + "description": "The field that will be used for sorting. Choices are id, name, path, pattern, schedule, duration, alias, next_run, and next_snapshot. Default is id.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching schedules.", + "schema": { + "$ref": "#/definitions/v1SnapshotSchedules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "post": { + "description": "Create a new schedule.", + "operationId": "createSnapshotv1SnapshotSchedule", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotSchedule", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotSchedule" + } + } + ], + "responses": { + "200": { + "description": "Create a new schedule.", + "schema": { + "$ref": "#/definitions/Createv1SnapshotScheduleResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/schedules/{v1SnapshotScheduleId}": { + "delete": { + "description": "Delete the schedule. This does not affect already created snapshots.", + "operationId": "deleteSnapshotv1SnapshotSchedule", + "parameters": [ + { + "description": "Delete the schedule. This does not affect already created snapshots.", + "in": "path", + "name": "v1SnapshotScheduleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "Retrieve the schedule.", + "operationId": "getSnapshotv1SnapshotSchedule", + "parameters": [ + { + "description": "Retrieve the schedule.", + "in": "path", + "name": "v1SnapshotScheduleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the schedule.", + "schema": { + "$ref": "#/definitions/v1SnapshotSchedulesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "put": { + "description": "Modify the schedule. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSnapshotv1SnapshotSchedule", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotSchedule", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotScheduleExtendedExtended" + } + }, + { + "description": "Modify the schedule. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1SnapshotScheduleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/settings": { + "get": { + "description": "List all settings", + "operationId": "getSnapshotv1SnapshotSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all settings", + "schema": { + "$ref": "#/definitions/v1SnapshotSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateSnapshotv1SnapshotSettings", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/snapshots": { + "delete": { + "description": "Delete all or matching snapshots.", + "operationId": "deleteSnapshotv1SnapshotSnapshots", + "parameters": [ + { + "description": "Only list snapshots matching this type.", + "enum": [ + "all", + "alias", + "real" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Only list snapshots created by this schedule.", + "in": "query", + "name": "schedule", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "List all or matching snapshots.", + "operationId": "listSnapshotv1SnapshotSnapshots", + "parameters": [ + { + "description": "The field that will be used for sorting. Choices are id, name, path, created, expires, size, has_locks, schedule, alias_target, alias_target_name, pct_filesystem, pct_reserve, and state. Default is id.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Only list snapshots created by this schedule.", + "in": "query", + "name": "schedule", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Only list snapshots matching this state.", + "enum": [ + "all", + "active", + "deleting" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Only list snapshots matching this type.", + "enum": [ + "all", + "alias", + "real" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching snapshots.", + "schema": { + "$ref": "#/definitions/v1SnapshotSnapshots" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "post": { + "description": "Create a new snapshot.", + "operationId": "createSnapshotv1SnapshotSnapshot", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotSnapshot", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotSnapshot" + } + } + ], + "responses": { + "200": { + "description": "Create a new snapshot.", + "schema": { + "$ref": "#/definitions/Createv1SnapshotSnapshotResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/snapshots-summary": { + "get": { + "description": "Return summary information about snapshots.", + "operationId": "getSnapshotv1SnapshotSnapshotsSummary", + "parameters": [], + "responses": { + "200": { + "description": "Return summary information about snapshots.", + "schema": { + "$ref": "#/definitions/v1SnapshotSnapshotsSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/snapshots/{Sid}/locks": { + "delete": { + "description": "Delete all locks. Will try to drain count of recursively held locks so that the snapshot can be deleted.", + "operationId": "deleteSnapshotSnapshotsv1SnapshotLocks", + "parameters": [ + { + "in": "path", + "name": "Sid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SnapshotSnapshots" + ] + }, + "get": { + "description": "List all locks.", + "operationId": "listSnapshotSnapshotsv1SnapshotLocks", + "parameters": [ + { + "description": "The field that will be used for sorting. Choices are id, expires, and comment. Default is id.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Sid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all locks.", + "schema": { + "$ref": "#/definitions/v1SnapshotLocks" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SnapshotSnapshots" + ] + }, + "post": { + "description": "Create a new lock on this snapshot.", + "operationId": "createSnapshotSnapshotsv1SnapshotLock", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotLock", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotLock" + } + }, + { + "in": "path", + "name": "Sid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new lock on this snapshot.", + "schema": { + "$ref": "#/definitions/Createv1SnapshotLockResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SnapshotSnapshots" + ] + } + }, + "/platform/1/snapshot/snapshots/{Sid}/locks/{v1SnapshotsSidLockId}": { + "delete": { + "description": "Delete the snapshot lock.", + "operationId": "deleteSnapshotv1SnapshotsSidLock", + "parameters": [ + { + "description": "Delete the snapshot lock.", + "in": "path", + "name": "v1SnapshotsSidLockId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Sid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "Retrieve lock information.", + "operationId": "getSnapshotv1SnapshotsSidLock", + "parameters": [ + { + "description": "Retrieve lock information.", + "in": "path", + "name": "v1SnapshotsSidLockId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Sid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve lock information.", + "schema": { + "$ref": "#/definitions/v1SnapshotsSidLocks" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "put": { + "description": "Modify lock. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSnapshotv1SnapshotsSidLock", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotsSidLock", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotsSidLock" + } + }, + { + "description": "Modify lock. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1SnapshotsSidLockId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Sid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/snapshot/snapshots/{v1SnapshotSnapshotId}": { + "delete": { + "description": "Delete the snapshot. Deleted snapshots will be placed into a deleting state until the system can reclaim the space used by the snapshot.", + "operationId": "deleteSnapshotv1SnapshotSnapshot", + "parameters": [ + { + "description": "Delete the snapshot. Deleted snapshots will be placed into a deleting state until the system can reclaim the space used by the snapshot.", + "in": "path", + "name": "v1SnapshotSnapshotId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "Retrieve snapshot information.", + "operationId": "getSnapshotv1SnapshotSnapshot", + "parameters": [ + { + "description": "Retrieve snapshot information.", + "in": "path", + "name": "v1SnapshotSnapshotId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve snapshot information.", + "schema": { + "$ref": "#/definitions/v1SnapshotSnapshotsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "put": { + "description": "Modify snapshot. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSnapshotv1SnapshotSnapshot", + "parameters": [ + { + "in": "body", + "name": "v1SnapshotSnapshot", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotSnapshotExtendedExtended" + } + }, + { + "description": "Modify snapshot. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1SnapshotSnapshotId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/1/statistics/current": { + "get": { + "description": "Retrieve stats.", + "operationId": "getStatisticsv1StatisticsCurrent", + "parameters": [ + { + "description": "Time in seconds to wait for results from remote nodes.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "Shows the logical node number or LNN in addition to the devid.", + "in": "query", + "name": "show_nodes", + "type": "boolean" + }, + { + "description": "Multiple key names. Can be a comma separated list, or can be used more than one time to make queries for multiple keys. May be used in conjunction with 'substr'. Also works with 'key' arguments.", + "in": "query", + "items": { + "type": "string" + }, + "name": "keys", + "type": "array" + }, + { + "description": "Node devid to query. Either an or \"all\". Can be used more than one time to query multiple nodes. \"all\" queries all up nodes. 0 means query the local node. For \"cluster\" scoped keys, in any devid including 0 can be used.", + "in": "query", + "items": { + "type": "string" + }, + "name": "devid", + "type": "array" + }, + { + "description": "Used in conjunction with the 'keys' argument, alters the behavior of keys. Makes the 'keys' arg perform a partial match. Defaults to false.", + "in": "query", + "name": "substr", + "type": "boolean" + }, + { + "description": "For internal use only, please do not use this.", + "in": "query", + "name": "stale", + "type": "boolean" + }, + { + "description": "The type ID is used by internal services. For internal use only, please do not use this.", + "in": "query", + "name": "type_info", + "type": "boolean" + }, + { + "description": "Causes the output to be in hex format. For internal use only, please do not use this.", + "in": "query", + "name": "raw", + "type": "boolean" + }, + { + "description": "One key name. Can be used more than one time to query multiple keys. Also works with 'keys' arguments.", + "in": "query", + "items": { + "type": "string" + }, + "name": "key", + "type": "array" + }, + { + "description": "If true, try to continue even if some stats are unavailable. In this case, errors will be present in the per-key returned data.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "Specify node(s) for which statistics should be reported. One or more comma separated specifying which node(s) to query, or \"all\". Specifying more than one node may have unspecified results for keys that begin with \"cluster\".", + "in": "query", + "items": { + "type": "string" + }, + "name": "nodes", + "type": "array" + }, + { + "description": "Shows the description for the specified key(s).", + "in": "query", + "name": "desc_info", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Retrieve stats.", + "schema": { + "$ref": "#/definitions/v1StatisticsCurrent" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/1/statistics/history": { + "get": { + "description": "Retrieve stats.", + "operationId": "getStatisticsv1StatisticsHistory", + "parameters": [ + { + "description": "Earliest time (Unix epoch seconds) of interest. Negative times are interpreted as relative (before) now.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Minimum sampling interval time in seconds. If native statistics are higher resolution, data will be down-sampled.", + "in": "query", + "name": "interval", + "type": "integer" + }, + { + "description": "Latest time (Unix epoch seconds) of interest. Negative times are interpreted as relative (before) now. If not supplied, use now as the end time.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Time in seconds to wait for results from remote nodes.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "Causes the output to be in hex format. For internal use only, please do not use this.", + "in": "query", + "name": "raw", + "type": "boolean" + }, + { + "description": "Multiple key names. Can be a comma separated list, or can be used more than one time to make queries for multiple keys. May be used in conjunction with 'substr'. Also works with 'key' arguments.", + "in": "query", + "items": { + "type": "string" + }, + "name": "keys", + "type": "array" + }, + { + "description": "Node devid to query. Either an or \"all\". Can be used more than one time to query multiple nodes. \"all\" queries all up nodes. 0 means query the local node. For \"cluster\" scoped keys, in any devid including 0 can be used.", + "in": "query", + "items": { + "type": "string" + }, + "name": "devid", + "type": "array" + }, + { + "description": "Used in conjunction with the 'keys' argument, alters the behavior of keys. Makes the 'keys' arg perform a partial match. Defaults to false.", + "in": "query", + "name": "substr", + "type": "boolean" + }, + { + "description": "For internal use only, please do not use this.", + "in": "query", + "name": "stale", + "type": "boolean" + }, + { + "description": "The type ID is used by internal services. For internal use only, please do not use this.", + "in": "query", + "name": "type_info", + "type": "boolean" + }, + { + "description": "Only use statistics sources that reside in memory (faster, but with less retention).", + "in": "query", + "name": "memory_only", + "type": "boolean" + }, + { + "description": "One key name. Can be used more than one time to query multiple keys. Also works with 'keys' arguments.", + "in": "query", + "items": { + "type": "string" + }, + "name": "key", + "type": "array" + }, + { + "description": "If true, try to continue even if some stats are unavailable. In this case, errors will be present in the per-key returned data.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "Shows the logical node number or LNN in addition to the devid.", + "in": "query", + "name": "show_nodes", + "type": "boolean" + }, + { + "description": "Synonymous with 'interval', if supplied supersedes interval.", + "in": "query", + "name": "resolution", + "type": "integer" + }, + { + "description": "Specify node(s) for which statistics should be reported. One or more comma separated specifying which node(s) to query, or \"all\". Specifying more than one node may have unspecified results for keys that begin with \"cluster\".", + "in": "query", + "items": { + "type": "string" + }, + "name": "nodes", + "type": "array" + }, + { + "description": "Shows the description for the specified key(s).", + "in": "query", + "name": "desc_info", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Retrieve stats.", + "schema": { + "$ref": "#/definitions/v1StatisticsHistory" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/1/statistics/keys": { + "get": { + "description": "List meta-data for matching keys.", + "operationId": "getStatisticsv1StatisticsKeys", + "parameters": [ + { + "description": "Only count matching keys, do not return meta-data.", + "in": "query", + "name": "count", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Only list keys that can/cannot be queries. Default is true.", + "in": "query", + "name": "queryable", + "type": "boolean" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List meta-data for matching keys.", + "schema": { + "$ref": "#/definitions/v1StatisticsKeys" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/1/statistics/keys/{v1StatisticsKeyId}": { + "get": { + "description": "List key meta-data.", + "operationId": "getStatisticsv1StatisticsKey", + "parameters": [ + { + "description": "List key meta-data.", + "in": "path", + "name": "v1StatisticsKeyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List key meta-data.", + "schema": { + "$ref": "#/definitions/v1StatisticsKeysExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/1/statistics/protocols": { + "get": { + "description": "Retrieve protocol list.", + "operationId": "getStatisticsv1StatisticsProtocols", + "parameters": [ + { + "description": "Specifies whether internal, external, or all protocols should be returned.", + "enum": [ + "internal", + "external", + "all" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve protocol list.", + "schema": { + "$ref": "#/definitions/v1StatisticsProtocols" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/1/storagepool/nodepools": { + "get": { + "description": "List all node pools.", + "operationId": "listStoragepoolv1StoragepoolNodepools", + "parameters": [], + "responses": { + "200": { + "description": "List all node pools.", + "schema": { + "$ref": "#/definitions/v1StoragepoolNodepools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "post": { + "description": "Create a new node pool.", + "operationId": "createStoragepoolv1StoragepoolNodepool", + "parameters": [ + { + "in": "body", + "name": "v1StoragepoolNodepool", + "required": true, + "schema": { + "$ref": "#/definitions/v1StoragepoolNodepool" + } + } + ], + "responses": { + "200": { + "description": "Create a new node pool.", + "schema": { + "$ref": "#/definitions/Createv1StoragepoolNodepoolResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/storagepool/nodepools/{v1StoragepoolNodepoolId}": { + "delete": { + "description": "Delete node pool.", + "operationId": "deleteStoragepoolv1StoragepoolNodepool", + "parameters": [ + { + "description": "Delete node pool.", + "in": "path", + "name": "v1StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "get": { + "description": "Retrieve node pool information.", + "operationId": "getStoragepoolv1StoragepoolNodepool", + "parameters": [ + { + "description": "Retrieve node pool information.", + "in": "path", + "name": "v1StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve node pool information.", + "schema": { + "$ref": "#/definitions/v1StoragepoolNodepoolsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "put": { + "description": "Modify node pool. All input fields are optional, but one or more must be supplied.", + "operationId": "updateStoragepoolv1StoragepoolNodepool", + "parameters": [ + { + "in": "body", + "name": "v1StoragepoolNodepool", + "required": true, + "schema": { + "$ref": "#/definitions/v1StoragepoolNodepoolExtendedExtended" + } + }, + { + "description": "Modify node pool. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/storagepool/settings": { + "get": { + "description": "List all storagepool settings.", + "operationId": "getStoragepoolv1StoragepoolSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all storagepool settings.", + "schema": { + "$ref": "#/definitions/v1StoragepoolSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateStoragepoolv1StoragepoolSettings", + "parameters": [ + { + "in": "body", + "name": "v1StoragepoolSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v1StoragepoolSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/storagepool/status": { + "get": { + "description": "List any health conditions detected.", + "operationId": "getStoragepoolv1StoragepoolStatus", + "parameters": [], + "responses": { + "200": { + "description": "List any health conditions detected.", + "schema": { + "$ref": "#/definitions/v1StoragepoolStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/storagepool/storagepools": { + "get": { + "description": "List all storage pools.", + "operationId": "getStoragepoolv1StoragepoolStoragepools", + "parameters": [ + { + "description": "If true, node pools contained within tiers will be filtered out of results.", + "in": "query", + "name": "toplevels", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all storage pools.", + "schema": { + "$ref": "#/definitions/v1StoragepoolStoragepools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/storagepool/tiers": { + "delete": { + "description": "Delete all tiers.", + "operationId": "deleteStoragepoolv1StoragepoolTiers", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "get": { + "description": "List all tiers.", + "operationId": "listStoragepoolv1StoragepoolTiers", + "parameters": [], + "responses": { + "200": { + "description": "List all tiers.", + "schema": { + "$ref": "#/definitions/v1StoragepoolTiers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "post": { + "description": "Create a new tier.", + "operationId": "createStoragepoolv1StoragepoolTier", + "parameters": [ + { + "in": "body", + "name": "v1StoragepoolTier", + "required": true, + "schema": { + "$ref": "#/definitions/v1StoragepoolTier" + } + } + ], + "responses": { + "200": { + "description": "Create a new tier.", + "schema": { + "$ref": "#/definitions/Createv1StoragepoolNodepoolResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/storagepool/tiers/{v1StoragepoolTierId}": { + "delete": { + "description": "Delete tier.", + "operationId": "deleteStoragepoolv1StoragepoolTier", + "parameters": [ + { + "description": "Delete tier.", + "in": "path", + "name": "v1StoragepoolTierId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "get": { + "description": "Retrieve tier information.", + "operationId": "getStoragepoolv1StoragepoolTier", + "parameters": [ + { + "description": "Retrieve tier information.", + "in": "path", + "name": "v1StoragepoolTierId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve tier information.", + "schema": { + "$ref": "#/definitions/v1StoragepoolTiersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "put": { + "description": "Modify tier. All input fields are optional, but one or more must be supplied.", + "operationId": "updateStoragepoolv1StoragepoolTier", + "parameters": [ + { + "in": "body", + "name": "v1StoragepoolTier", + "required": true, + "schema": { + "$ref": "#/definitions/v1StoragepoolTierExtendedExtended" + } + }, + { + "description": "Modify tier. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1StoragepoolTierId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/storagepool/unprovisioned": { + "get": { + "description": "Get the unprovisioned nodes and drives", + "operationId": "getStoragepoolv1StoragepoolUnprovisioned", + "parameters": [], + "responses": { + "200": { + "description": "Get the unprovisioned nodes and drives", + "schema": { + "$ref": "#/definitions/v1StoragepoolUnprovisioned" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/1/sync/history/file": { + "get": { + "description": "List file operations performance data.", + "operationId": "getSyncv1HistoryFile", + "parameters": [ + { + "description": "Begin timestamp for time-series report.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "End timestamp for time-series report.", + "in": "query", + "name": "end", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List file operations performance data.", + "schema": { + "$ref": "#/definitions/v1HistoryFile" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/history/network": { + "get": { + "description": "List network operations performance data.", + "operationId": "getSyncv1HistoryNetwork", + "parameters": [ + { + "description": "Begin timestamp for time-series report.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "End timestamp for time-series report.", + "in": "query", + "name": "end", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List network operations performance data.", + "schema": { + "$ref": "#/definitions/v1HistoryNetwork" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/jobs": { + "delete": { + "description": "Cancel all SyncIQ jobs.", + "operationId": "deleteSyncv1SyncJobs", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "Get a list of SyncIQ jobs.", + "operationId": "listSyncv1SyncJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ jobs.", + "schema": { + "$ref": "#/definitions/v1SyncJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Start a SyncIQ job.", + "operationId": "createSyncv1SyncJob", + "parameters": [ + { + "in": "body", + "name": "v1SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncJob" + } + } + ], + "responses": { + "200": { + "description": "Start a SyncIQ job.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/jobs/{v1SyncJobId}": { + "get": { + "description": "View a single SyncIQ job.", + "operationId": "getSyncv1SyncJob", + "parameters": [ + { + "description": "View a single SyncIQ job.", + "in": "path", + "name": "v1SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ job.", + "schema": { + "$ref": "#/definitions/v1SyncJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "operationId": "updateSyncv1SyncJob", + "parameters": [ + { + "in": "body", + "name": "v1SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncJobExtendedExtended" + } + }, + { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "in": "path", + "name": "v1SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/license": { + "get": { + "description": "Retrieve license information.", + "operationId": "getSyncv1SyncLicense", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve license information.", + "schema": { + "$ref": "#/definitions/v1LicenseLicenseExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/policies": { + "delete": { + "description": "Delete all SyncIQ policies.", + "operationId": "deleteSyncv1SyncPolicies", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "List all SyncIQ policies.", + "operationId": "listSyncv1SyncPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Show only summary properties", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ policies.", + "schema": { + "$ref": "#/definitions/v1SyncPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Create a SyncIQ policy.", + "operationId": "createSyncv1SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v1SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a SyncIQ policy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/policies/{Policy}/reset": { + "post": { + "description": "Reset a SyncIQ policy incremental state and force a full sync/copy.", + "operationId": "createSyncPoliciesv1PolicyResetItem", + "parameters": [ + { + "in": "body", + "name": "v1PolicyResetItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Policy", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Reset a SyncIQ policy incremental state and force a full sync/copy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncPolicies" + ] + } + }, + "/platform/1/sync/policies/{v1SyncPolicyId}": { + "delete": { + "description": "Delete a single SyncIQ policy.", + "operationId": "deleteSyncv1SyncPolicy", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a single SyncIQ policy.", + "in": "path", + "name": "v1SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ policy.", + "operationId": "getSyncv1SyncPolicy", + "parameters": [ + { + "description": "View a single SyncIQ policy.", + "in": "path", + "name": "v1SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ policy.", + "schema": { + "$ref": "#/definitions/v1SyncPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a single SyncIQ policy.", + "operationId": "updateSyncv1SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v1SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncPolicyExtendedExtended" + } + }, + { + "description": "Modify a single SyncIQ policy.", + "in": "path", + "name": "v1SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/reports": { + "get": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv1SyncReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v1SyncReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/reports-rotate": { + "get": { + "description": "Whether the rotation is still running or not.", + "operationId": "listSyncv1SyncReportsRotate", + "parameters": [], + "responses": { + "200": { + "description": "Whether the rotation is still running or not.", + "schema": { + "$ref": "#/definitions/v1SyncReportsRotate" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Rotate the records in the database(s).", + "operationId": "createSyncv1SyncReportsRotateItem", + "parameters": [ + { + "in": "body", + "name": "v1SyncReportsRotateItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Rotate the records in the database(s).", + "schema": { + "$ref": "#/definitions/Createv1SyncReportsRotateItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ subreports for a report.", + "operationId": "getSyncReportsv1ReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ subreports for a report.", + "schema": { + "$ref": "#/definitions/v1ReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncReports" + ] + } + }, + "/platform/1/sync/reports/{Rid}/subreports/{v1ReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ subreport.", + "operationId": "getSyncv1ReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ subreport.", + "in": "path", + "name": "v1ReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ subreport.", + "schema": { + "$ref": "#/definitions/v1ReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/reports/{v1SyncReportId}": { + "get": { + "description": "View a single SyncIQ report.", + "operationId": "getSyncv1SyncReport", + "parameters": [ + { + "description": "View a single SyncIQ report.", + "in": "path", + "name": "v1SyncReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ report.", + "schema": { + "$ref": "#/definitions/v1SyncReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/rules": { + "delete": { + "description": "Delete all SyncIQ performance rules or all rules of a specified type.", + "operationId": "deleteSyncv1SyncRules", + "parameters": [ + { + "description": "Delete all rules of the specified rule type only.", + "enum": [ + "bandwidth", + "file_count", + "cpu" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "List all SyncIQ performance rules.", + "operationId": "listSyncv1SyncRules", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Filter the returned rules to include only those with this rule type.", + "enum": [ + "bandwidth", + "file_count", + "cpu" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ performance rules.", + "schema": { + "$ref": "#/definitions/v1SyncRules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Create a new SyncIQ performance rule.", + "operationId": "createSyncv1SyncRule", + "parameters": [ + { + "in": "body", + "name": "v1SyncRule", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncRule" + } + } + ], + "responses": { + "200": { + "description": "Create a new SyncIQ performance rule.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/rules/{v1SyncRuleId}": { + "delete": { + "description": "Delete a single SyncIQ performance rule.", + "operationId": "deleteSyncv1SyncRule", + "parameters": [ + { + "description": "Delete a single SyncIQ performance rule.", + "in": "path", + "name": "v1SyncRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ performance rule.", + "operationId": "getSyncv1SyncRule", + "parameters": [ + { + "description": "View a single SyncIQ performance rule.", + "in": "path", + "name": "v1SyncRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ performance rule.", + "schema": { + "$ref": "#/definitions/v1SyncRulesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a single SyncIQ performance rule.", + "operationId": "updateSyncv1SyncRule", + "parameters": [ + { + "in": "body", + "name": "v1SyncRule", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncRuleExtendedExtended" + } + }, + { + "description": "Modify a single SyncIQ performance rule.", + "in": "path", + "name": "v1SyncRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/settings": { + "get": { + "description": "Retrieve the global SyncIQ settings.", + "operationId": "getSyncv1SyncSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the global SyncIQ settings.", + "schema": { + "$ref": "#/definitions/v1SyncSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify the global SyncIQ settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSyncv1SyncSettings", + "parameters": [ + { + "in": "body", + "name": "v1SyncSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/target/policies": { + "get": { + "description": "List all SyncIQ target policies.", + "operationId": "getSyncv1TargetPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Filter the returned policies to include only those with this target path.", + "in": "query", + "name": "target_path", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ target policies.", + "schema": { + "$ref": "#/definitions/v1TargetPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/target/policies/{Policy}/cancel": { + "post": { + "description": "Cancel the most recent SyncIQ job for this policy from the target side.", + "operationId": "createSyncTargetv1PoliciesPolicyCancelItem", + "parameters": [ + { + "in": "body", + "name": "v1PoliciesPolicyCancelItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Policy", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Cancel the most recent SyncIQ job for this policy from the target side.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncTarget" + ] + } + }, + "/platform/1/sync/target/policies/{v1TargetPolicyId}": { + "delete": { + "description": "Break the target association with this cluster for this policy.", + "operationId": "deleteSyncv1TargetPolicy", + "parameters": [ + { + "description": "Ignore any running jobs when preparing to delete the policy target association.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Break the target association with this cluster for this policy.", + "in": "path", + "name": "v1TargetPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ target policy.", + "operationId": "getSyncv1TargetPolicy", + "parameters": [ + { + "description": "View a single SyncIQ target policy.", + "in": "path", + "name": "v1TargetPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target policy.", + "schema": { + "$ref": "#/definitions/v7ServiceTargetPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/target/reports": { + "get": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv1TargetReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v1TargetReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/target/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ target subreports for a report.", + "operationId": "getSyncTargetv1ReportsReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target subreports for a report.", + "schema": { + "$ref": "#/definitions/v1ReportsReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncTarget" + ] + } + }, + "/platform/1/sync/target/reports/{Rid}/subreports/{v1TargetReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ target subreport.", + "operationId": "getSyncv1TargetReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ target subreport.", + "in": "path", + "name": "v1TargetReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target subreport.", + "schema": { + "$ref": "#/definitions/v1TargetReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/sync/target/reports/{v1TargetReportId}": { + "get": { + "description": "View a single SyncIQ target report.", + "operationId": "getSyncv1TargetReport", + "parameters": [ + { + "description": "View a single SyncIQ target report.", + "in": "path", + "name": "v1TargetReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target report.", + "schema": { + "$ref": "#/definitions/v1TargetReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/1/worm/domains": { + "get": { + "description": "List all WORM domains.", + "operationId": "listWormv1WormDomains", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all WORM domains.", + "schema": { + "$ref": "#/definitions/v1WormDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + }, + "post": { + "description": "Create a WORM domain.", + "operationId": "createWormv1WormDomain", + "parameters": [ + { + "in": "body", + "name": "v1WormDomain", + "required": true, + "schema": { + "$ref": "#/definitions/v1WormDomain" + } + } + ], + "responses": { + "200": { + "description": "Create a WORM domain.", + "schema": { + "$ref": "#/definitions/Createv1WormDomainResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + } + }, + "/platform/1/worm/domains/{v1WormDomainId}": { + "get": { + "description": "View a single WORM domain.", + "operationId": "getWormv1WormDomain", + "parameters": [ + { + "description": "View a single WORM domain.", + "in": "path", + "name": "v1WormDomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single WORM domain.", + "schema": { + "$ref": "#/definitions/v1WormDomainsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + }, + "put": { + "description": "Modify a single WORM domain.", + "operationId": "updateWormv1WormDomain", + "parameters": [ + { + "in": "body", + "name": "v1WormDomain", + "required": true, + "schema": { + "$ref": "#/definitions/v1WormDomainExtended" + } + }, + { + "description": "Modify a single WORM domain.", + "in": "path", + "name": "v1WormDomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + } + }, + "/platform/1/worm/settings": { + "get": { + "description": "Get the global WORM settings.", + "operationId": "getWormv1WormSettings", + "parameters": [], + "responses": { + "200": { + "description": "Get the global WORM settings.", + "schema": { + "$ref": "#/definitions/v1WormSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + }, + "put": { + "description": "Modify the global WORM settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateWormv1WormSettings", + "parameters": [ + { + "in": "body", + "name": "v1WormSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v1WormSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + } + }, + "/platform/1/zones": { + "get": { + "description": "List all access zones.", + "operationId": "listZonesv1Zones", + "parameters": [], + "responses": { + "200": { + "description": "List all access zones.", + "schema": { + "$ref": "#/definitions/v1Zones" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + }, + "post": { + "description": "Create a new access zone.", + "operationId": "createZonesv1Zone", + "parameters": [ + { + "in": "body", + "name": "v1Zone", + "required": true, + "schema": { + "$ref": "#/definitions/v1Zone" + } + } + ], + "responses": { + "200": { + "description": "Create a new access zone.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + } + }, + "/platform/1/zones-summary": { + "get": { + "description": "Retrieve access zone summary information.", + "operationId": "getZonesSummaryv1ZonesSummary", + "parameters": [ + { + "description": "Name of groupnet in which to list zones.", + "in": "query", + "name": "groupnet", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve access zone summary information.", + "schema": { + "$ref": "#/definitions/v1ZonesSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ZonesSummary" + ] + } + }, + "/platform/1/zones-summary/{v1ZonesSummaryZone}": { + "get": { + "description": "Retrieve non-privileged access zone information.", + "operationId": "getZonesSummaryv1ZonesSummaryZone", + "parameters": [ + { + "description": "Retrieve non-privileged access zone information.", + "in": "path", + "name": "v1ZonesSummaryZone", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve non-privileged access zone information.", + "schema": { + "$ref": "#/definitions/v1ZonesSummaryExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ZonesSummary" + ] + } + }, + "/platform/1/zones/{v1ZoneId}": { + "delete": { + "description": "Delete the access zone.", + "operationId": "deleteZonesv1Zone", + "parameters": [ + { + "description": "Delete the access zone.", + "in": "path", + "name": "v1ZoneId", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + }, + "get": { + "description": "Retrieve the access zone information.", + "operationId": "getZonesv1Zone", + "parameters": [ + { + "description": "Retrieve the access zone information.", + "in": "path", + "name": "v1ZoneId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve the access zone information.", + "schema": { + "$ref": "#/definitions/v1Zones" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + }, + "put": { + "description": "Modify the access zone. All input fields are optional, but one or more must be supplied.", + "operationId": "updateZonesv1Zone", + "parameters": [ + { + "in": "body", + "name": "v1Zone", + "required": true, + "schema": { + "$ref": "#/definitions/v1ZoneExtendedExtended" + } + }, + { + "description": "Modify the access zone. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v1ZoneId", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + } + }, + "/platform/10/cluster/nodes": { + "get": { + "description": "List the nodes on this cluster.", + "operationId": "getClusterv10ClusterNodes", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + } + ], + "responses": { + "200": { + "description": "List the nodes on this cluster.", + "schema": { + "$ref": "#/definitions/v10ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/10/cluster/nodes/{Lnn}/hardware": { + "get": { + "description": "Retrieve node hardware identity information.", + "operationId": "getClusterNodesv10NodeHardware", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node hardware identity information.", + "schema": { + "$ref": "#/definitions/v10NodeHardware" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/10/cluster/nodes/{Lnn}/status/cpu": { + "get": { + "description": "Retrieve node CPU status information.", + "operationId": "getClusterNodesv10NodeStatusCpu", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node CPU status information.", + "schema": { + "$ref": "#/definitions/v10NodeStatusCpu" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/10/cluster/nodes/{Lnn}/status/nvram": { + "get": { + "description": "Retrieve node NVRAM status information.", + "operationId": "getClusterNodesv10NodeStatusNvram", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node NVRAM status information.", + "schema": { + "$ref": "#/definitions/v10NodeStatusNvram" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/10/cluster/nodes/{Lnn}/status/powersupplies": { + "get": { + "description": "Retrieve node power supplies status information.", + "operationId": "getClusterNodesv10NodeStatusPowersupplies", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node power supplies status information.", + "schema": { + "$ref": "#/definitions/v10NodeStatusPowersupplies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/10/cluster/nodes/{v10ClusterNodeId}": { + "get": { + "description": "Retrieve node information.", + "operationId": "getClusterv10ClusterNode", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve node information.", + "in": "path", + "name": "v10ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node information.", + "schema": { + "$ref": "#/definitions/v10ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/10/healthcheck/checklists": { + "get": { + "description": "List checklists.", + "operationId": "getHealthcheckv10HealthcheckChecklists", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List checklists.", + "schema": { + "$ref": "#/definitions/v10HealthcheckChecklists" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/10/healthcheck/checklists/{v10HealthcheckChecklistId}": { + "get": { + "description": "Retrieve a checklist definition.", + "operationId": "getHealthcheckv10HealthcheckChecklist", + "parameters": [ + { + "description": "Retrieve a checklist definition.", + "in": "path", + "name": "v10HealthcheckChecklistId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a checklist definition.", + "schema": { + "$ref": "#/definitions/v10HealthcheckChecklistsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "put": { + "description": "Modify checklist default delivery.", + "operationId": "updateHealthcheckv10HealthcheckChecklist", + "parameters": [ + { + "in": "body", + "name": "v10HealthcheckChecklist", + "required": true, + "schema": { + "$ref": "#/definitions/v10HealthcheckChecklistExtended" + } + }, + { + "description": "Modify checklist default delivery.", + "in": "path", + "name": "v10HealthcheckChecklistId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/10/healthcheck/evaluations": { + "get": { + "description": "List evaluations.", + "operationId": "listHealthcheckv10HealthcheckEvaluations", + "parameters": [ + { + "description": "Also return details for items that pass", + "in": "query", + "name": "detailed", + "type": "boolean" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Content detail level", + "enum": [ + "full", + "list" + ], + "in": "query", + "name": "level", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List evaluations.", + "schema": { + "$ref": "#/definitions/v10HealthcheckEvaluations" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "post": { + "description": "Request an evaluation.", + "operationId": "createHealthcheckv10HealthcheckEvaluation", + "parameters": [ + { + "in": "body", + "name": "v10HealthcheckEvaluation", + "required": true, + "schema": { + "$ref": "#/definitions/v10HealthcheckEvaluation" + } + } + ], + "responses": { + "200": { + "description": "Request an evaluation.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/10/healthcheck/evaluations/{v10HealthcheckEvaluationId}": { + "delete": { + "description": "Cancel an evaluation.", + "operationId": "deleteHealthcheckv10HealthcheckEvaluation", + "parameters": [ + { + "description": "Cancel an evaluation.", + "in": "path", + "name": "v10HealthcheckEvaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "get": { + "description": "Retrieve individual evaluation.", + "operationId": "getHealthcheckv10HealthcheckEvaluation", + "parameters": [ + { + "description": "Also return details for items that pass", + "in": "query", + "name": "detailed", + "type": "boolean" + }, + { + "description": "Retrieve individual evaluation.", + "in": "path", + "name": "v10HealthcheckEvaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve individual evaluation.", + "schema": { + "$ref": "#/definitions/v10HealthcheckEvaluationsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "put": { + "description": "Pause or resume an evaluation.", + "operationId": "updateHealthcheckv10HealthcheckEvaluation", + "parameters": [ + { + "in": "body", + "name": "v10HealthcheckEvaluation", + "required": true, + "schema": { + "$ref": "#/definitions/v10HealthcheckEvaluationExtendedExtended" + } + }, + { + "description": "Pause or resume an evaluation.", + "in": "path", + "name": "v10HealthcheckEvaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/10/healthcheck/schedules": { + "get": { + "description": "List schedules.", + "operationId": "listHealthcheckv10HealthcheckSchedules", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List schedules.", + "schema": { + "$ref": "#/definitions/v10HealthcheckSchedules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "post": { + "description": "Create a schedule.", + "operationId": "createHealthcheckv10HealthcheckSchedule", + "parameters": [ + { + "in": "body", + "name": "v10HealthcheckSchedule", + "required": true, + "schema": { + "$ref": "#/definitions/v10HealthcheckSchedule" + } + } + ], + "responses": { + "200": { + "description": "Create a schedule.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/10/healthcheck/schedules/{v10HealthcheckScheduleId}": { + "delete": { + "description": "Delete a schedule.", + "operationId": "deleteHealthcheckv10HealthcheckSchedule", + "parameters": [ + { + "description": "Delete a schedule.", + "in": "path", + "name": "v10HealthcheckScheduleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "get": { + "description": "Retrieve individual schedule.", + "operationId": "getHealthcheckv10HealthcheckSchedule", + "parameters": [ + { + "description": "Retrieve individual schedule.", + "in": "path", + "name": "v10HealthcheckScheduleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve individual schedule.", + "schema": { + "$ref": "#/definitions/v10HealthcheckSchedulesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "put": { + "description": "Modify a schedule value.", + "operationId": "updateHealthcheckv10HealthcheckSchedule", + "parameters": [ + { + "in": "body", + "name": "v10HealthcheckSchedule", + "required": true, + "schema": { + "$ref": "#/definitions/v10HealthcheckScheduleExtendedExtended" + } + }, + { + "description": "Modify a schedule value.", + "in": "path", + "name": "v10HealthcheckScheduleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/10/ipmi/config/features": { + "get": { + "description": "Get detailed information for all remote IPMI features.", + "operationId": "getIpmiv10ConfigFeatures", + "parameters": [], + "responses": { + "200": { + "description": "Get detailed information for all remote IPMI features.", + "schema": { + "$ref": "#/definitions/v10ConfigFeatures" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + } + }, + "/platform/10/ipmi/config/features/{v10ConfigFeatureId}": { + "get": { + "description": "Retrieve the Remote IPMI Management feature configuration.", + "operationId": "getIpmiv10ConfigFeature", + "parameters": [ + { + "description": "Retrieve the Remote IPMI Management feature configuration.", + "in": "path", + "name": "v10ConfigFeatureId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the Remote IPMI Management feature configuration.", + "schema": { + "$ref": "#/definitions/v10ConfigFeaturesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + }, + "put": { + "description": "Modify remote IPMI Management feature settings", + "operationId": "updateIpmiv10ConfigFeature", + "parameters": [ + { + "in": "body", + "name": "v10ConfigFeature", + "required": true, + "schema": { + "$ref": "#/definitions/v10ConfigFeatureExtended" + } + }, + { + "description": "Modify remote IPMI Management feature settings", + "in": "path", + "name": "v10ConfigFeatureId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + } + }, + "/platform/10/ipmi/config/network": { + "get": { + "description": "Retrieve the Remote IPMI Management static network configuration settings.", + "operationId": "getIpmiv10ConfigNetwork", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the Remote IPMI Management static network configuration settings.", + "schema": { + "$ref": "#/definitions/v10ConfigNetwork" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + }, + "put": { + "description": "Modify the remote IPMI Management static network configuration settings", + "operationId": "updateIpmiv10ConfigNetwork", + "parameters": [ + { + "in": "body", + "name": "v10ConfigNetwork", + "required": true, + "schema": { + "$ref": "#/definitions/v10ConfigNetworkExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + } + }, + "/platform/10/ipmi/config/nodes": { + "get": { + "description": "Retrieve the Remote IPMI Management nodes configuration.", + "operationId": "getIpmiv10ConfigNodes", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the Remote IPMI Management nodes configuration.", + "schema": { + "$ref": "#/definitions/v10ConfigNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + } + }, + "/platform/10/ipmi/config/nodes/{v10ConfigNodeId}": { + "get": { + "description": "Retrieve the Remote IPMI Management node configuration.", + "operationId": "getIpmiv10ConfigNode", + "parameters": [ + { + "description": "Retrieve the Remote IPMI Management node configuration.", + "in": "path", + "name": "v10ConfigNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve the Remote IPMI Management node configuration.", + "schema": { + "$ref": "#/definitions/v10ConfigNodesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + } + }, + "/platform/10/ipmi/config/settings": { + "get": { + "description": "View the Remote IPMI Management configuration settings.", + "operationId": "getIpmiv10ConfigSettings", + "parameters": [], + "responses": { + "200": { + "description": "View the Remote IPMI Management configuration settings.", + "schema": { + "$ref": "#/definitions/v10ConfigSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + }, + "put": { + "description": "Modify remote IPMI Management configuration settings", + "operationId": "updateIpmiv10ConfigSettings", + "parameters": [ + { + "in": "body", + "name": "v10ConfigSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v10ConfigSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + } + }, + "/platform/10/ipmi/config/user": { + "get": { + "description": "View the Remote IPMI Management user.", + "operationId": "getIpmiv10ConfigUser", + "parameters": [], + "responses": { + "200": { + "description": "View the Remote IPMI Management user.", + "schema": { + "$ref": "#/definitions/v10ConfigUser" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + }, + "put": { + "description": "Modify remote IPMI Management user", + "operationId": "updateIpmiv10ConfigUser", + "parameters": [ + { + "in": "body", + "name": "v10ConfigUser", + "required": true, + "schema": { + "$ref": "#/definitions/v10ConfigUserUser" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Ipmi" + ] + } + }, + "/platform/10/job/jobs": { + "get": { + "description": "List running and paused jobs.", + "operationId": "listJobv10JobJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, other arguments are ignored, and the query will return all results, unsorted, as quickly as possible.", + "in": "query", + "name": "batch", + "type": "boolean" + }, + { + "description": "Limit the results to jobs in the specified state.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List running and paused jobs.", + "schema": { + "$ref": "#/definitions/v10JobJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "post": { + "description": "Queue a new instance of a job type.", + "operationId": "createJobv10JobJob", + "parameters": [ + { + "in": "body", + "name": "v10JobJob", + "required": true, + "schema": { + "$ref": "#/definitions/v10JobJob" + } + } + ], + "responses": { + "200": { + "description": "Queue a new instance of a job type.", + "schema": { + "$ref": "#/definitions/Createv1JobJobResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/10/network/groupnets": { + "get": { + "description": "Get a list of groupnets.", + "operationId": "listNetworkv10NetworkGroupnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of groupnets.", + "schema": { + "$ref": "#/definitions/v10NetworkGroupnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "post": { + "description": "Create a new groupnet.", + "operationId": "createNetworkv10NetworkGroupnet", + "parameters": [ + { + "in": "body", + "name": "v10NetworkGroupnet", + "required": true, + "schema": { + "$ref": "#/definitions/v10NetworkGroupnet" + } + } + ], + "responses": { + "200": { + "description": "Create a new groupnet.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/10/network/groupnets/{v10NetworkGroupnetId}": { + "delete": { + "description": "Delete a network groupnet.", + "operationId": "deleteNetworkv10NetworkGroupnet", + "parameters": [ + { + "description": "Delete a network groupnet.", + "in": "path", + "name": "v10NetworkGroupnetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a network groupnet.", + "operationId": "getNetworkv10NetworkGroupnet", + "parameters": [ + { + "description": "View a network groupnet.", + "in": "path", + "name": "v10NetworkGroupnetId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a network groupnet.", + "schema": { + "$ref": "#/definitions/v10NetworkGroupnetsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network groupnet.", + "operationId": "updateNetworkv10NetworkGroupnet", + "parameters": [ + { + "in": "body", + "name": "v10NetworkGroupnet", + "required": true, + "schema": { + "$ref": "#/definitions/v10NetworkGroupnetExtendedExtended" + } + }, + { + "description": "Modify a network groupnet.", + "in": "path", + "name": "v10NetworkGroupnetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/10/performance/datasets": { + "get": { + "description": "List all datasets.", + "operationId": "listPerformancev10PerformanceDatasets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all datasets.", + "schema": { + "$ref": "#/definitions/v10PerformanceDatasets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "post": { + "description": "Create a new dataset.", + "operationId": "createPerformancev10PerformanceDataset", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v10PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceDataset" + } + } + ], + "responses": { + "200": { + "description": "Create a new dataset.", + "schema": { + "$ref": "#/definitions/Createv10PerformanceDatasetResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/10/performance/datasets/{Dataset}/filters": { + "delete": { + "description": "Delete all filters associated with the dataset.", + "operationId": "deletePerformanceDatasetsv10DatasetFilters", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all filters.", + "operationId": "listPerformanceDatasetsv10DatasetFilters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all filters.", + "schema": { + "$ref": "#/definitions/v10DatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new filter.", + "operationId": "createPerformanceDatasetsv10DatasetFilter", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v10DatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetFilter" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new filter.", + "schema": { + "$ref": "#/definitions/Createv10DatasetFilterResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/10/performance/datasets/{Dataset}/filters/{v10DatasetsDatasetFilterId}": { + "delete": { + "description": "Delete the filter.", + "operationId": "deletePerformancev10DatasetsDatasetFilter", + "parameters": [ + { + "description": "Delete the filter.", + "in": "path", + "name": "v10DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the filter.", + "operationId": "getPerformancev10DatasetsDatasetFilter", + "parameters": [ + { + "description": "Retrieve the filter.", + "in": "path", + "name": "v10DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the filter.", + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the filter.", + "operationId": "updatePerformancev10DatasetsDatasetFilter", + "parameters": [ + { + "in": "body", + "name": "v10DatasetsDatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetFilter" + } + }, + { + "description": "Modify the filter.", + "in": "path", + "name": "v10DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/10/performance/datasets/{Dataset}/workloads": { + "delete": { + "description": "Delete all workloads associated with the dataset.", + "operationId": "deletePerformanceDatasetsv10DatasetWorkloads", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all workloads.", + "operationId": "listPerformanceDatasetsv10DatasetWorkloads", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all workloads.", + "schema": { + "$ref": "#/definitions/v10DatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new workload.", + "operationId": "createPerformanceDatasetsv10DatasetWorkload", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v10DatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetWorkload" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new workload.", + "schema": { + "$ref": "#/definitions/Createv10DatasetWorkloadResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/10/performance/datasets/{Dataset}/workloads/{v10DatasetsDatasetWorkloadId}": { + "delete": { + "description": "Delete the workload.", + "operationId": "deletePerformancev10DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Delete the workload.", + "in": "path", + "name": "v10DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the workload.", + "operationId": "getPerformancev10DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Retrieve the workload.", + "in": "path", + "name": "v10DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the workload.", + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the workload.", + "operationId": "updatePerformancev10DatasetsDatasetWorkload", + "parameters": [ + { + "in": "body", + "name": "v10DatasetsDatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetWorkload" + } + }, + { + "description": "Modify the workload.", + "in": "path", + "name": "v10DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/10/performance/datasets/{v10PerformanceDatasetId}": { + "delete": { + "description": "Delete the performance dataset.", + "operationId": "deletePerformancev10PerformanceDataset", + "parameters": [ + { + "description": "Delete the performance dataset.", + "in": "path", + "name": "v10PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the performance dataset.", + "operationId": "getPerformancev10PerformanceDataset", + "parameters": [ + { + "description": "Retrieve the performance dataset.", + "in": "path", + "name": "v10PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the performance dataset.", + "schema": { + "$ref": "#/definitions/v10PerformanceDatasetsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the name of the performance dataset.", + "operationId": "updatePerformancev10PerformanceDataset", + "parameters": [ + { + "in": "body", + "name": "v10PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceDatasetExtendedExtended" + } + }, + { + "description": "Modify the name of the performance dataset.", + "in": "path", + "name": "v10PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/10/performance/metrics": { + "get": { + "description": "List all metrics.", + "operationId": "getPerformancev10PerformanceMetrics", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all metrics.", + "schema": { + "$ref": "#/definitions/v10PerformanceMetrics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/10/performance/metrics/{v10PerformanceMetricId}": { + "get": { + "description": "View a single performance metric.", + "operationId": "getPerformancev10PerformanceMetric", + "parameters": [ + { + "description": "View a single performance metric.", + "in": "path", + "name": "v10PerformanceMetricId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single performance metric.", + "schema": { + "$ref": "#/definitions/v10PerformanceMetricsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/10/performance/settings": { + "get": { + "description": "List all performance settings.", + "operationId": "getPerformancev10PerformanceSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all performance settings.", + "schema": { + "$ref": "#/definitions/v10PerformanceSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Configure performance settings.", + "operationId": "updatePerformancev10PerformanceSettings", + "parameters": [ + { + "description": "Allow modification of settings outside of recommended limits", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v10PerformanceSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/10/protocols/s3/buckets": { + "get": { + "description": "List all buckets.", + "operationId": "listProtocolsv10S3Buckets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Specifies the name of the owner.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "owner", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all buckets.", + "schema": { + "$ref": "#/definitions/v10S3Buckets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new bucket.", + "operationId": "createProtocolsv10S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v10S3Bucket", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3Bucket" + } + } + ], + "responses": { + "200": { + "description": "Create a new bucket.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/10/protocols/s3/buckets/{v10S3BucketId}": { + "delete": { + "description": "Delete the bucket.", + "operationId": "deleteProtocolsv10S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Delete the bucket.", + "in": "path", + "name": "v10S3BucketId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve bucket.", + "operationId": "getProtocolsv10S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve bucket.", + "in": "path", + "name": "v10S3BucketId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve bucket.", + "schema": { + "$ref": "#/definitions/v10S3BucketsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify bucket. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv10S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v10S3Bucket", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3BucketExtendedExtended" + } + }, + { + "description": "Modify bucket. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v10S3BucketId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/10/protocols/s3/keys/{v10S3KeyId}": { + "delete": { + "description": "Delete secret key information for given user.", + "operationId": "deleteProtocolsv10S3Key", + "parameters": [ + { + "description": "Specifies access zone containing user.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete secret key information for given user.", + "in": "path", + "name": "v10S3KeyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Get access ID information for given user.", + "operationId": "getProtocolsv10S3Key", + "parameters": [ + { + "description": "Specifies access zone containing user.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Get access ID information for given user.", + "in": "path", + "name": "v10S3KeyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get access ID information for given user.", + "schema": { + "$ref": "#/definitions/v10S3Keys" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Generate a new secret key/access ID for given user.", + "operationId": "createProtocolsv10S3Key", + "parameters": [ + { + "description": "Forces to create new key.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Specifies access zone containing user.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v10S3Key", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3Key" + } + }, + { + "description": "Generate a new secret key/access ID for given user.", + "in": "path", + "name": "v10S3KeyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Generate a new secret key/access ID for given user.", + "schema": { + "$ref": "#/definitions/Createv10S3KeyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/10/protocols/s3/log-level": { + "get": { + "description": "Get the current S3 service logging level.", + "operationId": "getProtocolsv10S3LogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Get the current S3 service logging level.", + "schema": { + "$ref": "#/definitions/v10S3LogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Set the current S3 service logging level.", + "operationId": "updateProtocolsv10S3LogLevel", + "parameters": [ + { + "in": "body", + "name": "v10S3LogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3LogLevel" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/10/protocols/s3/mykeys": { + "delete": { + "description": "Delete secret key information.", + "operationId": "deleteProtocolsv10S3Mykeys", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Get user secret key information.", + "operationId": "listProtocolsv10S3Mykeys", + "parameters": [], + "responses": { + "200": { + "description": "Get user secret key information.", + "schema": { + "$ref": "#/definitions/Createv10S3KeyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Generate a new secret key/access ID.", + "operationId": "createProtocolsv10S3Mykey", + "parameters": [ + { + "description": "Forces to create new key.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v10S3Mykey", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3Key" + } + } + ], + "responses": { + "200": { + "description": "Generate a new secret key/access ID.", + "schema": { + "$ref": "#/definitions/Createv10S3KeyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/10/protocols/s3/settings/global": { + "get": { + "description": "Retrieve global S3 bucket settings.", + "operationId": "getProtocolsv10S3SettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve global S3 bucket settings.", + "schema": { + "$ref": "#/definitions/v10S3SettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify global S3 bucket settings.", + "operationId": "updateProtocolsv10S3SettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v10S3SettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3SettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/10/protocols/s3/settings/zone": { + "get": { + "description": "Retrieve the S3 bucket settings for this zone.", + "operationId": "getProtocolsv10S3SettingsZone", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the S3 bucket settings for this zone.", + "schema": { + "$ref": "#/definitions/v10S3SettingsZone" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the S3 bucket settings for this zone.", + "operationId": "updateProtocolsv10S3SettingsZone", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v10S3SettingsZone", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3SettingsZoneSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/10/snapshot/changelists/{Changelist}/diff-regions/{v10ChangelistsChangelistDiffRegionId}": { + "get": { + "description": "Get snap diff regions of a file.", + "operationId": "getSnapshotv10ChangelistsChangelistDiffRegion", + "parameters": [ + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 100000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "Get snap diff regions of a file.", + "in": "path", + "name": "v10ChangelistsChangelistDiffRegionId", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Changelist", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get snap diff regions of a file.", + "schema": { + "$ref": "#/definitions/v10ChangelistsChangelistDiffRegions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/10/snapshot/changelists/{Changelist}/entries": { + "get": { + "description": "Get entries from a changelist.", + "operationId": "getSnapshotChangelistsv10ChangelistEntries", + "parameters": [ + { + "description": "Include snapshot diff regions in entry output.", + "in": "query", + "name": "diff_regions", + "required": false, + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2048, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Changelist", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get entries from a changelist.", + "schema": { + "$ref": "#/definitions/v10ChangelistEntries" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SnapshotChangelists" + ] + } + }, + "/platform/10/snapshot/changelists/{Changelist}/entries/{v10ChangelistsChangelistEntryId}": { + "get": { + "description": "Get a single entry from the changelist.", + "operationId": "getSnapshotv10ChangelistsChangelistEntry", + "parameters": [ + { + "description": "Get a single entry from the changelist.", + "in": "path", + "name": "v10ChangelistsChangelistEntryId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Changelist", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a single entry from the changelist.", + "schema": { + "$ref": "#/definitions/v10ChangelistsChangelistEntries" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/10/statistics/summary/workload": { + "get": { + "description": "Description for Statistics10 v10Summary Workload", + "operationId": "getStatisticsv10SummaryWorkload", + "parameters": [ + { + "description": "A comma separated list. Only report statistics for groups specified by Group Security IDs, if configured. ", + "in": "query", + "name": "group_sids", + "type": "string" + }, + { + "description": "Do not resolve addresses and usernames to their human readable form(s). Default is false. ", + "in": "query", + "name": "numeric", + "type": "boolean" + }, + { + "description": "A comma separated list. Only report statistics for exports specified by id, if configured. ", + "in": "query", + "name": "export_ids", + "type": "string" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "A comma separated list. Only report statistics for remote clients specified by resolved names, if configured. ", + "in": "query", + "name": "remote_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for shares specified by name, if configured. ", + "in": "query", + "name": "share_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for paths specified by name, if configured. ", + "in": "query", + "name": "paths", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by resolved names, if configured. ", + "in": "query", + "name": "usernames", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for remote clients specified by IP addresses, if configured. ", + "in": "query", + "name": "remote_addresses", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for job(s) specified by type, if configured. ", + "in": "query", + "items": { + "type": "string" + }, + "name": "job_types", + "type": "array" + }, + { + "description": "A comma separated list. Only report statistics for users in zone specified by id, if configured. ", + "in": "query", + "name": "zone_ids", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for groups specified by resolved names, if configured. ", + "in": "query", + "name": "groupnames", + "type": "string" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "Sort data by the specified comma-separated field(s). ( node | workload_id | system_name | user_id | user_sid | username | group_id | group_sid | groupname | domain_id | path | zone_id | zone_name | export_id | local_addr | local_name | remote_addr | remote_name | protocol | share_name | job_type | cpu | bytes_in | bytes_out | ops | reads | writes | l2 | l3 | latency_read | latency_write | latency_other | error). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for domains specified by id, if configured. ", + "in": "query", + "name": "domain_ids", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users in zone specified by name, if configured. ", + "in": "query", + "name": "zone_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for local hosts specified by resolved names, if configured. ", + "in": "query", + "name": "local_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by numeric UIDs, if configured. ", + "in": "query", + "name": "user_ids", + "type": "string" + }, + { + "description": "A comma separated list specifying what should be unique. (node | system_name | user_id | user_sid | username | zone_id | zone_name | local_addr | local_name | remote_addr | remote_name | group_id | group_sid | groupname | domain_id | path | export_id | protocol | share_name | job_type). Aggregation is performed over all the fields not specified in the list.", + "in": "query", + "name": "totalby", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for local hosts specified by IP addresses, if configured. ", + "in": "query", + "name": "local_addresses", + "type": "string" + }, + { + "description": "Report workload performance metrics for specified dataset. Default is 'System'.", + "in": "query", + "name": "dataset", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by Security IDs, if configured. ", + "in": "query", + "name": "user_sids", + "type": "string" + }, + { + "description": "A comma separated list. Default is all. (smb1, smb2, nfs3, nfs4 and s3 only at this time.)", + "in": "query", + "name": "protocols", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for groups specified by numeric GIDs, if configured. ", + "in": "query", + "name": "group_ids", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "A comma separated list. Only report statistics for systems specified by resolved names, if configured. ", + "in": "query", + "name": "system_names", + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v10SummaryWorkload" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/10/storagepool/nodetypes/{Nid}/assess": { + "get": { + "description": "Assess nodepools for modifying node type.", + "operationId": "getStoragepoolNodetypesv10NodetypeAssess", + "parameters": [ + { + "in": "path", + "name": "Nid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Assess nodepools for modifying node type.", + "schema": { + "$ref": "#/definitions/v10NodetypeAssess" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "StoragepoolNodetypes" + ] + } + }, + "/platform/10/upgrade/cluster/firmware/assess": { + "post": { + "description": "Start firmware upgrade assessment on cluster.", + "operationId": "createUpgradev10ClusterFirmwareAssessItem", + "parameters": [ + { + "in": "body", + "name": "v10ClusterFirmwareAssessItem", + "required": true, + "schema": { + "$ref": "#/definitions/v10ClusterFirmwareAssessItem" + } + } + ], + "responses": { + "200": { + "description": "Start firmware upgrade assessment on cluster.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/10/upgrade/cluster/firmware/device": { + "get": { + "description": "The firmware status for the cluster.", + "operationId": "getUpgradev10ClusterFirmwareDevice", + "parameters": [ + { + "description": "Re-gather firmware status. Default is false.", + "in": "query", + "name": "refresh", + "type": "boolean" + }, + { + "description": "Show devices. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "devices", + "type": "boolean" + }, + { + "description": "Show package. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "package", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The firmware status for the cluster.", + "schema": { + "$ref": "#/definitions/v10ClusterFirmwareDevice" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/10/upgrade/cluster/firmware/status": { + "get": { + "description": "The firmware status for the cluster.", + "operationId": "getUpgradev10ClusterFirmwareStatus", + "parameters": [ + { + "description": "Re-gather firmware status. Default is false.", + "in": "query", + "name": "refresh", + "type": "boolean" + }, + { + "description": "Show devices. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "devices", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The firmware status for the cluster.", + "schema": { + "$ref": "#/definitions/v10ClusterFirmwareStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/10/upgrade/cluster/firmware/upgrade": { + "post": { + "description": "The settings necessary to start a firmware upgrade.", + "operationId": "createUpgradev10ClusterFirmwareUpgradeItem", + "parameters": [ + { + "in": "body", + "name": "v10ClusterFirmwareUpgradeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v10ClusterFirmwareUpgradeItem" + } + } + ], + "responses": { + "200": { + "description": "The settings necessary to start a firmware upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/10/upgrade/cluster/nodes/{Lnn}/firmware/device": { + "get": { + "description": "The firmware status for the node.", + "operationId": "getUpgradeClusterv10NodesNodeFirmwareDevice", + "parameters": [ + { + "description": "Show devices. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "devices", + "type": "boolean" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "The firmware status for the node.", + "schema": { + "$ref": "#/definitions/v10NodesNodeFirmwareDevice" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "UpgradeCluster" + ] + } + }, + "/platform/10/upgrade/cluster/nodes/{Lnn}/firmware/status": { + "get": { + "description": "The firmware status for the node.", + "operationId": "getUpgradeClusterv10NodesNodeFirmwareStatus", + "parameters": [ + { + "description": "Show devices. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "devices", + "type": "boolean" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "The firmware status for the node.", + "schema": { + "$ref": "#/definitions/v10NodesNodeFirmwareDevice" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "UpgradeCluster" + ] + } + }, + "/platform/11/antivirus/reports/scans": { + "delete": { + "description": "Delete antivirus scan reports, and any threat reports associated with those scans.", + "operationId": "deleteAntivirusv11ReportsScans", + "parameters": [ + { + "description": "An amount of time in seconds. If present, only reports older than this age are deleted.", + "in": "query", + "name": "age", + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "List antivirus scan reports.", + "operationId": "getAntivirusv11ReportsScans", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If present, only scan reports with this status will be returned.", + "enum": [ + "Finish", + "Succeeded", + "Failed", + "Cancelled", + "Started", + "Paused", + "Resumed", + "Pending" + ], + "in": "query", + "name": "status", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "If present, only reports for scans associated with this policy will be returned.", + "in": "query", + "name": "policy_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List antivirus scan reports.", + "schema": { + "$ref": "#/definitions/v11ReportsScans" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/11/antivirus/reports/scans/{v11ReportsScanId}": { + "delete": { + "description": "Delete one antivirus scan report, and all of its associated threat reports.", + "operationId": "deleteAntivirusv11ReportsScan", + "parameters": [ + { + "description": "Delete one antivirus scan report, and all of its associated threat reports.", + "in": "path", + "name": "v11ReportsScanId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "Retrieve one antivirus scan report.", + "operationId": "getAntivirusv11ReportsScan", + "parameters": [ + { + "description": "Retrieve one antivirus scan report.", + "in": "path", + "name": "v11ReportsScanId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus scan report.", + "schema": { + "$ref": "#/definitions/v11ReportsScansExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/11/antivirus/scan": { + "post": { + "description": "Manually scan a file.", + "operationId": "createAntivirusv11AntivirusScanItem", + "parameters": [ + { + "in": "body", + "name": "v11AntivirusScanItem", + "required": true, + "schema": { + "$ref": "#/definitions/v11AntivirusScanItem" + } + } + ], + "responses": { + "200": { + "description": "Manually scan a file.", + "schema": { + "$ref": "#/definitions/Createv11AntivirusScanItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/11/audit/logs": { + "delete": { + "description": "Manually delete audit log files.", + "operationId": "deleteAuditv11AuditLogs", + "parameters": [ + { + "description": "Do not ask for confirmation.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "The timestamp before which logs will be deleted.", + "in": "query", + "name": "before", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "get": { + "description": "Get the manual deletion status.", + "operationId": "getAuditv11AuditLogs", + "parameters": [], + "responses": { + "200": { + "description": "Get the manual deletion status.", + "schema": { + "$ref": "#/definitions/v11AuditLogs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/11/audit/settings/global": { + "get": { + "description": "View global audit settings.", + "operationId": "getAuditv11SettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "View global audit settings.", + "schema": { + "$ref": "#/definitions/v11SettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "put": { + "description": "Modify global audit settings.", + "operationId": "updateAuditv11SettingsGlobal", + "parameters": [ + { + "description": "Do not ask for confirmation.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v11SettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v11SettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/11/auth/providers/ldap": { + "get": { + "description": "List all LDAP providers.", + "operationId": "listAuthv11ProvidersLdap", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all LDAP providers.", + "schema": { + "$ref": "#/definitions/v11ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new LDAP provider.", + "operationId": "createAuthv11ProvidersLdapItem", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v11ProvidersLdapItem", + "required": true, + "schema": { + "$ref": "#/definitions/v11ProvidersLdapItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new LDAP provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/11/auth/providers/ldap/{v11ProvidersLdapId}": { + "delete": { + "description": "Delete the LDAP provider.", + "operationId": "deleteAuthv11ProvidersLdapById", + "parameters": [ + { + "description": "Delete the LDAP provider.", + "in": "path", + "name": "v11ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the LDAP provider.", + "operationId": "getAuthv11ProvidersLdapById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the LDAP provider.", + "in": "path", + "name": "v11ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the LDAP provider.", + "schema": { + "$ref": "#/definitions/v11ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the LDAP provider.", + "operationId": "updateAuthv11ProvidersLdapById", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v11ProvidersLdapIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v11ProvidersLdapIdParams" + } + }, + { + "description": "Modify the LDAP provider.", + "in": "path", + "name": "v11ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/11/auth/providers/summary": { + "get": { + "description": "Retrieve the summary information.", + "operationId": "getAuthv11ProvidersSummary", + "parameters": [ + { + "description": "Filter providers by groupnet.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "Filter providers by zone.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the summary information.", + "schema": { + "$ref": "#/definitions/v11ProvidersSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/11/auth/settings/acls": { + "get": { + "description": "Retrieve the ACL policy settings and preset configurations.", + "operationId": "getAuthv11SettingsAcls", + "parameters": [ + { + "description": "If specified the preset configuration values for all applicable ACL policies are returned.", + "enum": [ + "balanced", + "unix", + "windows" + ], + "in": "query", + "name": "preset", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ACL policy settings and preset configurations.", + "schema": { + "$ref": "#/definitions/v11SettingsAcls" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify cluster ACL policy settings.", + "operationId": "updateAuthv11SettingsAcls", + "parameters": [ + { + "in": "body", + "name": "v11SettingsAcls", + "required": true, + "schema": { + "$ref": "#/definitions/v11SettingsAclsAclPolicySettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/11/avscan/filters": { + "get": { + "description": "List Antivirus filters for zones.", + "operationId": "getAvscanv11AvscanFilters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List Antivirus filters for zones.", + "schema": { + "$ref": "#/definitions/v11AvscanFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + } + }, + "/platform/11/avscan/filters/{v11AvscanFilterId}": { + "get": { + "description": "Retrieve one antivirus filter setting.", + "operationId": "getAvscanv11AvscanFilter", + "parameters": [ + { + "description": "Retrieve one antivirus filter setting.", + "in": "path", + "name": "v11AvscanFilterId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus filter setting.", + "schema": { + "$ref": "#/definitions/v11AvscanFiltersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "put": { + "description": "Modify an antivirus filter setting.", + "operationId": "updateAvscanv11AvscanFilter", + "parameters": [ + { + "in": "body", + "name": "v11AvscanFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v11AvscanFilterExtended" + } + }, + { + "description": "Modify an antivirus filter setting.", + "in": "path", + "name": "v11AvscanFilterId", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + } + }, + "/platform/11/avscan/jobs": { + "delete": { + "description": "Delete all antivirus jobs.", + "operationId": "deleteAvscanv11AvscanJobs", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "get": { + "description": "List Antivirus jobs.", + "operationId": "listAvscanv11AvscanJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List Antivirus jobs.", + "schema": { + "$ref": "#/definitions/v11AvscanJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "post": { + "description": "Create new antivirus jobs.", + "operationId": "createAvscanv11AvscanJob", + "parameters": [ + { + "in": "body", + "name": "v11AvscanJob", + "required": true, + "schema": { + "$ref": "#/definitions/v11AvscanJob" + } + } + ], + "responses": { + "200": { + "description": "Create new antivirus jobs.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + } + }, + "/platform/11/avscan/jobs/{v11AvscanJobId}": { + "delete": { + "description": "Delete an antivirus job entry.", + "operationId": "deleteAvscanv11AvscanJob", + "parameters": [ + { + "description": "Delete an antivirus job entry.", + "in": "path", + "name": "v11AvscanJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "get": { + "description": "Retrieve one antivirus job entry.", + "operationId": "getAvscanv11AvscanJob", + "parameters": [ + { + "description": "Retrieve one antivirus job entry.", + "in": "path", + "name": "v11AvscanJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus job entry.", + "schema": { + "$ref": "#/definitions/v11AvscanJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "put": { + "description": "Modify an antivirus job entry.", + "operationId": "updateAvscanv11AvscanJob", + "parameters": [ + { + "in": "body", + "name": "v11AvscanJob", + "required": true, + "schema": { + "$ref": "#/definitions/v11AvscanJobExtendedExtended" + } + }, + { + "description": "Modify an antivirus job entry.", + "in": "path", + "name": "v11AvscanJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + } + }, + "/platform/11/avscan/nodes/{Lnn}/status": { + "get": { + "description": "View CAVA Antivirus status.", + "operationId": "getAvscanNodesv11NodeStatus", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "View CAVA Antivirus status.", + "schema": { + "$ref": "#/definitions/v11NodeStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AvscanNodes" + ] + } + }, + "/platform/11/avscan/servers": { + "delete": { + "description": "Delete all antivirus servers.", + "operationId": "deleteAvscanv11AvscanServers", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "get": { + "description": "List Antivirus servers.", + "operationId": "listAvscanv11AvscanServers", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List Antivirus servers.", + "schema": { + "$ref": "#/definitions/v11AvscanServers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "post": { + "description": "Create new antivirus servers.", + "operationId": "createAvscanv11AvscanServer", + "parameters": [ + { + "in": "body", + "name": "v11AvscanServer", + "required": true, + "schema": { + "$ref": "#/definitions/v11AvscanServer" + } + } + ], + "responses": { + "200": { + "description": "Create new antivirus servers.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + } + }, + "/platform/11/avscan/servers/{v11AvscanServerId}": { + "delete": { + "description": "Delete an antivirus server entry.", + "operationId": "deleteAvscanv11AvscanServer", + "parameters": [ + { + "description": "Delete an antivirus server entry.", + "in": "path", + "name": "v11AvscanServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "get": { + "description": "Retrieve one antivirus server entry.", + "operationId": "getAvscanv11AvscanServer", + "parameters": [ + { + "description": "Retrieve one antivirus server entry.", + "in": "path", + "name": "v11AvscanServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus server entry.", + "schema": { + "$ref": "#/definitions/v11AvscanServersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "put": { + "description": "Modify an antivirus server entry.", + "operationId": "updateAvscanv11AvscanServer", + "parameters": [ + { + "in": "body", + "name": "v11AvscanServer", + "required": true, + "schema": { + "$ref": "#/definitions/v11AvscanServerExtendedExtended" + } + }, + { + "description": "Modify an antivirus server entry.", + "in": "path", + "name": "v11AvscanServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + } + }, + "/platform/11/avscan/settings": { + "get": { + "description": "View Antivirus settings.", + "operationId": "getAvscanv11AvscanSettings", + "parameters": [], + "responses": { + "200": { + "description": "View Antivirus settings.", + "schema": { + "$ref": "#/definitions/v11AvscanSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + }, + "put": { + "description": "Modify Antivirus settings.", + "operationId": "updateAvscanv11AvscanSettings", + "parameters": [ + { + "in": "body", + "name": "v11AvscanSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v11AvscanSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Avscan" + ] + } + }, + "/platform/11/event/thresholds": { + "get": { + "description": "List all configurable event thresholds", + "operationId": "getEventv11EventThresholds", + "parameters": [ + { + "description": "Return thresholds for the specified event id", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "event_id", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all configurable event thresholds", + "schema": { + "$ref": "#/definitions/v11EventThresholds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/11/event/thresholds/{v11EventThresholdId}": { + "get": { + "description": "List all configurable event thresholds", + "operationId": "getEventv11EventThreshold", + "parameters": [ + { + "description": "Return thresholds for the specified event id", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "event_id", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "List all configurable event thresholds", + "in": "path", + "name": "v11EventThresholdId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all configurable event thresholds", + "schema": { + "$ref": "#/definitions/v11EventThresholds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify event thresholds.", + "operationId": "updateEventv11EventThreshold", + "parameters": [ + { + "in": "body", + "name": "v11EventThreshold", + "required": true, + "schema": { + "$ref": "#/definitions/v11EventThresholdExtended" + } + }, + { + "description": "Modify event thresholds.", + "in": "path", + "name": "v11EventThresholdId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/11/license/activation": { + "get": { + "description": "Return the current the current phase of the activation process.", + "operationId": "listLicensev11LicenseActivation", + "parameters": [], + "responses": { + "200": { + "description": "Return the current the current phase of the activation process.", + "schema": { + "$ref": "#/definitions/v11LicenseActivation" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + }, + "post": { + "description": "Start or cancel an activation.", + "operationId": "createLicensev11LicenseActivationItem", + "parameters": [ + { + "in": "body", + "name": "v11LicenseActivationItem", + "required": true, + "schema": { + "$ref": "#/definitions/v11LicenseActivationItem" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + } + }, + "/platform/11/protocols/hdfs/settings/global": { + "get": { + "description": "Retrieve HDFS global settings.", + "operationId": "getProtocolsv11HdfsSettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve HDFS global settings.", + "schema": { + "$ref": "#/definitions/v11HdfsSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS global settings.", + "operationId": "updateProtocolsv11HdfsSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v11HdfsSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v11HdfsSettingsGlobalGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/11/protocols/nfs/exports/{v11NfsExportId}": { + "delete": { + "description": "Delete the export.", + "operationId": "deleteProtocolsv11NfsExport", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the export.", + "in": "path", + "name": "v11NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve export information.", + "operationId": "getProtocolsv11NfsExport", + "parameters": [ + { + "description": "When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve export information.", + "in": "path", + "name": "v11NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve export information.", + "schema": { + "$ref": "#/definitions/v11NfsExports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the export. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv11NfsExport", + "parameters": [ + { + "description": "If true, the export will be updated even if that change conflicts with another export.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Ignore unresolvable hosts.", + "in": "query", + "name": "ignore_unresolvable_hosts", + "type": "boolean" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Ignore conflicts with existing exports.", + "in": "query", + "name": "ignore_conflicts", + "type": "boolean" + }, + { + "description": "Ignore nonexistent or otherwise bad paths.", + "in": "query", + "name": "ignore_bad_paths", + "type": "boolean" + }, + { + "description": "Ignore invalid users.", + "in": "query", + "name": "ignore_bad_auth", + "type": "boolean" + }, + { + "in": "body", + "name": "v11NfsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v11NfsExport" + } + }, + { + "description": "Modify the export. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v11NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/11/protocols/smb/sessions": { + "get": { + "description": "List open SMB sessions.", + "operationId": "getProtocolsv11SmbSessions", + "parameters": [ + { + "description": "The node to fetch open sessions from.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "When parameter lnn=all, don't fetch open session info from this node.", + "in": "query", + "name": "lnn_skip", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List open SMB sessions.", + "schema": { + "$ref": "#/definitions/v11SmbSessions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/11/upgrade/cluster/patch/patches": { + "get": { + "description": "List all patches.", + "operationId": "listUpgradev11ClusterPatchPatches", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Path location of patch file.", + "in": "query", + "maxLength": 4096, + "minLength": 0, + "name": "location", + "type": "string" + }, + { + "description": "View patches on the local node only.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all patches.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatches" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "post": { + "description": "Install a patch.", + "operationId": "createUpgradev11ClusterPatchPatch", + "parameters": [ + { + "description": "Bypass conflict checks. Defaults to false.", + "in": "query", + "name": "skip_conflict_check", + "type": "boolean" + }, + { + "description": "Bypass restricted checks. Defaults to false.", + "in": "query", + "name": "skip_restricted_check", + "type": "boolean" + }, + { + "description": "Bypass dependency checks. Defaults to false.", + "in": "query", + "name": "skip_dependency_check", + "type": "boolean" + }, + { + "description": "Bypass version checks. Defaults to false.", + "in": "query", + "name": "skip_version_check", + "type": "boolean" + }, + { + "description": "Process type can be 'simultaneous', 'rolling', or 'parallel'.", + "in": "query", + "maxLength": 255, + "minLength": 6, + "name": "process_type", + "type": "string" + }, + { + "in": "body", + "name": "v11ClusterPatchPatch", + "required": true, + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatch" + } + } + ], + "responses": { + "200": { + "description": "Install a patch.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/11/upgrade/cluster/patch/patches/{v11ClusterPatchPatchId}": { + "delete": { + "description": "Uninstall a patch.", + "operationId": "deleteUpgradev11ClusterPatchPatch", + "parameters": [ + { + "description": "Bypass conflict checks. Defaults to false.", + "in": "query", + "name": "skip_conflict_check", + "type": "boolean" + }, + { + "description": "Bypass restricted checks. Defaults to false.", + "in": "query", + "name": "skip_restricted_check", + "type": "boolean" + }, + { + "description": "Bypass dependency checks. Defaults to false.", + "in": "query", + "name": "skip_dependency_check", + "type": "boolean" + }, + { + "description": "Bypass version checks. Defaults to false.", + "in": "query", + "name": "skip_version_check", + "type": "boolean" + }, + { + "description": "Process type can be 'simultaneous', 'rolling', or 'parallel'", + "in": "query", + "maxLength": 255, + "minLength": 6, + "name": "process_type", + "type": "string" + }, + { + "description": "Uninstall a patch.", + "in": "path", + "name": "v11ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "get": { + "description": "View a single patch.", + "operationId": "getUpgradev11ClusterPatchPatch", + "parameters": [ + { + "description": "View patch information on local node only.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "Path location of patch file.", + "in": "query", + "maxLength": 4096, + "minLength": 0, + "name": "location", + "type": "string" + }, + { + "description": "View a single patch.", + "in": "path", + "name": "v11ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single patch.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatchesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/auth/log-level": { + "get": { + "description": "Get the current authentications service and netlogon logging level.", + "operationId": "getAuthv12AuthLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Get the current authentications service and netlogon logging level.", + "schema": { + "$ref": "#/definitions/v12AuthLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Set the current authentication service and netlogon logging level.", + "operationId": "updateAuthv12AuthLogLevel", + "parameters": [ + { + "in": "body", + "name": "v12AuthLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v12AuthLogLevelExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/12/auth/providers/ads/{Id}/search": { + "post": { + "description": "Retrieve search results via HTTP POST.", + "operationId": "createAuthProvidersv12AdsProviderSearchItem", + "parameters": [ + { + "in": "body", + "name": "v12AdsProviderSearchItem", + "required": true, + "schema": { + "$ref": "#/definitions/v12AdsProviderSearchItem" + } + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve search results via HTTP POST.", + "schema": { + "$ref": "#/definitions/Createv12AdsProviderSearchItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthProviders" + ] + } + }, + "/platform/12/cluster/nodes": { + "get": { + "description": "List the nodes on this cluster.", + "operationId": "getClusterv12ClusterNodes", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + } + ], + "responses": { + "200": { + "description": "List the nodes on this cluster.", + "schema": { + "$ref": "#/definitions/v12ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/12/cluster/nodes/{Lnn}/hardware": { + "get": { + "description": "Retrieve node hardware identity information.", + "operationId": "getClusterNodesv12NodeHardware", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node hardware identity information.", + "schema": { + "$ref": "#/definitions/v12NodeHardware" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/12/cluster/nodes/{Lnn}/state": { + "get": { + "description": "Retrieve node state information.", + "operationId": "getClusterNodesv12NodeState", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node state information.", + "schema": { + "$ref": "#/definitions/v12NodeState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/12/cluster/nodes/{Lnn}/state/servicelight": { + "get": { + "description": "Retrieve node service light state information.", + "operationId": "getClusterNodesv12NodeStateServicelight", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node service light state information.", + "schema": { + "$ref": "#/definitions/v12NodeStateServicelight" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "put": { + "description": "Modify one or more node service light state settings.", + "operationId": "updateClusterNodesv12NodeStateServicelight", + "parameters": [ + { + "in": "body", + "name": "v12NodeStateServicelight", + "required": true, + "schema": { + "$ref": "#/definitions/v12NodeStateServicelightExtended" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/12/cluster/nodes/{Lnn}/status": { + "get": { + "description": "Retrieve node status information.", + "operationId": "getClusterNodesv12NodeStatus", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node status information.", + "schema": { + "$ref": "#/definitions/v12NodeStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/12/cluster/nodes/{Lnn}/status/nvram": { + "get": { + "description": "Retrieve node NVRAM status information.", + "operationId": "getClusterNodesv12NodeStatusNvram", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node NVRAM status information.", + "schema": { + "$ref": "#/definitions/v12NodeStatusNvram" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/12/cluster/nodes/{Lnn}/status/powersupplies": { + "get": { + "description": "Retrieve node power supplies status information.", + "operationId": "getClusterNodesv12NodeStatusPowersupplies", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node power supplies status information.", + "schema": { + "$ref": "#/definitions/v12NodeStatusPowersupplies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/12/cluster/nodes/{v12ClusterNodeId}": { + "get": { + "description": "Retrieve node information.", + "operationId": "getClusterv12ClusterNode", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve node information.", + "in": "path", + "name": "v12ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node information.", + "schema": { + "$ref": "#/definitions/v12ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/12/config/exports": { + "get": { + "description": "List all config export tasks.", + "operationId": "listConfigv12ConfigExports", + "parameters": [], + "responses": { + "200": { + "description": "List all config export tasks.", + "schema": { + "$ref": "#/definitions/v12ConfigExports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Config" + ] + }, + "post": { + "description": "Create a new config export task.", + "operationId": "createConfigv12ConfigExport", + "parameters": [ + { + "in": "body", + "name": "v12ConfigExport", + "required": true, + "schema": { + "$ref": "#/definitions/v12ConfigExport" + } + } + ], + "responses": { + "200": { + "description": "Create a new config export task.", + "schema": { + "$ref": "#/definitions/Createv12ConfigExportResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Config" + ] + } + }, + "/platform/12/config/exports/{v12ConfigExportId}": { + "get": { + "description": "Retrieve export task information.", + "operationId": "getConfigv12ConfigExport", + "parameters": [ + { + "description": "Retrieve export task information.", + "in": "path", + "name": "v12ConfigExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve export task information.", + "schema": { + "$ref": "#/definitions/v12ConfigExports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Config" + ] + } + }, + "/platform/12/config/imports": { + "get": { + "description": "List all config import tasks.", + "operationId": "listConfigv12ConfigImports", + "parameters": [], + "responses": { + "200": { + "description": "List all config import tasks.", + "schema": { + "$ref": "#/definitions/v12ConfigImports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Config" + ] + }, + "post": { + "description": "Create a new config import task.", + "operationId": "createConfigv12ConfigImport", + "parameters": [ + { + "in": "body", + "name": "v12ConfigImport", + "required": true, + "schema": { + "$ref": "#/definitions/v12ConfigImport" + } + } + ], + "responses": { + "200": { + "description": "Create a new config import task.", + "schema": { + "$ref": "#/definitions/Createv12ConfigImportResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Config" + ] + } + }, + "/platform/12/config/imports/{v12ConfigImportId}": { + "get": { + "description": "Retrieve import task information.", + "operationId": "getConfigv12ConfigImport", + "parameters": [ + { + "description": "Retrieve import task information.", + "in": "path", + "name": "v12ConfigImportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve import task information.", + "schema": { + "$ref": "#/definitions/v12ConfigImports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Config" + ] + } + }, + "/platform/12/event/channels": { + "get": { + "description": "List all channels.", + "operationId": "listEventv12EventChannels", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all channels.", + "schema": { + "$ref": "#/definitions/v12EventChannelsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "post": { + "description": "Create a new channel.", + "operationId": "createEventv12EventChannels", + "parameters": [ + { + "in": "body", + "name": "v12EventChannels", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventChannels" + } + } + ], + "responses": { + "200": { + "description": "Create a new channel.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/channels/{v12EventChannelId}": { + "delete": { + "description": "Delete the channel.", + "operationId": "deleteEventv12EventChannel", + "parameters": [ + { + "description": "Delete the channel.", + "in": "path", + "name": "v12EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "Retrieve the channel.", + "operationId": "getEventv12EventChannel", + "parameters": [ + { + "description": "Retrieve the channel.", + "in": "path", + "name": "v12EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the channel.", + "schema": { + "$ref": "#/definitions/v12EventChannelsExtendedExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "post": { + "description": "Send a test message to the channel.", + "operationId": "createEventv12EventChannel", + "parameters": [ + { + "in": "body", + "name": "v12EventChannel", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "description": "Send a test message to the channel.", + "in": "path", + "name": "v12EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify the channel.", + "operationId": "updateEventv12EventChannel", + "parameters": [ + { + "in": "body", + "name": "v12EventChannel", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventChannelExtended" + } + }, + { + "description": "Modify the channel.", + "in": "path", + "name": "v12EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/eventgroup-definitions": { + "get": { + "description": "List all eventgroup definitions.", + "operationId": "getEventv12EventEventgroupDefinitions", + "parameters": [ + { + "description": "Return eventgroups in the specified category.", + "in": "query", + "name": "category", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Include alert rules and channels in output.", + "in": "query", + "name": "alert_info", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List all eventgroup definitions.", + "schema": { + "$ref": "#/definitions/v12EventEventgroupDefinitions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/eventgroup-definitions/{v12EventEventgroupDefinitionId}": { + "get": { + "description": "Retrieve the eventgroup definition.", + "operationId": "getEventv12EventEventgroupDefinition", + "parameters": [ + { + "description": "Include alert rules and channels in output.", + "in": "query", + "name": "alert_info", + "type": "boolean" + }, + { + "description": "Retrieve the eventgroup definition.", + "in": "path", + "name": "v12EventEventgroupDefinitionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the eventgroup definition.", + "schema": { + "$ref": "#/definitions/v12EventEventgroupDefinitionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/eventgroup-occurrences": { + "get": { + "description": "List all eventgroup occurrences.", + "operationId": "getEventv12EventEventgroupOccurrences", + "parameters": [ + { + "description": "Filter by resolved eventgroups.", + "in": "query", + "name": "resolved", + "type": "boolean" + }, + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Events that are in progress after this time.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Events that were in progress before this time.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Filter by eventgroup resolver.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "resolver", + "type": "string" + }, + { + "description": "Events for which event_count > this.", + "in": "query", + "name": "event_count", + "type": "integer" + }, + { + "description": "Filter by severity.", + "in": "query", + "items": { + "enum": [ + "information", + "warning", + "critical", + "emergency" + ], + "type": "string" + }, + "name": "severity", + "type": "array" + }, + { + "description": "Filter by devid.", + "in": "query", + "items": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": "devid", + "type": "array" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter by ignored eventgroups.", + "in": "query", + "name": "ignore", + "type": "boolean" + }, + { + "description": "Filter eventgroups by those that have last_event before this time.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "last_event_end", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter by partial long-cause description.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "partial_cause_long", + "type": "string" + }, + { + "description": "Filter by eventgroups created during maintenance mode.", + "in": "query", + "name": "maintenance", + "type": "boolean" + }, + { + "description": "Filter by partial eventgroup id.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "partial_eventgroup_id", + "type": "string" + }, + { + "description": "Filter eventgroups by there associated event's event-type number.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "partial_event_type", + "type": "string" + }, + { + "description": "Filter by cause.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "cause", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Filter eventgroups by those that have last_event after this time.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "last_event_begin", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List all eventgroup occurrences.", + "schema": { + "$ref": "#/definitions/v12EventEventgroupOccurrences" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify all eventgroup occurrences, resolve or ignore all.", + "operationId": "updateEventv12EventEventgroupOccurrences", + "parameters": [ + { + "in": "body", + "name": "v12EventEventgroupOccurrences", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventEventgroupOccurrencesExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/eventgroup-occurrences/{v12EventEventgroupOccurrenceId}": { + "get": { + "description": "Retrieve individual eventgroup occurrence.", + "operationId": "getEventv12EventEventgroupOccurrence", + "parameters": [ + { + "description": "Retrieve individual eventgroup occurrence.", + "in": "path", + "name": "v12EventEventgroupOccurrenceId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve individual eventgroup occurrence.", + "schema": { + "$ref": "#/definitions/v12EventEventgroupOccurrencesExtendedExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify eventgroup occurrence.", + "operationId": "updateEventv12EventEventgroupOccurrence", + "parameters": [ + { + "in": "body", + "name": "v12EventEventgroupOccurrence", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventEventgroupOccurrencesExtended" + } + }, + { + "description": "Modify eventgroup occurrence.", + "in": "path", + "name": "v12EventEventgroupOccurrenceId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/maintenance": { + "get": { + "description": "List maintenance mode history.", + "operationId": "getEventv12EventMaintenance", + "parameters": [ + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "True to list history.", + "in": "query", + "name": "history", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List maintenance mode history.", + "schema": { + "$ref": "#/definitions/v12EventMaintenance" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Perform an action, enable/disable maintenance mode.", + "operationId": "updateEventv12EventMaintenance", + "parameters": [ + { + "in": "body", + "name": "v12EventMaintenance", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventMaintenanceExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/settings": { + "get": { + "description": "Retrieve the settings.", + "operationId": "getEventv12EventSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the settings.", + "schema": { + "$ref": "#/definitions/v12EventSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify settings.", + "operationId": "updateEventv12EventSettings", + "parameters": [ + { + "in": "body", + "name": "v12EventSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/suppress": { + "get": { + "description": "List all event type IDs which are suppressed.", + "operationId": "getEventv12EventSuppress", + "parameters": [], + "responses": { + "200": { + "description": "List all event type IDs which are suppressed.", + "schema": { + "$ref": "#/definitions/v12EventSuppress" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/event/suppress/{v12EventSuppressId}": { + "get": { + "description": "Indicate whether this event type ID is suppressed.", + "operationId": "getEventv12EventSuppressById", + "parameters": [ + { + "description": "Indicate whether this event type ID is suppressed.", + "in": "path", + "name": "v12EventSuppressId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Indicate whether this event type ID is suppressed.", + "schema": { + "$ref": "#/definitions/v12EventSuppressIdParams" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Suppress or un-suppress this event type ID.", + "operationId": "updateEventv12EventSuppressById", + "parameters": [ + { + "in": "body", + "name": "v12EventSuppressIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventSuppressIdParams" + } + }, + { + "description": "Suppress or un-suppress this event type ID.", + "in": "path", + "name": "v12EventSuppressId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/12/filepool/policies": { + "get": { + "description": "List all policies.", + "operationId": "listFilepoolv12FilepoolPolicies", + "parameters": [], + "responses": { + "200": { + "description": "List all policies.", + "schema": { + "$ref": "#/definitions/v12FilepoolPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "post": { + "description": "Create a new policy.", + "operationId": "createFilepoolv12FilepoolPolicy", + "parameters": [ + { + "in": "body", + "name": "v12FilepoolPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v12FilepoolPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a new policy.", + "schema": { + "$ref": "#/definitions/Createv1FilepoolPolicyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/12/filepool/policies/{v12FilepoolPolicyId}": { + "delete": { + "description": "Delete file pool policy.", + "operationId": "deleteFilepoolv12FilepoolPolicy", + "parameters": [ + { + "description": "Delete file pool policy.", + "in": "path", + "name": "v12FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "get": { + "description": "Retrieve file pool policy information.", + "operationId": "getFilepoolv12FilepoolPolicy", + "parameters": [ + { + "description": "Retrieve file pool policy information.", + "in": "path", + "name": "v12FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve file pool policy information.", + "schema": { + "$ref": "#/definitions/v12FilepoolPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "put": { + "description": "Modify file pool policy. All input fields are optional, but one or more must be supplied.", + "operationId": "updateFilepoolv12FilepoolPolicy", + "parameters": [ + { + "in": "body", + "name": "v12FilepoolPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v12FilepoolPolicyExtendedExtended" + } + }, + { + "description": "Modify file pool policy. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v12FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/12/job/job-summary": { + "get": { + "description": "View job engine status.", + "operationId": "getJobv12JobJobSummary", + "parameters": [], + "responses": { + "200": { + "description": "View job engine status.", + "schema": { + "$ref": "#/definitions/v12JobJobSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/12/keymanager/kmip/server/verify": { + "post": { + "description": "Verify KMIP configuration.", + "operationId": "createKeymanagerv12KmipServerVerifyItem", + "parameters": [ + { + "in": "body", + "name": "v12KmipServerVerifyItem", + "required": true, + "schema": { + "$ref": "#/definitions/v12KmipServerVerifyItem" + } + } + ], + "responses": { + "200": { + "description": "Verify KMIP configuration.", + "schema": { + "$ref": "#/definitions/Createv12KmipServerVerifyItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + } + }, + "/platform/12/keymanager/kmip/servers": { + "get": { + "description": "Retrieve a list of configured KMIP server entries.", + "operationId": "listKeymanagerv12KmipServers", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of configured KMIP server entries.", + "schema": { + "$ref": "#/definitions/v12KmipServers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + }, + "post": { + "description": "Create a new KMIP server entry.", + "operationId": "createKeymanagerv12KmipServer", + "parameters": [ + { + "in": "body", + "name": "v12KmipServer", + "required": true, + "schema": { + "$ref": "#/definitions/v12KmipServer" + } + } + ], + "responses": { + "200": { + "description": "Create a new KMIP server entry.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + } + }, + "/platform/12/keymanager/kmip/servers/{v12KmipServerId}": { + "delete": { + "description": "Delete a KMIP server entry.", + "operationId": "deleteKeymanagerv12KmipServer", + "parameters": [ + { + "description": "Delete a KMIP server entry.", + "in": "path", + "name": "v12KmipServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + }, + "get": { + "description": "Retrieve a specific KMIP server entry.", + "operationId": "getKeymanagerv12KmipServer", + "parameters": [ + { + "description": "Retrieve a specific KMIP server entry.", + "in": "path", + "name": "v12KmipServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a specific KMIP server entry.", + "schema": { + "$ref": "#/definitions/v12KmipServersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + }, + "put": { + "description": "Modify a KMIP server entry.", + "operationId": "updateKeymanagerv12KmipServer", + "parameters": [ + { + "in": "body", + "name": "v12KmipServer", + "required": true, + "schema": { + "$ref": "#/definitions/v12KmipServerExtendedExtended" + } + }, + { + "description": "Modify a KMIP server entry.", + "in": "path", + "name": "v12KmipServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + } + }, + "/platform/12/keymanager/sed/migrate": { + "post": { + "description": "Indicates the direction of the migration.", + "operationId": "createKeymanagerv12SedMigrateItem", + "parameters": [ + { + "in": "body", + "name": "v12SedMigrateItem", + "required": true, + "schema": { + "$ref": "#/definitions/v12SedMigrateItem" + } + } + ], + "responses": { + "200": { + "description": "Indicates the direction of the migration.", + "schema": { + "$ref": "#/definitions/Createv12SedMigrateItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + } + }, + "/platform/12/keymanager/sed/settings": { + "get": { + "description": "Retrieve Current SED settings.", + "operationId": "getKeymanagerv12SedSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve Current SED settings.", + "schema": { + "$ref": "#/definitions/v12SedSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + }, + "put": { + "description": "Modify SED settings to allow migration, or forbid it and retrieve all keys.", + "operationId": "updateKeymanagerv12SedSettings", + "parameters": [ + { + "in": "body", + "name": "v12SedSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v12SedSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + } + }, + "/platform/12/keymanager/sed/status": { + "get": { + "description": "Retrieve SED status on all nodes in this cluster.", + "operationId": "getKeymanagerv12SedStatus", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve SED status on all nodes in this cluster.", + "schema": { + "$ref": "#/definitions/v12SedStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + } + }, + "/platform/12/keymanager/sed/status/{v12SedStatusLnn}": { + "get": { + "description": "Retrieve SED status on a node in this cluster.", + "operationId": "getKeymanagerv12SedStatusLnn", + "parameters": [ + { + "description": "Retrieve SED status on a node in this cluster.", + "in": "path", + "name": "v12SedStatusLnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve SED status on a node in this cluster.", + "schema": { + "$ref": "#/definitions/v12SedStatusExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Keymanager" + ] + } + }, + "/platform/12/lfn": { + "delete": { + "description": "Delete all file name length configuration domains, returning to legacy limits.", + "operationId": "deleteLfnv12Lfn", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Lfn" + ] + }, + "get": { + "description": "List all file name length configuration domains.", + "operationId": "listLfnv12Lfn", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all file name length configuration domains.", + "schema": { + "$ref": "#/definitions/v12Lfn" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Lfn" + ] + }, + "post": { + "description": "Create a new file name length configuration domain.", + "operationId": "createLfnv12LfnItem", + "parameters": [ + { + "in": "body", + "name": "v12LfnItem", + "required": true, + "schema": { + "$ref": "#/definitions/v12LfnItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new file name length configuration domain.", + "schema": { + "$ref": "#/definitions/Createv12LfnItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Lfn" + ] + } + }, + "/platform/12/lfn/{v12LfnPath}": { + "delete": { + "description": "Delete the file name length configuration domain that originates at the specified path.", + "operationId": "deleteLfnv12LfnPath", + "parameters": [ + { + "description": "Delete the file name length configuration domain that originates at the specified path.", + "in": "path", + "name": "v12LfnPath", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Lfn" + ] + }, + "get": { + "description": "Retrieve file name length configuration information.", + "operationId": "getLfnv12LfnPath", + "parameters": [ + { + "description": "Retrieve file name length configuration information.", + "in": "path", + "name": "v12LfnPath", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve file name length configuration information.", + "schema": { + "$ref": "#/definitions/v12LfnExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Lfn" + ] + }, + "put": { + "description": "Modify file name length settings if specified path is the root of the configuration. All input fields are optional, but one or more must be supplied.", + "operationId": "updateLfnv12LfnPath", + "parameters": [ + { + "in": "body", + "name": "v12LfnPathParams", + "required": true, + "schema": { + "$ref": "#/definitions/v12LfnPathParams" + } + }, + { + "description": "Modify file name length settings if specified path is the root of the configuration. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v12LfnPath", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Lfn" + ] + } + }, + "/platform/12/network/external": { + "get": { + "description": "View external network settings.", + "operationId": "getNetworkv12NetworkExternal", + "parameters": [], + "responses": { + "200": { + "description": "View external network settings.", + "schema": { + "$ref": "#/definitions/v12NetworkExternal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify external network settings.", + "operationId": "updateNetworkv12NetworkExternal", + "parameters": [ + { + "in": "body", + "name": "v12NetworkExternal", + "required": true, + "schema": { + "$ref": "#/definitions/v12NetworkExternalExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/12/network/groupnets/{Groupnet}/subnets": { + "get": { + "description": "Get a list of subnets.", + "operationId": "listNetworkGroupnetsv12GroupnetSubnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of subnets.", + "schema": { + "$ref": "#/definitions/v12GroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + }, + "post": { + "description": "Create a new subnet.", + "operationId": "createNetworkGroupnetsv12GroupnetSubnet", + "parameters": [ + { + "in": "body", + "name": "v12GroupnetSubnet", + "required": true, + "schema": { + "$ref": "#/definitions/v12GroupnetSubnet" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new subnet.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + } + }, + "/platform/12/network/groupnets/{Groupnet}/subnets/{Subnet}/pools": { + "get": { + "description": "Get a list of network pools.", + "operationId": "listNetworkGroupnetsv12SubnetsSubnetPools", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If specified, only pools with this zone name will be returned.", + "in": "query", + "name": "access_zone", + "type": "string" + }, + { + "description": "If specified, only pools with this allocation type will be returned.", + "enum": [ + "static", + "dynamic" + ], + "in": "query", + "name": "alloc_method", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of network pools.", + "schema": { + "$ref": "#/definitions/v12SubnetsSubnetPools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + }, + "post": { + "description": "Create a new pool.", + "operationId": "createNetworkGroupnetsv12SubnetsSubnetPool", + "parameters": [ + { + "description": "Force creating this pool even if it causes an MTU conflict.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v12SubnetsSubnetPool", + "required": true, + "schema": { + "$ref": "#/definitions/v12SubnetsSubnetPool" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new pool.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + } + }, + "/platform/12/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{v12GroupnetsGroupnetSubnetsSubnetPoolId}": { + "delete": { + "description": "Delete a network pool.", + "operationId": "deleteNetworkv12GroupnetsGroupnetSubnetsSubnetPool", + "parameters": [ + { + "description": "Delete a network pool.", + "in": "path", + "name": "v12GroupnetsGroupnetSubnetsSubnetPoolId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a single network pool.", + "operationId": "getNetworkv12GroupnetsGroupnetSubnetsSubnetPool", + "parameters": [ + { + "description": "View a single network pool.", + "in": "path", + "name": "v12GroupnetsGroupnetSubnetsSubnetPoolId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single network pool.", + "schema": { + "$ref": "#/definitions/v12GroupnetsGroupnetSubnetsSubnetPools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network pool.", + "operationId": "updateNetworkv12GroupnetsGroupnetSubnetsSubnetPool", + "parameters": [ + { + "description": "Force creating this pool even if it causes an MTU conflict.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v12GroupnetsGroupnetSubnetsSubnetPool", + "required": true, + "schema": { + "$ref": "#/definitions/v12GroupnetsGroupnetSubnetsSubnetPool" + } + }, + { + "description": "Modify a network pool.", + "in": "path", + "name": "v12GroupnetsGroupnetSubnetsSubnetPoolId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/12/network/interfaces": { + "get": { + "description": "Get a list of interfaces.", + "operationId": "getNetworkv12NetworkInterfaces", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Show interfaces associated with external and/or internal networks. Default is 'external'", + "enum": [ + "all", + "external", + "internal" + ], + "in": "query", + "name": "network", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Control where interface data is source from. no-cache only returns live data from a running node, and if a node can't be reached, no results will be returned. cache-only only returns cached data, some fields are set as null/unknown if they can't be determined, and IPs listed are the IPs that should be configured. Finally, nodes-first will try to query live nodes, and fall back to the cache for any nodes that fail. Default: nodes-first", + "enum": [ + "cache-only", + "no-cache", + "nodes-first" + ], + "in": "query", + "name": "cache", + "type": "string" + }, + { + "description": "Get a list of interfaces for the specified lnns.", + "in": "query", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "name": "lnn", + "type": "array" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Only return IPs/interfaces configured in the specified VLAN ID", + "in": "query", + "maximum": 4094, + "minimum": 1, + "name": "vlan_id", + "type": "integer" + }, + { + "description": "Filter results by owner id. Support partials matches too. Ex owner=groupnet0 or owner=groupnet0.subnet0.pool0.", + "in": "query", + "maxLength": 99, + "minLength": 1, + "name": "owner", + "type": "string" + }, + { + "description": "Filter the returned IPs by IP type.", + "enum": [ + "static", + "dynamic", + "smartconnect_service", + "ipv6_link_local", + "internal", + "network_pool_ips", + "all" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "If include_vlans is set to true, all vlans are returned unless further filtered by vlan_id. If include_vlans is set to false, no vlans are returned.", + "in": "query", + "name": "include_vlans", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Get a list of interfaces.", + "schema": { + "$ref": "#/definitions/v12NetworkInterfaces" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/12/network/pools": { + "get": { + "description": "Get a list of flexnet pools.", + "operationId": "getNetworkv12NetworkPools", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If specified, only pools for this subnet will be returned.", + "in": "query", + "name": "subnet", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If specified, only pools with this zone name will be returned.", + "in": "query", + "name": "access_zone", + "type": "string" + }, + { + "description": "If specified, only pools with this allocation type will be returned.", + "enum": [ + "static", + "dynamic" + ], + "in": "query", + "name": "alloc_method", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only pools for this groupnet will be returned.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of flexnet pools.", + "schema": { + "$ref": "#/definitions/v12NetworkPools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/12/performance/datasets": { + "get": { + "description": "List all datasets.", + "operationId": "listPerformancev12PerformanceDatasets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all datasets.", + "schema": { + "$ref": "#/definitions/v10PerformanceDatasets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "post": { + "description": "Create a new dataset.", + "operationId": "createPerformancev12PerformanceDataset", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v12PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceDataset" + } + } + ], + "responses": { + "200": { + "description": "Create a new dataset.", + "schema": { + "$ref": "#/definitions/Createv10PerformanceDatasetResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/12/performance/datasets/{Dataset}/filters": { + "delete": { + "description": "Delete all filters associated with the dataset.", + "operationId": "deletePerformanceDatasetsv12DatasetFilters", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all filters.", + "operationId": "listPerformanceDatasetsv12DatasetFilters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all filters.", + "schema": { + "$ref": "#/definitions/v12DatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new filter.", + "operationId": "createPerformanceDatasetsv12DatasetFilter", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v12DatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v12DatasetFilter" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new filter.", + "schema": { + "$ref": "#/definitions/Createv10DatasetFilterResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/12/performance/datasets/{Dataset}/filters/{v12DatasetsDatasetFilterId}": { + "delete": { + "description": "Delete the filter.", + "operationId": "deletePerformancev12DatasetsDatasetFilter", + "parameters": [ + { + "description": "Delete the filter.", + "in": "path", + "name": "v12DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the filter.", + "operationId": "getPerformancev12DatasetsDatasetFilter", + "parameters": [ + { + "description": "Retrieve the filter.", + "in": "path", + "name": "v12DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the filter.", + "schema": { + "$ref": "#/definitions/v12DatasetsDatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the filter.", + "operationId": "updatePerformancev12DatasetsDatasetFilter", + "parameters": [ + { + "in": "body", + "name": "v12DatasetsDatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetFilter" + } + }, + { + "description": "Modify the filter.", + "in": "path", + "name": "v12DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/12/performance/datasets/{Dataset}/workloads": { + "delete": { + "description": "Delete all workloads associated with the dataset.", + "operationId": "deletePerformanceDatasetsv12DatasetWorkloads", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all workloads.", + "operationId": "listPerformanceDatasetsv12DatasetWorkloads", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all workloads.", + "schema": { + "$ref": "#/definitions/v12DatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new workload.", + "operationId": "createPerformanceDatasetsv12DatasetWorkload", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v12DatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v12DatasetWorkload" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new workload.", + "schema": { + "$ref": "#/definitions/Createv10DatasetWorkloadResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/12/performance/datasets/{Dataset}/workloads/{v12DatasetsDatasetWorkloadId}": { + "delete": { + "description": "Delete the workload.", + "operationId": "deletePerformancev12DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Delete the workload.", + "in": "path", + "name": "v12DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the workload.", + "operationId": "getPerformancev12DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Retrieve the workload.", + "in": "path", + "name": "v12DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the workload.", + "schema": { + "$ref": "#/definitions/v12DatasetsDatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the workload.", + "operationId": "updatePerformancev12DatasetsDatasetWorkload", + "parameters": [ + { + "in": "body", + "name": "v12DatasetsDatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetWorkload" + } + }, + { + "description": "Modify the workload.", + "in": "path", + "name": "v12DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/12/performance/datasets/{v12PerformanceDatasetId}": { + "delete": { + "description": "Delete the performance dataset.", + "operationId": "deletePerformancev12PerformanceDataset", + "parameters": [ + { + "description": "Delete the performance dataset.", + "in": "path", + "name": "v12PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the performance dataset.", + "operationId": "getPerformancev12PerformanceDataset", + "parameters": [ + { + "description": "Retrieve the performance dataset.", + "in": "path", + "name": "v12PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the performance dataset.", + "schema": { + "$ref": "#/definitions/v10PerformanceDatasetsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the name of the performance dataset.", + "operationId": "updatePerformancev12PerformanceDataset", + "parameters": [ + { + "in": "body", + "name": "v12PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceDatasetExtendedExtended" + } + }, + { + "description": "Modify the name of the performance dataset.", + "in": "path", + "name": "v12PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/12/performance/metrics": { + "get": { + "description": "List all metrics.", + "operationId": "getPerformancev12PerformanceMetrics", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all metrics.", + "schema": { + "$ref": "#/definitions/v10PerformanceMetrics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/12/performance/metrics/{v12PerformanceMetricId}": { + "get": { + "description": "View a single performance metric.", + "operationId": "getPerformancev12PerformanceMetric", + "parameters": [ + { + "description": "View a single performance metric.", + "in": "path", + "name": "v12PerformanceMetricId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single performance metric.", + "schema": { + "$ref": "#/definitions/v10PerformanceMetricsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/12/performance/settings": { + "get": { + "description": "List all performance settings.", + "operationId": "getPerformancev12PerformanceSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all performance settings.", + "schema": { + "$ref": "#/definitions/v10PerformanceSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Configure performance settings.", + "operationId": "updatePerformancev12PerformanceSettings", + "parameters": [ + { + "description": "Allow modification of settings outside of recommended limits", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v12PerformanceSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/12/protocols/hdfs/log-level": { + "get": { + "description": "Retrieve the HDFS service log-level.", + "operationId": "getProtocolsv12HdfsLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the HDFS service log-level.", + "schema": { + "$ref": "#/definitions/v12HdfsLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the HDFS service log-level.", + "operationId": "updateProtocolsv12HdfsLogLevel", + "parameters": [ + { + "in": "body", + "name": "v12HdfsLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v12HdfsLogLevel" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/hdfs/settings": { + "get": { + "description": "Retrieve HDFS properties.", + "operationId": "getProtocolsv12HdfsSettings", + "parameters": [ + { + "description": "Access zone which contains HDFS settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve HDFS properties.", + "schema": { + "$ref": "#/definitions/v12HdfsSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS properties.", + "operationId": "updateProtocolsv12HdfsSettings", + "parameters": [ + { + "description": "Access zone which contains HDFS settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v12HdfsSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v12HdfsSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/nfs/log-level": { + "get": { + "description": "Get the current NFS service logging level.", + "operationId": "getProtocolsv12NfsLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Get the current NFS service logging level.", + "schema": { + "$ref": "#/definitions/v12NfsLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Set the current NFS service logging level.", + "operationId": "updateProtocolsv12NfsLogLevel", + "parameters": [ + { + "in": "body", + "name": "v12NfsLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v12NfsLogLevel" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/nfs/netgroup/save": { + "post": { + "description": "Save the NFS netgroups in the cache.", + "operationId": "createProtocolsv12NfsNetgroupSaveItem", + "parameters": [ + { + "description": "IP address of node to save. If unspecified, all nodes on the cluster are saved.", + "in": "query", + "name": "host", + "type": "string" + }, + { + "in": "body", + "name": "v12NfsNetgroupSaveItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Save the NFS netgroups in the cache.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/nfs/settings/global": { + "get": { + "description": "Retrieve the NFS configuration.", + "operationId": "getProtocolsv12NfsSettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the NFS configuration.", + "schema": { + "$ref": "#/definitions/v12NfsSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the default values for NFS exports. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv12NfsSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v12NfsSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v12NfsSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/s3/buckets": { + "get": { + "description": "List all buckets.", + "operationId": "listProtocolsv12S3Buckets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Specifies the name of the owner.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "owner", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all buckets.", + "schema": { + "$ref": "#/definitions/v12S3Buckets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new bucket.", + "operationId": "createProtocolsv12S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v12S3Bucket", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3Bucket" + } + } + ], + "responses": { + "200": { + "description": "Create a new bucket.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/s3/buckets/{v12S3BucketId}": { + "delete": { + "description": "Delete the bucket.", + "operationId": "deleteProtocolsv12S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Delete the bucket.", + "in": "path", + "name": "v12S3BucketId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve bucket.", + "operationId": "getProtocolsv12S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve bucket.", + "in": "path", + "name": "v12S3BucketId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve bucket.", + "schema": { + "$ref": "#/definitions/v12S3BucketsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify bucket. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv12S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v12S3Bucket", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3BucketExtendedExtended" + } + }, + { + "description": "Modify bucket. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v12S3BucketId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/s3/settings/zone": { + "get": { + "description": "Retrieve the S3 bucket settings for this zone.", + "operationId": "getProtocolsv12S3SettingsZone", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the S3 bucket settings for this zone.", + "schema": { + "$ref": "#/definitions/v12S3SettingsZone" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the S3 bucket settings for this zone.", + "operationId": "updateProtocolsv12S3SettingsZone", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v12S3SettingsZone", + "required": true, + "schema": { + "$ref": "#/definitions/v12S3SettingsZoneSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/smb/log-level": { + "get": { + "description": "Get the current SMB logging level.", + "operationId": "getProtocolsv12SmbLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Get the current SMB logging level.", + "schema": { + "$ref": "#/definitions/v12SmbLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Set the current SMB logging level.", + "operationId": "updateProtocolsv12SmbLogLevel", + "parameters": [ + { + "in": "body", + "name": "v12SmbLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v12SmbLogLevel" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/smb/shares": { + "delete": { + "description": "Delete multiple smb shares.", + "operationId": "deleteProtocolsv12SmbShares", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List all shares.", + "operationId": "listProtocolsv12SmbShares", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 5000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all shares.", + "schema": { + "$ref": "#/definitions/v12SmbShares" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new share.", + "operationId": "createProtocolsv12SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v12SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v12SmbShare" + } + } + ], + "responses": { + "200": { + "description": "Create a new share.", + "schema": { + "$ref": "#/definitions/Createv12SmbShareResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/protocols/smb/shares/{v12SmbShareId}": { + "delete": { + "description": "Delete the share.", + "operationId": "deleteProtocolsv12SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Delete the share.", + "in": "path", + "name": "v12SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve share.", + "operationId": "getProtocolsv12SmbShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve share.", + "in": "path", + "name": "v12SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve share.", + "schema": { + "$ref": "#/definitions/v12SmbSharesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv12SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v12SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v12SmbShareExtendedExtended" + } + }, + { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v12SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/12/quota/quotas": { + "delete": { + "description": "Delete all or matching quotas.", + "operationId": "deleteQuotav12QuotaQuotas", + "parameters": [ + { + "description": "Only delete quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only delete quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only delete user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Only delete quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only delete quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "operationId": "listQuotav12QuotaQuotas", + "parameters": [ + { + "description": "Only list quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only list quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If used with the path argument, match all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "If used with the path argument, match all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only list user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Set to true to only list quotas which have exceeded one or more of their thresholds.", + "in": "query", + "name": "exceeded", + "type": "boolean" + }, + { + "description": "Only list quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only list quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Use the named report as a source rather than the live quotas. See the /q/quota/reports resource for a list of valid reports.", + "in": "query", + "name": "report_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "schema": { + "$ref": "#/definitions/v12QuotaQuotas" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new quota.", + "operationId": "createQuotav12QuotaQuota", + "parameters": [ + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v12QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v12QuotaQuota" + } + } + ], + "responses": { + "200": { + "description": "Create a new quota.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/12/quota/quotas/{v12QuotaQuotaId}": { + "delete": { + "description": "Delete the quota.", + "operationId": "deleteQuotav12QuotaQuota", + "parameters": [ + { + "description": "Delete the quota.", + "in": "path", + "name": "v12QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve quota information.", + "operationId": "getQuotav12QuotaQuota", + "parameters": [ + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve quota information.", + "in": "path", + "name": "v12QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve quota information.", + "schema": { + "$ref": "#/definitions/v12QuotaQuotasExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav12QuotaQuota", + "parameters": [ + { + "in": "body", + "name": "v12QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v12QuotaQuotaExtendedExtended" + } + }, + { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v12QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/12/storagepool/nodetypes": { + "get": { + "description": "List all node types.", + "operationId": "getStoragepoolv12StoragepoolNodetypes", + "parameters": [], + "responses": { + "200": { + "description": "List all node types.", + "schema": { + "$ref": "#/definitions/v12StoragepoolNodetypes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/12/storagepool/nodetypes/{Nid}/assess": { + "get": { + "description": "Assess nodepools for modifying node type.", + "operationId": "getStoragepoolNodetypesv12NodetypeAssess", + "parameters": [ + { + "in": "path", + "name": "Nid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Assess nodepools for modifying node type.", + "schema": { + "$ref": "#/definitions/v12NodetypeAssess" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "StoragepoolNodetypes" + ] + } + }, + "/platform/12/storagepool/nodetypes/{v12StoragepoolNodetypeId}": { + "get": { + "description": "Retrieve node type information.", + "operationId": "getStoragepoolv12StoragepoolNodetype", + "parameters": [ + { + "description": "Retrieve node type information.", + "in": "path", + "name": "v12StoragepoolNodetypeId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve node type information.", + "schema": { + "$ref": "#/definitions/v12StoragepoolNodetypesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/12/upgrade/cluster": { + "get": { + "description": "Cluster wide upgrade status info.", + "operationId": "getUpgradev12UpgradeCluster", + "parameters": [], + "responses": { + "200": { + "description": "Cluster wide upgrade status info.", + "schema": { + "$ref": "#/definitions/v12UpgradeCluster" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/upgrade/cluster/drain": { + "put": { + "description": "Alter drain action.", + "operationId": "updateUpgradev12ClusterDrain", + "parameters": [ + { + "in": "body", + "name": "v12ClusterDrain", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterDrain" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/upgrade/cluster/drain/list": { + "get": { + "description": "View Drain delay/skip lists.", + "operationId": "getUpgradev12ClusterDrainList", + "parameters": [ + { + "description": "Delay or Skip list.", + "enum": [ + "delay", + "skip" + ], + "in": "query", + "name": "drain_list", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View Drain delay/skip lists.", + "schema": { + "$ref": "#/definitions/v12ClusterDrainList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/upgrade/cluster/drain/timeout": { + "get": { + "description": "View or modify drain timeouts.", + "operationId": "getUpgradev12ClusterDrainTimeout", + "parameters": [], + "responses": { + "200": { + "description": "View or modify drain timeouts.", + "schema": { + "$ref": "#/definitions/v12ClusterDrainTimeout" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "put": { + "description": "View or modify drain timeouts.", + "operationId": "updateUpgradev12ClusterDrainTimeout", + "parameters": [ + { + "in": "body", + "name": "v12ClusterDrainTimeout", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterDrainTimeoutExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/upgrade/cluster/firmware/upgrade": { + "post": { + "description": "The settings necessary to start a firmware upgrade.", + "operationId": "createUpgradev12ClusterFirmwareUpgradeItem", + "parameters": [ + { + "in": "body", + "name": "v12ClusterFirmwareUpgradeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterFirmwareUpgradeItem" + } + } + ], + "responses": { + "200": { + "description": "The settings necessary to start a firmware upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/upgrade/cluster/nodes": { + "get": { + "description": "View information about nodes during an upgrade, rollback, or pre-upgrade assessment.", + "operationId": "getUpgradev12ClusterNodes", + "parameters": [ + { + "default": false, + "description": "If true, tag nodes that are assigned to like-failure domains", + "in": "query", + "name": "by_domain", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "View information about nodes during an upgrade, rollback, or pre-upgrade assessment.", + "schema": { + "$ref": "#/definitions/v12ClusterNodesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/upgrade/cluster/nodes/{v12ClusterNodeId}": { + "get": { + "description": "The node details useful during an upgrade or assessment.", + "operationId": "getUpgradev12ClusterNode", + "parameters": [ + { + "description": "The node details useful during an upgrade or assessment.", + "in": "path", + "name": "v12ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "The node details useful during an upgrade or assessment.", + "schema": { + "$ref": "#/definitions/v12ClusterNodeExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/12/upgrade/cluster/upgrade": { + "post": { + "description": "The settings necessary to start an upgrade.", + "operationId": "createUpgradev12ClusterUpgradeItem", + "parameters": [ + { + "in": "body", + "name": "v12ClusterUpgradeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterUpgradeItem" + } + } + ], + "responses": { + "200": { + "description": "The settings necessary to start an upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "put": { + "description": "Add nodes to a running upgrade.", + "operationId": "updateUpgradev12ClusterUpgrade", + "parameters": [ + { + "in": "body", + "name": "v12ClusterUpgrade", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterUpgrade" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/14/api/sessions/invalidations": { + "get": { + "description": "Get Platform API session invalidations.", + "operationId": "listApiv14SessionsInvalidations", + "parameters": [ + { + "description": "The zone to get invalidations from.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get Platform API session invalidations.", + "schema": { + "$ref": "#/definitions/v14SessionsInvalidations" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + }, + "post": { + "description": "Create a new Platform API session invalidation.", + "operationId": "createApiv14SessionsInvalidation", + "parameters": [ + { + "description": "The zone to create the invalidation in.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v14SessionsInvalidation", + "required": true, + "schema": { + "$ref": "#/definitions/v14SessionsInvalidation" + } + } + ], + "responses": { + "200": { + "description": "Create a new Platform API session invalidation.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + } + }, + "/platform/14/api/sessions/invalidations/{v14SessionsInvalidationId}": { + "delete": { + "description": "Delete a user's Platform API session invalidation.", + "operationId": "deleteApiv14SessionsInvalidation", + "parameters": [ + { + "description": "The zone to delete an invalidation from.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete a user's Platform API session invalidation.", + "in": "path", + "name": "v14SessionsInvalidationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + }, + "get": { + "description": "Get user Platform API session invalidation information.", + "operationId": "getApiv14SessionsInvalidation", + "parameters": [ + { + "description": "The zone to get the invalidation from.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Get user Platform API session invalidation information.", + "in": "path", + "name": "v14SessionsInvalidationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get user Platform API session invalidation information.", + "schema": { + "$ref": "#/definitions/v14SessionsInvalidations" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + }, + "put": { + "description": "Modify a user's Platform API session invalidation.", + "operationId": "updateApiv14SessionsInvalidation", + "parameters": [ + { + "description": "The zone to modify an invalidation in.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v14SessionsInvalidation", + "required": true, + "schema": { + "$ref": "#/definitions/v14SessionsInvalidationExtendedExtended" + } + }, + { + "description": "Modify a user's Platform API session invalidation.", + "in": "path", + "name": "v14SessionsInvalidationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + } + }, + "/platform/14/api/sessions/rekey": { + "post": { + "description": "Delete all existing session API signing keys and create a new signing key.", + "operationId": "createApiv14SessionsRekeyItem", + "parameters": [ + { + "in": "body", + "name": "v14SessionsRekeyItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Delete all existing session API signing keys and create a new signing key.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + } + }, + "/platform/14/api/settings/sessions": { + "get": { + "description": "Retrieve the HTTP API session settings.", + "operationId": "getApiv14SettingsSessions", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the HTTP API session settings.", + "schema": { + "$ref": "#/definitions/v14SettingsSessions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + }, + "put": { + "description": "Modify the HTTP API session settings.", + "operationId": "updateApiv14SettingsSessions", + "parameters": [ + { + "in": "body", + "name": "v14SettingsSessions", + "required": true, + "schema": { + "$ref": "#/definitions/v14SettingsSessionsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Api" + ] + } + }, + "/platform/14/auth/id": { + "get": { + "description": "Retrieve the current security token.", + "operationId": "getAuthv14AuthId", + "parameters": [ + { + "description": "A list of child privileges for the current security token.", + "in": "query", + "name": "listchildprivs", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Retrieve the current security token.", + "schema": { + "$ref": "#/definitions/v14AuthId" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/14/auth/privileges": { + "get": { + "description": "List all privileges.", + "operationId": "getAuthv14AuthPrivileges", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all privileges.", + "schema": { + "$ref": "#/definitions/v14AuthPrivileges" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/14/auth/providers/ads": { + "get": { + "description": "List all ADS providers.", + "operationId": "listAuthv14ProvidersAds", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS providers.", + "schema": { + "$ref": "#/definitions/v14ProvidersAds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new ADS provider.", + "operationId": "createAuthv14ProvidersAdsItem", + "parameters": [ + { + "in": "body", + "name": "v14ProvidersAdsItem", + "required": true, + "schema": { + "$ref": "#/definitions/v14ProvidersAdsItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new ADS provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/14/auth/providers/ads/{v14ProvidersAdsId}": { + "delete": { + "description": "Delete the ADS provider.", + "operationId": "deleteAuthv14ProvidersAdsById", + "parameters": [ + { + "description": "Delete the ADS provider.", + "in": "path", + "name": "v14ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the ADS provider.", + "operationId": "getAuthv14ProvidersAdsById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Check for duplicate SPNs registered in Active Directory.", + "in": "query", + "name": "check_duplicates", + "type": "boolean" + }, + { + "description": "Retrieve the ADS provider.", + "in": "path", + "name": "v14ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ADS provider.", + "schema": { + "$ref": "#/definitions/v14ProvidersAdsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the ADS provider.", + "operationId": "updateAuthv14ProvidersAdsById", + "parameters": [ + { + "in": "body", + "name": "v14ProvidersAdsIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v14ProvidersAdsIdParams" + } + }, + { + "description": "Modify the ADS provider.", + "in": "path", + "name": "v14ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/14/auth/roles": { + "get": { + "description": "List all roles.", + "operationId": "listAuthv14AuthRoles", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all roles.", + "schema": { + "$ref": "#/definitions/v14AuthRoles" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new role.", + "operationId": "createAuthv14AuthRole", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v14AuthRole", + "required": true, + "schema": { + "$ref": "#/definitions/v14AuthRole" + } + } + ], + "responses": { + "200": { + "description": "Create a new role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/14/auth/roles/{Role}/privileges": { + "get": { + "description": "List all privileges in the role.", + "operationId": "listAuthRolesv14RolePrivileges", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all privileges in the role.", + "schema": { + "$ref": "#/definitions/v14RolePrivileges" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + }, + "post": { + "description": "Add a privilege to the role.", + "operationId": "createAuthRolesv14RolePrivilege", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v14RolePrivilege", + "required": true, + "schema": { + "$ref": "#/definitions/v14AuthIdNtokenPrivilegeItem" + } + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a privilege to the role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + } + }, + "/platform/14/auth/roles/{Role}/privileges/{v14RolesRolePrivilegeId}": { + "delete": { + "description": "Remove a privilege from a role.", + "operationId": "deleteAuthv14RolesRolePrivilege", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Remove a privilege from a role.", + "in": "path", + "name": "v14RolesRolePrivilegeId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/14/auth/roles/{v14AuthRoleId}": { + "delete": { + "description": "Delete the role.", + "operationId": "deleteAuthv14AuthRole", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Delete the role.", + "in": "path", + "name": "v14AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the role information.", + "operationId": "getAuthv14AuthRole", + "parameters": [ + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve the role information.", + "in": "path", + "name": "v14AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the role information.", + "schema": { + "$ref": "#/definitions/v14AuthRolesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the role.", + "operationId": "updateAuthv14AuthRole", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v14AuthRole", + "required": true, + "schema": { + "$ref": "#/definitions/v14AuthRoleExtendedExtended" + } + }, + { + "description": "Modify the role.", + "in": "path", + "name": "v14AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/14/catalog/clean": { + "put": { + "description": "Removes any unreferenced artifacts.", + "operationId": "updateCatalogv14CatalogClean", + "parameters": [ + { + "in": "body", + "name": "v14CatalogClean", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/catalog/export": { + "put": { + "description": "Allows a catalog artifact to be exported out of the catalog to a file that the user can access. A typical use case would be if a user needs to export artifacts prior to a full catalog wipe or if a specific package is needed so that it can be applied on another cluster.", + "operationId": "updateCatalogv14CatalogExport", + "parameters": [ + { + "in": "body", + "name": "v14CatalogExport", + "required": true, + "schema": { + "$ref": "#/definitions/v14CatalogExport" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/catalog/import": { + "put": { + "description": "Allow a signed package to be re-imported into the catalog. A typical use case would be if a required package is missing or damaged. All user imported files will be subjected to a full signature verification including verifying the sha256 hashes for all data regions. Files that are not correctly signed will not be allowed in the catalog.", + "operationId": "updateCatalogv14CatalogImport", + "parameters": [ + { + "in": "body", + "name": "v14CatalogImport", + "required": true, + "schema": { + "$ref": "#/definitions/v14CatalogImport" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/catalog/list": { + "get": { + "description": "List metadata for artifacts in the catalog.", + "operationId": "getCatalogv14CatalogList", + "parameters": [ + { + "description": "onefs version", + "in": "query", + "maximum": 2147483646, + "name": "onefs_version", + "required": false, + "type": "integer" + }, + { + "description": "onefs component that references this entry.", + "in": "query", + "maxLength": 128, + "minLength": 1, + "name": "reference", + "required": false, + "type": "string" + }, + { + "description": "the type of upgrade", + "enum": [ + "OneFS", + "NFW", + "DSP", + "Patch" + ], + "in": "query", + "maxLength": 128, + "minLength": 3, + "name": "content_type", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List metadata for artifacts in the catalog.", + "schema": { + "$ref": "#/definitions/v14CatalogList" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/catalog/readme": { + "get": { + "description": "README file content for artifact in the catalog.", + "operationId": "getCatalogv14CatalogReadme", + "parameters": [ + { + "description": "The sha256 hash of the file stored in catalog", + "in": "query", + "maxLength": 128, + "minLength": 3, + "name": "hash", + "type": "string" + }, + { + "description": "Path of the signed file to import in the catalog", + "in": "query", + "maxLength": 4096, + "minLength": 3, + "name": "file", + "type": "string" + } + ], + "responses": { + "200": { + "description": "README file content for artifact in the catalog.", + "schema": { + "$ref": "#/definitions/v14CatalogReadme" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/catalog/remove": { + "put": { + "description": "Allows a user to remove a specific sha256 artifact and all related metadata. If the file is needed again in the future it will need to be re-imported.", + "operationId": "updateCatalogv14CatalogRemove", + "parameters": [ + { + "in": "body", + "name": "v14CatalogRemove", + "required": true, + "schema": { + "$ref": "#/definitions/v14CatalogRemove" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/catalog/repair": { + "put": { + "description": "Repairs a damaged catalog. Erases catalog database, creates a new catalog database, and automatically reverifies and reimports all the artifacts.", + "operationId": "updateCatalogv14CatalogRepair", + "parameters": [ + { + "in": "body", + "name": "v14CatalogRepair", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/catalog/verify": { + "get": { + "description": "Verification of the signatures of any specified file, a specific artifact in the catalog, or all artifacts in the catalog.", + "operationId": "getCatalogv14CatalogVerify", + "parameters": [ + { + "description": "The sha256 hash of the file stored in catalog", + "in": "query", + "maxLength": 128, + "minLength": 3, + "name": "hash", + "type": "string" + }, + { + "description": "Path to unsigned file to verify", + "in": "query", + "maxLength": 4096, + "minLength": 3, + "name": "file", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Verification of the signatures of any specified file, a specific artifact in the catalog, or all artifacts in the catalog.", + "schema": { + "$ref": "#/definitions/v14CatalogVerify" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Catalog" + ] + } + }, + "/platform/14/cluster-mode/settings": { + "get": { + "description": "Get cluster mode services settings", + "operationId": "getClusterModev14ClusterModeSettings", + "parameters": [], + "responses": { + "200": { + "description": "Get cluster mode services settings", + "schema": { + "$ref": "#/definitions/v14ClusterModeSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterMode" + ] + }, + "put": { + "description": "Modify cluster mode services settings", + "operationId": "updateClusterModev14ClusterModeSettings", + "parameters": [ + { + "in": "body", + "name": "v14ClusterModeSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v14ClusterModeSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterMode" + ] + } + }, + "/platform/14/cluster/acs": { + "get": { + "description": "Get the cluster acs status", + "operationId": "listClusterv14ClusterAcs", + "parameters": [], + "responses": { + "200": { + "description": "Get the cluster acs status", + "schema": { + "$ref": "#/definitions/v14ClusterAcs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "post": { + "description": "resume cluster acs status", + "operationId": "createClusterv14ClusterAc", + "parameters": [ + { + "in": "body", + "name": "v14ClusterAc", + "required": true, + "schema": { + "$ref": "#/definitions/v14ClusterAc" + } + } + ], + "responses": { + "200": { + "description": "resume cluster acs status", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/14/cluster/internal-networks/preferred-network": { + "put": { + "description": "Modify the preferred backend network.", + "operationId": "updateClusterv14InternalNetworksPreferredNetwork", + "parameters": [ + { + "in": "body", + "name": "v14InternalNetworksPreferredNetwork", + "required": true, + "schema": { + "$ref": "#/definitions/v14InternalNetworksPreferredNetwork" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/14/cluster/internal-networks/settings": { + "get": { + "description": "View backend fabric settings.", + "operationId": "getClusterv14InternalNetworksSettings", + "parameters": [], + "responses": { + "200": { + "description": "View backend fabric settings.", + "schema": { + "$ref": "#/definitions/v14InternalNetworksSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify backend fabric settings.", + "operationId": "updateClusterv14InternalNetworksSettings", + "parameters": [ + { + "in": "body", + "name": "v14InternalNetworksSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v14InternalNetworksSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/14/cluster/nodes": { + "get": { + "description": "List the nodes on this cluster.", + "operationId": "getClusterv14ClusterNodes", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + } + ], + "responses": { + "200": { + "description": "List the nodes on this cluster.", + "schema": { + "$ref": "#/definitions/v14ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/14/cluster/nodes/{Lnn}/driveconfig": { + "get": { + "description": "View a node's drive subsystem XML configuration file.", + "operationId": "getClusterNodesv14NodeDriveconfig", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "View a node's drive subsystem XML configuration file.", + "schema": { + "$ref": "#/definitions/v14NodeDriveconfig" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "put": { + "description": "Modify a node's drive subsystem XML configuration file.", + "operationId": "updateClusterNodesv14NodeDriveconfig", + "parameters": [ + { + "in": "body", + "name": "v14NodeDriveconfig", + "required": true, + "schema": { + "$ref": "#/definitions/v14NodeDriveconfigExtended" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/14/cluster/nodes/{v14ClusterNodeId}": { + "get": { + "description": "Retrieve node information.", + "operationId": "getClusterv14ClusterNode", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve node information.", + "in": "path", + "name": "v14ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node information.", + "schema": { + "$ref": "#/definitions/v14ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/14/event/settings": { + "get": { + "description": "Retrieve the settings.", + "operationId": "getEventv14EventSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the settings.", + "schema": { + "$ref": "#/definitions/v14EventSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify settings.", + "operationId": "updateEventv14EventSettings", + "parameters": [ + { + "in": "body", + "name": "v14EventSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v14EventSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/14/network/interfaces": { + "get": { + "description": "Get a list of interfaces.", + "operationId": "getNetworkv14NetworkInterfaces", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Show interfaces associated with external and/or internal networks. Default is 'external'", + "enum": [ + "all", + "external", + "internal" + ], + "in": "query", + "name": "network", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Control where interface data is source from. no-cache only returns live data from a running node, and if a node can't be reached, no results will be returned. cache-only only returns cached data, some fields are set as null/unknown if they can't be determined, and IPs listed are the IPs that should be configured. Finally, nodes-first will try to query live nodes, and fall back to the cache for any nodes that fail. Default: nodes-first", + "enum": [ + "cache-only", + "no-cache", + "nodes-first" + ], + "in": "query", + "name": "cache", + "type": "string" + }, + { + "description": "Get a list of interfaces for the specified lnns.", + "in": "query", + "items": { + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "name": "lnn", + "type": "array" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Only return IPs/interfaces configured in the specified VLAN ID", + "in": "query", + "maximum": 4094, + "minimum": 1, + "name": "vlan_id", + "type": "integer" + }, + { + "description": "Filter results by owner id. Support partials matches too. Ex owner=groupnet0 or owner=groupnet0.subnet0.pool0.", + "in": "query", + "maxLength": 99, + "minLength": 1, + "name": "owner", + "type": "string" + }, + { + "description": "Filter the returned IPs by IP type.", + "enum": [ + "static", + "dynamic", + "smartconnect_service", + "ipv6_link_local", + "internal", + "network_pool_ips", + "all" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "If include_vlans is set to true, all vlans are returned unless further filtered by vlan_id. If include_vlans is set to false, no vlans are returned.", + "in": "query", + "name": "include_vlans", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Get a list of interfaces.", + "schema": { + "$ref": "#/definitions/v14NetworkInterfaces" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/14/papi/settings": { + "get": { + "description": "List PAPI settings.", + "operationId": "getPapiv14PapiSettings", + "parameters": [], + "responses": { + "200": { + "description": "List PAPI settings.", + "schema": { + "$ref": "#/definitions/v14PapiSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Papi" + ] + }, + "put": { + "description": "Modify PAPI settings.", + "operationId": "updatePapiv14PapiSettings", + "parameters": [ + { + "in": "body", + "name": "v14PapiSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v14PapiSettingsPapiSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Papi" + ] + } + }, + "/platform/14/protocols/nfs/settings/global": { + "get": { + "description": "Retrieve the NFS configuration.", + "operationId": "getProtocolsv14NfsSettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the NFS configuration.", + "schema": { + "$ref": "#/definitions/v14NfsSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the default values for NFS exports. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv14NfsSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v14NfsSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v14NfsSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/14/snapshot/writable": { + "delete": { + "description": "Delete all or matching writable snapshots.", + "operationId": "deleteSnapshotv14SnapshotWritable", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "List all or matching writable snapshots.", + "operationId": "listSnapshotv14SnapshotWritable", + "parameters": [ + { + "description": "The field that will be used for sorting. Choices are path, src name, src path, created, size and state. Default is created.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Only list writable snapshots matching this state.", + "enum": [ + "all", + "active", + "deleting" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching writable snapshots.", + "schema": { + "$ref": "#/definitions/v14SnapshotWritable" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "post": { + "description": "Create a new writable snapshot.", + "operationId": "createSnapshotv14SnapshotWritableItem", + "parameters": [ + { + "in": "body", + "name": "v14SnapshotWritableItem", + "required": true, + "schema": { + "$ref": "#/definitions/v14SnapshotWritableItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new writable snapshot.", + "schema": { + "$ref": "#/definitions/Createv14SnapshotWritableItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/14/snapshot/writable-snapshot-summary": { + "get": { + "description": "Return summary information about writable snapshots.", + "operationId": "getSnapshotv14SnapshotWritableSnapshotSummary", + "parameters": [], + "responses": { + "200": { + "description": "Return summary information about writable snapshots.", + "schema": { + "$ref": "#/definitions/v14SnapshotWritableSnapshotSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/14/snapshot/writable/{v14SnapshotWritableWspath}": { + "delete": { + "description": "Delete the writable snapshot. Deleted writable snapshots will be placed into a deleting state until the system can reclaim the space used by the writable snapshot.", + "operationId": "deleteSnapshotv14SnapshotWritableWspath", + "parameters": [ + { + "description": "Delete the writable snapshot. Deleted writable snapshots will be placed into a deleting state until the system can reclaim the space used by the writable snapshot.", + "in": "path", + "name": "v14SnapshotWritableWspath", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "Retrieve writable snapshot information.", + "operationId": "getSnapshotv14SnapshotWritableWspath", + "parameters": [ + { + "description": "Retrieve writable snapshot information.", + "in": "path", + "name": "v14SnapshotWritableWspath", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve writable snapshot information.", + "schema": { + "$ref": "#/definitions/v14SnapshotWritableExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/14/statistics/summary/cloud": { + "get": { + "description": "List all Cloudpools statistics.", + "operationId": "getStatisticsv14SummaryCloud", + "parameters": [ + { + "description": "Sort data by the specified comma-separated field(s). ( account | policy | in | out | reads | writes | deletes | cloud | node). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Specify an account for which statistics should be reported.", + "in": "query", + "maxLength": 768, + "minLength": 1, + "name": "account", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds. Defaults to 5 seconds.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "Specify a policy for which statistics should be reported.", + "in": "query", + "maxLength": 255, + "minLength": 1, + "name": "policy", + "type": "string" + }, + { + "description": "Specify node(s) for which statistics should be reported. Default is 'all'. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "maxLength": 8192, + "minLength": 1, + "name": "nodes", + "type": "string" + }, + { + "description": "Continue to report even if some nodes do not respond.Defaults to false.", + "in": "query", + "name": "degraded", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List all Cloudpools statistics.", + "schema": { + "$ref": "#/definitions/v14SummaryCloud" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/14/sync/policies": { + "delete": { + "description": "Delete all SyncIQ policies.", + "operationId": "deleteSyncv14SyncPolicies", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "List all SyncIQ policies.", + "operationId": "listSyncv14SyncPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return a summary rather than entire objects.", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ policies.", + "schema": { + "$ref": "#/definitions/v14SyncPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Create a SyncIQ policy.", + "operationId": "createSyncv14SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v14SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v14SyncPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a SyncIQ policy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/14/sync/policies/{v14SyncPolicyId}": { + "delete": { + "description": "Delete a single SyncIQ policy.", + "operationId": "deleteSyncv14SyncPolicy", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a single SyncIQ policy.", + "in": "path", + "name": "v14SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ policy.", + "operationId": "getSyncv14SyncPolicy", + "parameters": [ + { + "description": "View a single SyncIQ policy.", + "in": "path", + "name": "v14SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ policy.", + "schema": { + "$ref": "#/definitions/v14SyncPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a single SyncIQ policy.", + "operationId": "updateSyncv14SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v14SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v14SyncPolicyExtendedExtended" + } + }, + { + "description": "Modify a single SyncIQ policy.", + "in": "path", + "name": "v14SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/14/sync/settings": { + "get": { + "description": "Retrieve the global SyncIQ settings.", + "operationId": "getSyncv14SyncSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the global SyncIQ settings.", + "schema": { + "$ref": "#/definitions/v14SyncSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify the global SyncIQ settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSyncv14SyncSettings", + "parameters": [ + { + "in": "body", + "name": "v14SyncSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v14SyncSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/14/upgrade/cluster/patch/patches": { + "get": { + "description": "List all patches.", + "operationId": "listUpgradev14ClusterPatchPatches", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Path location of patch file.", + "in": "query", + "maxLength": 4096, + "minLength": 0, + "name": "location", + "type": "string" + }, + { + "description": "View patches on the local node only.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all patches.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatches" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "post": { + "description": "Install a patch.", + "operationId": "createUpgradev14ClusterPatchPatch", + "parameters": [ + { + "description": "The duration in seconds that upgrade waits for all SMB clients to disconnect from a node before rebooting it. A value of 0 means wait indefinitely. If not specified, upgrade proceeds with reboots regardless of SMB client connections (legacy behavior).", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "drain_timeout", + "type": "integer" + }, + { + "description": "The duration in seconds after drain begins that an alert will be raised. An alert timeout must be set to a smaller value than the drain timeout to be used. If not specified, an alert will not be raised (legacy behavior).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "alert_timeout", + "type": "integer" + }, + { + "description": "Bypass conflict checks. Defaults to false.", + "in": "query", + "name": "skip_conflict_check", + "type": "boolean" + }, + { + "description": "Bypass restricted checks. Defaults to false.", + "in": "query", + "name": "skip_restricted_check", + "type": "boolean" + }, + { + "description": "Bypass dependency checks. Defaults to false.", + "in": "query", + "name": "skip_dependency_check", + "type": "boolean" + }, + { + "description": "Bypass version checks. Defaults to false.", + "in": "query", + "name": "skip_version_check", + "type": "boolean" + }, + { + "in": "body", + "name": "v14ClusterPatchPatch", + "required": true, + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatch" + } + } + ], + "responses": { + "200": { + "description": "Install a patch.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/14/upgrade/cluster/patch/patches/{v14ClusterPatchPatchId}": { + "delete": { + "description": "Uninstall a patch.", + "operationId": "deleteUpgradev14ClusterPatchPatch", + "parameters": [ + { + "description": "The duration in seconds that upgrade waits for all SMB clients to disconnect from a node before rebooting it. A value of 0 means wait indefinitely. If not specified, upgrade proceeds with reboots regardless of SMB client connections (legacy behavior).", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "drain_timeout", + "type": "integer" + }, + { + "description": "The duration in seconds after drain begins that an alert will be raised. An alert timeout must be set to a smaller value than the drain timeout to be used. If not specified, an alert will not be raised (legacy behavior).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "alert_timeout", + "type": "integer" + }, + { + "description": "Bypass conflict checks. Defaults to false.", + "in": "query", + "name": "skip_conflict_check", + "type": "boolean" + }, + { + "description": "Bypass restricted checks. Defaults to false.", + "in": "query", + "name": "skip_restricted_check", + "type": "boolean" + }, + { + "description": "Process type can be 'simultaneous', 'rolling', or 'parallel'", + "in": "query", + "maxLength": 255, + "minLength": 6, + "name": "process_type", + "type": "string" + }, + { + "description": "Bypass dependency checks. Defaults to false.", + "in": "query", + "name": "skip_dependency_check", + "type": "boolean" + }, + { + "description": "Bypass version checks. Defaults to false.", + "in": "query", + "name": "skip_version_check", + "type": "boolean" + }, + { + "description": "Uninstall a patch.", + "in": "path", + "name": "v14ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "get": { + "description": "View a single patch.", + "operationId": "getUpgradev14ClusterPatchPatch", + "parameters": [ + { + "description": "View patch information on local node only.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "Path location of patch file.", + "in": "query", + "maxLength": 4096, + "minLength": 0, + "name": "location", + "type": "string" + }, + { + "description": "View a single patch.", + "in": "path", + "name": "v14ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single patch.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatchesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/15/cluster/nodes": { + "get": { + "description": "List the nodes on this cluster.", + "operationId": "getClusterv15ClusterNodes", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + } + ], + "responses": { + "200": { + "description": "List the nodes on this cluster.", + "schema": { + "$ref": "#/definitions/v15ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/15/cluster/nodes/{Lnn}/drives": { + "get": { + "description": "List the drives on this node.", + "operationId": "getClusterNodesv15NodeDrives", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List the drives on this node.", + "schema": { + "$ref": "#/definitions/v15NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/15/cluster/nodes/{Lnn}/drives/{v15NodesLnnDriveId}": { + "get": { + "description": "Retrieve drive information.", + "operationId": "getClusterv15NodesLnnDrive", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve drive information.", + "in": "path", + "name": "v15NodesLnnDriveId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve drive information.", + "schema": { + "$ref": "#/definitions/v15NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/15/cluster/nodes/{v15ClusterNodeId}": { + "get": { + "description": "Retrieve node information.", + "operationId": "getClusterv15ClusterNode", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve node information.", + "in": "path", + "name": "v15ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node information.", + "schema": { + "$ref": "#/definitions/v15ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/15/cluster/services": { + "get": { + "description": "List the services on this cluster.", + "operationId": "getClusterv15ClusterServices", + "parameters": [], + "responses": { + "200": { + "description": "List the services on this cluster.", + "schema": { + "$ref": "#/definitions/v15ClusterServices" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/15/datamover/accounts": { + "get": { + "description": "List all accounts.", + "operationId": "listDatamoverv15DatamoverAccounts", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all accounts.", + "schema": { + "$ref": "#/definitions/v15DatamoverAccounts" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "post": { + "description": "Create a new account.", + "operationId": "createDatamoverv15DatamoverAccount", + "parameters": [ + { + "in": "body", + "name": "v15DatamoverAccount", + "required": true, + "schema": { + "$ref": "#/definitions/v15DatamoverAccount" + } + } + ], + "responses": { + "200": { + "description": "Create a new account.", + "schema": { + "$ref": "#/definitions/Createv15DatamoverAccountResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/accounts/{v15DatamoverAccountId}": { + "delete": { + "description": "Delete the account.", + "operationId": "deleteDatamoverv15DatamoverAccount", + "parameters": [ + { + "description": "Delete the account.", + "in": "path", + "name": "v15DatamoverAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "get": { + "description": "Retrieve account information.", + "operationId": "getDatamoverv15DatamoverAccount", + "parameters": [ + { + "description": "Retrieve account information.", + "in": "path", + "name": "v15DatamoverAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve account information.", + "schema": { + "$ref": "#/definitions/v15DatamoverAccountsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify account information.", + "operationId": "updateDatamoverv15DatamoverAccount", + "parameters": [ + { + "in": "body", + "name": "v15DatamoverAccount", + "required": true, + "schema": { + "$ref": "#/definitions/v15DatamoverAccountExtendedExtended" + } + }, + { + "description": "Modify account information.", + "in": "path", + "name": "v15DatamoverAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/base-policies": { + "get": { + "description": "List all base policies.", + "operationId": "listDatamoverv15DatamoverBasePolicies", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all base policies.", + "schema": { + "$ref": "#/definitions/v15DatamoverBasePolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "post": { + "description": "Create a new Data Mover base policy.", + "operationId": "createDatamoverv15DatamoverBasePolicy", + "parameters": [ + { + "in": "body", + "name": "v15DatamoverBasePolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v15DatamoverBasePolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a new Data Mover base policy.", + "schema": { + "$ref": "#/definitions/Createv15DatamoverBasePolicyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/base-policies/{v15DatamoverBasePolicyId}": { + "delete": { + "description": "Delete the base policy.", + "operationId": "deleteDatamoverv15DatamoverBasePolicy", + "parameters": [ + { + "description": "Delete the base policy.", + "in": "path", + "name": "v15DatamoverBasePolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "get": { + "description": "Retrieve base policy information.", + "operationId": "getDatamoverv15DatamoverBasePolicy", + "parameters": [ + { + "description": "Retrieve base policy information.", + "in": "path", + "name": "v15DatamoverBasePolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve base policy information.", + "schema": { + "$ref": "#/definitions/v15DatamoverBasePoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify base policy information.", + "operationId": "updateDatamoverv15DatamoverBasePolicy", + "parameters": [ + { + "in": "body", + "name": "v15DatamoverBasePolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v15DatamoverBasePolicyExtended" + } + }, + { + "description": "Modify base policy information.", + "in": "path", + "name": "v15DatamoverBasePolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/certificates/ca": { + "get": { + "description": "Retrieve a list of all trusted Datamover TLS CA certificates.", + "operationId": "listDatamoverv15CertificatesCa", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of all trusted Datamover TLS CA certificates.", + "schema": { + "$ref": "#/definitions/v7CertificateAuthority" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "post": { + "description": "Import a trusted Datamover TLS CA certificate.", + "operationId": "createDatamoverv15CertificatesCaItem", + "parameters": [ + { + "in": "body", + "name": "v15CertificatesCaItem", + "required": true, + "schema": { + "$ref": "#/definitions/v15CertificatesCaItem" + } + } + ], + "responses": { + "200": { + "description": "Import a trusted Datamover TLS CA certificate.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/certificates/ca/{v15CertificatesCaId}": { + "delete": { + "description": "Delete a trusted Datamover TLS CA certificate.", + "operationId": "deleteDatamoverv15CertificatesCaById", + "parameters": [ + { + "description": "Delete a trusted Datamover TLS CA certificate.", + "in": "path", + "name": "v15CertificatesCaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "get": { + "description": "Retrieve a single trusted Datamover TLS CA certificate.", + "operationId": "getDatamoverv15CertificatesCaById", + "parameters": [ + { + "description": "Retrieve a single trusted Datamover TLS CA certificate.", + "in": "path", + "name": "v15CertificatesCaId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a single trusted Datamover TLS CA certificate.", + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify a trusted Datamover TLS CA certificate.", + "operationId": "updateDatamoverv15CertificatesCaById", + "parameters": [ + { + "in": "body", + "name": "v15CertificatesCaIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v15CertificatesCaIdParams" + } + }, + { + "description": "Modify a trusted Datamover TLS CA certificate.", + "in": "path", + "name": "v15CertificatesCaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/certificates/identity": { + "get": { + "description": "Retrieve a list of all trusted Datamover TLS Identity certificates.", + "operationId": "listDatamoverv15CertificatesIdentity", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of all trusted Datamover TLS Identity certificates.", + "schema": { + "$ref": "#/definitions/v4CertificateServer" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "post": { + "description": "Import a trusted Datamover TLS Identity certificate.", + "operationId": "createDatamoverv15CertificatesIdentityItem", + "parameters": [ + { + "in": "body", + "name": "v15CertificatesIdentityItem", + "required": true, + "schema": { + "$ref": "#/definitions/v15CertificatesIdentityItem" + } + } + ], + "responses": { + "200": { + "description": "Import a trusted Datamover TLS Identity certificate.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/certificates/identity/{v15CertificatesIdentityId}": { + "delete": { + "description": "Delete a trusted Datamover TLS Identity certificate.", + "operationId": "deleteDatamoverv15CertificatesIdentityById", + "parameters": [ + { + "description": "Delete a trusted Datamover TLS Identity certificate.", + "in": "path", + "name": "v15CertificatesIdentityId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "get": { + "description": "Retrieve a single trusted Datamover TLS Identity certificate.", + "operationId": "getDatamoverv15CertificatesIdentityById", + "parameters": [ + { + "description": "Retrieve a single trusted Datamover TLS Identity certificate.", + "in": "path", + "name": "v15CertificatesIdentityId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a single trusted Datamover TLS Identity certificate.", + "schema": { + "$ref": "#/definitions/v4CertificateServerExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify a trusted Datamover TLS Identity certificate.", + "operationId": "updateDatamoverv15CertificatesIdentityById", + "parameters": [ + { + "in": "body", + "name": "v15CertificatesIdentityIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v15CertificatesCaIdParams" + } + }, + { + "description": "Modify a trusted Datamover TLS Identity certificate.", + "in": "path", + "name": "v15CertificatesIdentityId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/datasets": { + "get": { + "description": "List all datasets or retrieve datasets of the specified type.", + "operationId": "getDatamoverv15DatamoverDatasets", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Unique account ID", + "in": "query", + "maxLength": 48, + "minLength": 2, + "name": "account_id", + "type": "string" + }, + { + "in": "query", + "maxLength": 4096, + "minLength": 1, + "name": "base_path", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all datasets or retrieve datasets of the specified type.", + "schema": { + "$ref": "#/definitions/v15DatamoverDatasets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/datasets/{v15DatamoverDatasetId}": { + "get": { + "description": "Retrieve dataset information.", + "operationId": "getDatamoverv15DatamoverDataset", + "parameters": [ + { + "description": "Unique account ID", + "in": "query", + "maxLength": 48, + "minLength": 2, + "name": "account_id", + "type": "string" + }, + { + "description": "Retrieve dataset information.", + "in": "path", + "name": "v15DatamoverDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve dataset information.", + "schema": { + "$ref": "#/definitions/v15DatamoverDatasetsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/historical-jobs": { + "delete": { + "description": "List/Delete finished jobs based on their end time. Capped at 1000. If 'after-time' is specified, latest 1000 jobs ended after this time will be listed/deleted. If 'after-time' is not specified, latest 1000 jobs finished in last 24 hours will be listed/deleted.", + "operationId": "deleteDatamoverv15DatamoverHistoricalJobs", + "parameters": [ + { + "description": "The time in '%Y-%m-%d %H:%M:%S' format. The year range is 2001-2099.", + "in": "query", + "maxLength": 19, + "minLength": 14, + "name": "after_time", + "pattern": "20[0-9][0-9]-1[0-2]|[1-9]-3[01]|[12][0-9]|0?[1-9] 2[0-3]|1[0-9]|0?[0-9]:[0-5]?[0-9]:[0-5]?[0-9]", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "get": { + "description": "List/Delete finished jobs based on their end time. Capped at 1000. If 'after-time' is specified, latest 1000 jobs ended after this time will be listed/deleted. If 'after-time' is not specified, latest 1000 jobs finished in last 24 hours will be listed/deleted.", + "operationId": "getDatamoverv15DatamoverHistoricalJobs", + "parameters": [ + { + "description": "The time in '%Y-%m-%d %H:%M:%S' format. The year range is 2001-2099.", + "in": "query", + "maxLength": 19, + "minLength": 14, + "name": "after_time", + "pattern": "20[0-9][0-9]-1[0-2]|[1-9]-3[01]|[12][0-9]|0?[1-9] 2[0-3]|1[0-9]|0?[0-9]:[0-5]?[0-9]:[0-5]?[0-9]", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List/Delete finished jobs based on their end time. Capped at 1000. If 'after-time' is specified, latest 1000 jobs ended after this time will be listed/deleted. If 'after-time' is not specified, latest 1000 jobs finished in last 24 hours will be listed/deleted.", + "schema": { + "$ref": "#/definitions/v15DatamoverHistoricalJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/jobs": { + "get": { + "description": "List all jobs.", + "operationId": "getDatamoverv15DatamoverJobs", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all jobs.", + "schema": { + "$ref": "#/definitions/v15DatamoverJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/jobs/{v15DatamoverJobId}": { + "get": { + "description": "Retrieve job information.", + "operationId": "getDatamoverv15DatamoverJob", + "parameters": [ + { + "description": "Retrieve job information.", + "in": "path", + "name": "v15DatamoverJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve job information.", + "schema": { + "$ref": "#/definitions/v15DatamoverJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify job state.", + "operationId": "updateDatamoverv15DatamoverJob", + "parameters": [ + { + "description": "Job control request.", + "enum": [ + "PAUSE_JOB", + "RESUME_JOB", + "CANCEL_JOB", + "COMPLETE_PARTIAL_JOB" + ], + "in": "query", + "name": "action", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "v15DatamoverJob", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "description": "Modify job state.", + "in": "path", + "name": "v15DatamoverJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/policies": { + "get": { + "description": "List all policies.", + "operationId": "listDatamoverv15DatamoverPolicies", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all policies.", + "schema": { + "$ref": "#/definitions/v15DatamoverPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "post": { + "description": "Create a new datamover policy.", + "operationId": "createDatamoverv15DatamoverPolicy", + "parameters": [ + { + "in": "body", + "name": "v15DatamoverPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v15DatamoverPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a new datamover policy.", + "schema": { + "$ref": "#/definitions/Createv15DatamoverBasePolicyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/policies/{v15DatamoverPolicyId}": { + "delete": { + "description": "Delete the policy.", + "operationId": "deleteDatamoverv15DatamoverPolicy", + "parameters": [ + { + "description": "Delete the policy.", + "in": "path", + "name": "v15DatamoverPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "get": { + "description": "Retrieve policy information.", + "operationId": "getDatamoverv15DatamoverPolicy", + "parameters": [ + { + "description": "Retrieve policy information.", + "in": "path", + "name": "v15DatamoverPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve policy information.", + "schema": { + "$ref": "#/definitions/v15DatamoverPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify policy information.", + "operationId": "updateDatamoverv15DatamoverPolicy", + "parameters": [ + { + "in": "body", + "name": "v15DatamoverPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v15DatamoverPolicyExtendedExtended" + } + }, + { + "description": "Modify policy information.", + "in": "path", + "name": "v15DatamoverPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/throttling/bw-rules": { + "get": { + "description": "List all bandwidth throttling rules.", + "operationId": "listDatamoverv15ThrottlingBwRules", + "parameters": [], + "responses": { + "200": { + "description": "List all bandwidth throttling rules.", + "schema": { + "$ref": "#/definitions/v15ThrottlingBwRules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "post": { + "description": "Create a new bandwidth throttling rule.", + "operationId": "createDatamoverv15ThrottlingBwRule", + "parameters": [ + { + "in": "body", + "name": "v15ThrottlingBwRule", + "required": true, + "schema": { + "$ref": "#/definitions/v15ThrottlingBwRule" + } + } + ], + "responses": { + "200": { + "description": "Create a new bandwidth throttling rule.", + "schema": { + "$ref": "#/definitions/Createv15ThrottlingBwRuleResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/throttling/bw-rules/{v15ThrottlingBwRuleId}": { + "delete": { + "description": "Delete a bandwidth throttling rule.", + "operationId": "deleteDatamoverv15ThrottlingBwRule", + "parameters": [ + { + "description": "Delete a bandwidth throttling rule.", + "in": "path", + "name": "v15ThrottlingBwRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "get": { + "description": "Retrieve a bandwidth throttling rule.", + "operationId": "getDatamoverv15ThrottlingBwRule", + "parameters": [ + { + "description": "Retrieve a bandwidth throttling rule.", + "in": "path", + "name": "v15ThrottlingBwRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a bandwidth throttling rule.", + "schema": { + "$ref": "#/definitions/v15ThrottlingBwRulesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify a bandwidth throttling rule.", + "operationId": "updateDatamoverv15ThrottlingBwRule", + "parameters": [ + { + "in": "body", + "name": "v15ThrottlingBwRule", + "required": true, + "schema": { + "$ref": "#/definitions/v15ThrottlingBwRuleExtended" + } + }, + { + "description": "Modify a bandwidth throttling rule.", + "in": "path", + "name": "v15ThrottlingBwRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/datamover/throttling/settings": { + "get": { + "description": "View Datamover throttling settings.", + "operationId": "getDatamoverv15ThrottlingSettings", + "parameters": [], + "responses": { + "200": { + "description": "View Datamover throttling settings.", + "schema": { + "$ref": "#/definitions/v15ThrottlingSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + }, + "put": { + "description": "Modify Datamover throttling settings.", + "operationId": "updateDatamoverv15ThrottlingSettings", + "parameters": [ + { + "in": "body", + "name": "v15ThrottlingSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v15ThrottlingSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Datamover" + ] + } + }, + "/platform/15/event/alert-conditions": { + "delete": { + "description": "Bulk delete of alert conditions.", + "operationId": "deleteEventv15EventAlertConditions", + "parameters": [ + { + "description": "Delete only conditions for this channel", + "in": "query", + "name": "channel", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "List all alert conditions.", + "operationId": "listEventv15EventAlertConditions", + "parameters": [ + { + "description": "Return only conditions for the specified channel:", + "in": "query", + "name": "channels", + "type": "string" + }, + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all alert conditions.", + "schema": { + "$ref": "#/definitions/v15EventAlertConditions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "post": { + "description": "Create a new alert condition.", + "operationId": "createEventv15EventAlertCondition", + "parameters": [ + { + "in": "body", + "name": "v15EventAlertCondition", + "required": true, + "schema": { + "$ref": "#/definitions/v15EventAlertCondition" + } + } + ], + "responses": { + "200": { + "description": "Create a new alert condition.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/15/event/alert-conditions/{v15EventAlertConditionId}": { + "delete": { + "description": "Delete the alert-condition.", + "operationId": "deleteEventv15EventAlertCondition", + "parameters": [ + { + "description": "Delete the alert-condition.", + "in": "path", + "name": "v15EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "Retrieve the alert-condition.", + "operationId": "getEventv15EventAlertCondition", + "parameters": [ + { + "description": "Retrieve the alert-condition.", + "in": "path", + "name": "v15EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the alert-condition.", + "schema": { + "$ref": "#/definitions/v15EventAlertConditionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify the alert-condition", + "operationId": "updateEventv15EventAlertCondition", + "parameters": [ + { + "in": "body", + "name": "v15EventAlertCondition", + "required": true, + "schema": { + "$ref": "#/definitions/v15EventAlertConditionExtended" + } + }, + { + "description": "Modify the alert-condition", + "in": "path", + "name": "v15EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/15/healthcheck/autoupdate": { + "get": { + "description": "The healthcheck autoupdate.", + "operationId": "getHealthcheckv15HealthcheckAutoupdate", + "parameters": [], + "responses": { + "200": { + "description": "The healthcheck autoupdate.", + "schema": { + "$ref": "#/definitions/v15HealthcheckAutoupdate" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/15/healthcheck/version": { + "get": { + "description": "The version number.", + "operationId": "getHealthcheckv15HealthcheckVersion", + "parameters": [], + "responses": { + "200": { + "description": "The version number.", + "schema": { + "$ref": "#/definitions/v15HealthcheckVersion" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/15/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{Pool}/status": { + "get": { + "description": "View the status of a single network pool.", + "operationId": "getNetworkGroupnetsSubnetsv15PoolsPoolStatus", + "parameters": [ + { + "description": "Whether or not OneFS should return all nodes configured in the network pool, even if SmartConnect doesn't detect any problem with the nodes. Default: only return nodes that can't be resolved via DNS.", + "in": "query", + "name": "show_all", + "type": "boolean" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View the status of a single network pool.", + "schema": { + "$ref": "#/definitions/v15PoolsPoolStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnetsSubnets" + ] + } + }, + "/platform/15/protocols/http/services": { + "get": { + "description": "Get detailed information for all remote HTTP services.", + "operationId": "getProtocolsv15HttpServices", + "parameters": [], + "responses": { + "200": { + "description": "Get detailed information for all remote HTTP services.", + "schema": { + "$ref": "#/definitions/v15HttpServices" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/15/protocols/http/services/{v15HttpServiceId}": { + "get": { + "description": "Get the HTTP service status.", + "operationId": "getProtocolsv15HttpService", + "parameters": [ + { + "description": "Get the HTTP service status.", + "in": "path", + "name": "v15HttpServiceId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get the HTTP service status.", + "schema": { + "$ref": "#/definitions/v15HttpServicesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HTTP services.", + "operationId": "updateProtocolsv15HttpService", + "parameters": [ + { + "in": "body", + "name": "v15HttpService", + "required": true, + "schema": { + "$ref": "#/definitions/v15HttpServiceExtended" + } + }, + { + "description": "Modify HTTP services.", + "in": "path", + "name": "v15HttpServiceId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/15/protocols/nfs/aliases": { + "get": { + "description": "List all NFS aliases.", + "operationId": "listProtocolsv15NfsAliases", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Check for conflicts when listing aliases.", + "in": "query", + "name": "check", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NFS aliases.", + "schema": { + "$ref": "#/definitions/v15NfsAliases" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new NFS alias.", + "operationId": "createProtocolsv15NfsAlias", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v15NfsAlias", + "required": true, + "schema": { + "$ref": "#/definitions/v15NfsAlias" + } + } + ], + "responses": { + "200": { + "description": "Create a new NFS alias.", + "schema": { + "$ref": "#/definitions/Createv15NfsAliasResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/15/protocols/s3/buckets": { + "get": { + "description": "List all buckets.", + "operationId": "listProtocolsv15S3Buckets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "Specifies the name of the owner.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "owner", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all buckets.", + "schema": { + "$ref": "#/definitions/v12S3Buckets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new bucket.", + "operationId": "createProtocolsv15S3Bucket", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v15S3Bucket", + "required": true, + "schema": { + "$ref": "#/definitions/v10S3Bucket" + } + } + ], + "responses": { + "200": { + "description": "Create a new bucket.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/15/quota/quotas": { + "delete": { + "description": "Delete all or matching quotas. For any query argument not supplied, the default behavior is return all.", + "operationId": "deleteQuotav15QuotaQuotas", + "parameters": [ + { + "description": "Only delete quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only delete quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only delete user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Only delete quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only delete quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "operationId": "listQuotav15QuotaQuotas", + "parameters": [ + { + "description": "Only list enforced quotas.", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only list quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If used with the path argument, match all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "If used with the path argument, match all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only list user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Set to true to only list quotas which have exceeded one or more of their thresholds.", + "in": "query", + "name": "exceeded", + "type": "boolean" + }, + { + "description": "Only list quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only list quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Use the named report as a source rather than the live quotas. See the /q/quota/reports resource for a list of valid reports.", + "in": "query", + "name": "report_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "schema": { + "$ref": "#/definitions/v15QuotaQuotas" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new quota.", + "operationId": "createQuotav15QuotaQuota", + "parameters": [ + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v15QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v15QuotaQuota" + } + } + ], + "responses": { + "200": { + "description": "Create a new quota.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/15/quota/quotas/{v15QuotaQuotaId}": { + "delete": { + "description": "Delete the quota.", + "operationId": "deleteQuotav15QuotaQuota", + "parameters": [ + { + "description": "Delete the quota.", + "in": "path", + "name": "v15QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve quota information.", + "operationId": "getQuotav15QuotaQuota", + "parameters": [ + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve quota information.", + "in": "path", + "name": "v15QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve quota information.", + "schema": { + "$ref": "#/definitions/v15QuotaQuotasExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav15QuotaQuota", + "parameters": [ + { + "in": "body", + "name": "v15QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v15QuotaQuotaExtendedExtended" + } + }, + { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v15QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/15/security/check": { + "get": { + "description": "Retrieve security check status properties.", + "operationId": "listSecurityv15SecurityCheck", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve security check status properties.", + "schema": { + "$ref": "#/definitions/v15SecurityCheck" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Security" + ] + }, + "post": { + "description": "Start the security check.", + "operationId": "createSecurityv15SecurityCheckItem", + "parameters": [ + { + "in": "body", + "name": "v15SecurityCheckItem", + "required": true, + "schema": { + "$ref": "#/definitions/v15SecurityCheckItem" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Security" + ] + } + }, + "/platform/15/security/check/report": { + "get": { + "description": "Retrieve security check report properties.", + "operationId": "getSecurityv15CheckReport", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve security check report properties.", + "schema": { + "$ref": "#/definitions/v15CheckReport" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Security" + ] + } + }, + "/platform/15/security/check/settings": { + "get": { + "description": "View the security check settings.", + "operationId": "getSecurityv15CheckSettings", + "parameters": [], + "responses": { + "200": { + "description": "View the security check settings.", + "schema": { + "$ref": "#/definitions/v15CheckSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Security" + ] + }, + "put": { + "description": "Modify the security check settings.", + "operationId": "updateSecurityv15CheckSettings", + "parameters": [ + { + "in": "body", + "name": "v15CheckSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v15CheckSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Security" + ] + } + }, + "/platform/15/security/settings": { + "get": { + "description": "Retrieve security properties.", + "operationId": "getSecurityv15SecuritySettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve security properties.", + "schema": { + "$ref": "#/definitions/v15SecuritySettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Security" + ] + }, + "put": { + "description": "Modify security properties.", + "operationId": "updateSecurityv15SecuritySettings", + "parameters": [ + { + "in": "body", + "name": "v15SecuritySettings", + "required": true, + "schema": { + "$ref": "#/definitions/v15SecuritySettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Security" + ] + } + }, + "/platform/15/sync/jobs": { + "delete": { + "description": "Cancel all SyncIQ jobs.", + "operationId": "deleteSyncv15SyncJobs", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "Get a list of SyncIQ jobs.", + "operationId": "listSyncv15SyncJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ jobs.", + "schema": { + "$ref": "#/definitions/v15SyncJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Start a SyncIQ job.", + "operationId": "createSyncv15SyncJob", + "parameters": [ + { + "in": "body", + "name": "v15SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v15SyncJob" + } + } + ], + "responses": { + "200": { + "description": "Start a SyncIQ job.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/15/sync/jobs/{v15SyncJobId}": { + "get": { + "description": "View a single SyncIQ job.", + "operationId": "getSyncv15SyncJob", + "parameters": [ + { + "description": "View a single SyncIQ job.", + "in": "path", + "name": "v15SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ job.", + "schema": { + "$ref": "#/definitions/v15SyncJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "operationId": "updateSyncv15SyncJob", + "parameters": [ + { + "in": "body", + "name": "v15SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncJobExtendedExtended" + } + }, + { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "in": "path", + "name": "v15SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/15/sync/reports": { + "get": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv15SyncReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "Return a summary rather than entire objects", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v15SyncReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/15/sync/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ subreports for a report.", + "operationId": "getSyncReportsv15ReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ subreports for a report.", + "schema": { + "$ref": "#/definitions/v15ReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncReports" + ] + } + }, + "/platform/15/sync/reports/{Rid}/subreports/{v15ReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ subreport.", + "operationId": "getSyncv15ReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ subreport.", + "in": "path", + "name": "v15ReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ subreport.", + "schema": { + "$ref": "#/definitions/v15ReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/15/sync/reports/{v15SyncReportId}": { + "get": { + "description": "View a single SyncIQ report.", + "operationId": "getSyncv15SyncReport", + "parameters": [ + { + "description": "View a single SyncIQ report.", + "in": "path", + "name": "v15SyncReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ report.", + "schema": { + "$ref": "#/definitions/v15SyncReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/15/sync/target/reports": { + "get": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv15TargetReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "Return a summary rather than entire objects.", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v15TargetReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/15/sync/target/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ target subreports for a report.", + "operationId": "getSyncTargetv15ReportsReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target subreports for a report.", + "schema": { + "$ref": "#/definitions/v15ReportsReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncTarget" + ] + } + }, + "/platform/15/sync/target/reports/{Rid}/subreports/{v15TargetReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ target subreport.", + "operationId": "getSyncv15TargetReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ target subreport.", + "in": "path", + "name": "v15TargetReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target subreport.", + "schema": { + "$ref": "#/definitions/v15TargetReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/15/sync/target/reports/{v15TargetReportId}": { + "get": { + "description": "View a single SyncIQ target report.", + "operationId": "getSyncv15TargetReport", + "parameters": [ + { + "description": "View a single SyncIQ target report.", + "in": "path", + "name": "v15TargetReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target report.", + "schema": { + "$ref": "#/definitions/v15TargetReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/2/cluster/external-ips": { + "get": { + "description": "Retrieve the cluster IP addresses including IPV4 and IPV6.", + "operationId": "getClusterv2ClusterExternalIps", + "parameters": [], + "responses": { + "200": { + "description": "The list of the cluster's external IP addresses including IPV4 and IPV6.", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/2/protocols/nfs/aliases": { + "get": { + "description": "List all NFS aliases.", + "operationId": "listProtocolsv2NfsAliases", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Check for conflicts when listing aliases.", + "in": "query", + "name": "check", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NFS aliases.", + "schema": { + "$ref": "#/definitions/v15NfsAliases" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new NFS alias.", + "operationId": "createProtocolsv2NfsAlias", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v2NfsAlias", + "required": true, + "schema": { + "$ref": "#/definitions/v2NfsAlias" + } + } + ], + "responses": { + "200": { + "description": "Create a new NFS alias.", + "schema": { + "$ref": "#/definitions/Createv15NfsAliasResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/aliases/{v2NfsAliasId}": { + "delete": { + "description": "Delete the export.", + "operationId": "deleteProtocolsv2NfsAlias", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the export.", + "in": "path", + "name": "v2NfsAliasId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve export information.", + "operationId": "getProtocolsv2NfsAlias", + "parameters": [ + { + "description": "When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Check for conflicts when viewing alias.", + "in": "query", + "name": "check", + "type": "boolean" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve export information.", + "in": "path", + "name": "v2NfsAliasId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve export information.", + "schema": { + "$ref": "#/definitions/v2NfsAliases" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the alias. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv2NfsAlias", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v2NfsAlias", + "required": true, + "schema": { + "$ref": "#/definitions/v2NfsAliasExtended" + } + }, + { + "description": "Modify the alias. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v2NfsAliasId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/check": { + "get": { + "description": "Retrieve NFS export validation information.", + "operationId": "getProtocolsv2NfsCheck", + "parameters": [ + { + "description": "Ignore nonexistent or otherwise bad paths.", + "in": "query", + "name": "ignore_bad_paths", + "type": "boolean" + }, + { + "description": "Ignore invalid users.", + "in": "query", + "name": "ignore_bad_auth", + "type": "boolean" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Ignore unresolvable hosts.", + "in": "query", + "name": "ignore_unresolvable_hosts", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Retrieve NFS export validation information.", + "schema": { + "$ref": "#/definitions/v1NfsCheckExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/exports": { + "get": { + "description": "List all NFS exports.", + "operationId": "listProtocolsv2NfsExports", + "parameters": [ + { + "description": "The field that will be used for sorting. Default is id.", + "enum": [ + "id", + "paths", + "description" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "If specified, only exports that explicitly reference at least one of the given paths will be returned.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Check for conflicts when listing exports.", + "in": "query", + "name": "check", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NFS exports.", + "schema": { + "$ref": "#/definitions/v2NfsExports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new NFS export.", + "operationId": "createProtocolsv2NfsExport", + "parameters": [ + { + "description": "If true, the export will be created even if it conflicts with another export.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Ignore unresolvable hosts.", + "in": "query", + "name": "ignore_unresolvable_hosts", + "type": "boolean" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Ignore conflicts with existing exports.", + "in": "query", + "name": "ignore_conflicts", + "type": "boolean" + }, + { + "description": "Ignore nonexistent or otherwise bad paths.", + "in": "query", + "name": "ignore_bad_paths", + "type": "boolean" + }, + { + "description": "Ignore invalid users.", + "in": "query", + "name": "ignore_bad_auth", + "type": "boolean" + }, + { + "in": "body", + "name": "v2NfsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v2NfsExport" + } + } + ], + "responses": { + "200": { + "description": "Create a new NFS export.", + "schema": { + "$ref": "#/definitions/Createv3EventEventResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/exports-summary": { + "get": { + "description": "Retrieve NFS export summary information.", + "operationId": "getProtocolsv2NfsExportsSummary", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve NFS export summary information.", + "schema": { + "$ref": "#/definitions/v1NfsExportsSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/exports/{v2NfsExportId}": { + "delete": { + "description": "Delete the export.", + "operationId": "deleteProtocolsv2NfsExport", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the export.", + "in": "path", + "name": "v2NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve export information.", + "operationId": "getProtocolsv2NfsExport", + "parameters": [ + { + "description": "When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve export information.", + "in": "path", + "name": "v2NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve export information.", + "schema": { + "$ref": "#/definitions/v2NfsExportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the export. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv2NfsExport", + "parameters": [ + { + "description": "If true, the export will be updated even if that change conflicts with another export.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Ignore unresolvable hosts.", + "in": "query", + "name": "ignore_unresolvable_hosts", + "type": "boolean" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Ignore conflicts with existing exports.", + "in": "query", + "name": "ignore_conflicts", + "type": "boolean" + }, + { + "description": "Ignore nonexistent or otherwise bad paths.", + "in": "query", + "name": "ignore_bad_paths", + "type": "boolean" + }, + { + "description": "Ignore invalid users.", + "in": "query", + "name": "ignore_bad_auth", + "type": "boolean" + }, + { + "in": "body", + "name": "v2NfsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v2NfsExportExtendedExtended" + } + }, + { + "description": "Modify the export. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v2NfsExportId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/nlm/locks": { + "get": { + "description": "List all NLM locks.", + "operationId": "getProtocolsv2NfsNlmLocks", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return locks created after the specified unix epoch time.", + "in": "query", + "name": "created", + "type": "string" + }, + { + "description": "Filter locks by the specified LIN in /ifs that is locked.", + "in": "query", + "name": "lin", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter locks by the specified client host name and IP address.", + "in": "query", + "name": "client", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter locks by the specified client ID.", + "in": "query", + "name": "client_id", + "type": "string" + }, + { + "description": "Filter locks by the specified path under /ifs.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NLM locks.", + "schema": { + "$ref": "#/definitions/v2NfsNlmLocks" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/nlm/sessions": { + "get": { + "description": "List all NLM sessions.", + "operationId": "getProtocolsv2NfsNlmSessions", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NLM sessions.", + "schema": { + "$ref": "#/definitions/v2NfsNlmSessions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/nlm/sessions/{v2NfsNlmSessionId}": { + "delete": { + "description": "Delete an NLM session.", + "operationId": "deleteProtocolsv2NfsNlmSession", + "parameters": [ + { + "description": "Delete an NLM session.", + "in": "path", + "name": "v2NfsNlmSessionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/nlm/waiters": { + "get": { + "description": "List all NLM lock waiters.", + "operationId": "getProtocolsv2NfsNlmWaiters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NLM lock waiters.", + "schema": { + "$ref": "#/definitions/v2NfsNlmWaiters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/reload": { + "post": { + "description": "Reload default NFS export configuration.", + "operationId": "createProtocolsv2NfsReloadItem", + "parameters": [ + { + "in": "body", + "name": "v2NfsReloadItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Reload default NFS export configuration.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/settings/export": { + "get": { + "description": "Retrieve export information.", + "operationId": "getProtocolsv2NfsSettingsExport", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve export information.", + "schema": { + "$ref": "#/definitions/v2NfsSettingsExport" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the default values for NFS exports. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv2NfsSettingsExport", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v2NfsSettingsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v2NfsSettingsExportSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/2/protocols/nfs/settings/zone": { + "get": { + "description": "Retrieve the NFS server settings for this zone.", + "operationId": "getProtocolsv2NfsSettingsZone", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the NFS server settings for this zone.", + "schema": { + "$ref": "#/definitions/v2NfsSettingsZone" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the NFS server settings for this zone.", + "operationId": "updateProtocolsv2NfsSettingsZone", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v2NfsSettingsZone", + "required": true, + "schema": { + "$ref": "#/definitions/v2NfsSettingsZoneSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/antivirus/policies": { + "delete": { + "description": "Delete all antivirus scan policies.", + "operationId": "deleteAntivirusv3AntivirusPolicies", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "List antivirus scan policies.", + "operationId": "listAntivirusv3AntivirusPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List antivirus scan policies.", + "schema": { + "$ref": "#/definitions/v3AntivirusPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "post": { + "description": "Create new antivirus scan policies.", + "operationId": "createAntivirusv3AntivirusPolicy", + "parameters": [ + { + "in": "body", + "name": "v3AntivirusPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v3AntivirusPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create new antivirus scan policies.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/policies/{v3AntivirusPolicyId}": { + "delete": { + "description": "Delete an antivirus scan policy.", + "operationId": "deleteAntivirusv3AntivirusPolicy", + "parameters": [ + { + "description": "Delete an antivirus scan policy.", + "in": "path", + "name": "v3AntivirusPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "Retrieve one antivirus scan policy.", + "operationId": "getAntivirusv3AntivirusPolicy", + "parameters": [ + { + "description": "Retrieve one antivirus scan policy.", + "in": "path", + "name": "v3AntivirusPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus scan policy.", + "schema": { + "$ref": "#/definitions/v3AntivirusPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "put": { + "description": "Modify an antivirus scan policy.", + "operationId": "updateAntivirusv3AntivirusPolicy", + "parameters": [ + { + "in": "body", + "name": "v3AntivirusPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v3AntivirusPolicyExtendedExtended" + } + }, + { + "description": "Modify an antivirus scan policy.", + "in": "path", + "name": "v3AntivirusPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/quarantine/{v3AntivirusQuarantinePath}": { + "get": { + "description": "Retrieve the quarantine status of the file at the specified path.", + "operationId": "getAntivirusv3AntivirusQuarantinePath", + "parameters": [ + { + "description": "Retrieve the quarantine status of the file at the specified path.", + "in": "path", + "name": "v3AntivirusQuarantinePath", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the quarantine status of the file at the specified path.", + "schema": { + "$ref": "#/definitions/v3AntivirusQuarantine" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "put": { + "description": "Set the quarantine status of the file at the specified path. Use either an empty object {} in the request body or {\"quarantined\":true} to quarantine the file, and {\"quarantined\":false} to unquarantine the file.", + "operationId": "updateAntivirusv3AntivirusQuarantinePath", + "parameters": [ + { + "in": "body", + "name": "v3AntivirusQuarantinePathParams", + "required": true, + "schema": { + "$ref": "#/definitions/v3AntivirusQuarantinePathParams" + } + }, + { + "description": "Set the quarantine status of the file at the specified path. Use either an empty object {} in the request body or {\"quarantined\":true} to quarantine the file, and {\"quarantined\":false} to unquarantine the file.", + "in": "path", + "name": "v3AntivirusQuarantinePath", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/reports/scans": { + "delete": { + "description": "Delete antivirus scan reports, and any threat reports associated with those scans.", + "operationId": "deleteAntivirusv3ReportsScans", + "parameters": [ + { + "description": "An amount of time in seconds. If present, only reports older than this age are deleted.", + "in": "query", + "name": "age", + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "List antivirus scan reports.", + "operationId": "getAntivirusv3ReportsScans", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If present, only scan reports with this status will be returned.", + "enum": [ + "Finish", + "Succeeded", + "Failed", + "Cancelled", + "Started", + "Paused", + "Resumed", + "Pending" + ], + "in": "query", + "name": "status", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "If present, only reports for scans associated with this policy will be returned.", + "in": "query", + "name": "policy_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List antivirus scan reports.", + "schema": { + "$ref": "#/definitions/v3ReportsScans" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/reports/scans/{v3ReportsScanId}": { + "delete": { + "description": "Delete one antivirus scan report, and all of its associated threat reports.", + "operationId": "deleteAntivirusv3ReportsScan", + "parameters": [ + { + "description": "Delete one antivirus scan report, and all of its associated threat reports.", + "in": "path", + "name": "v3ReportsScanId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "Retrieve one antivirus scan report.", + "operationId": "getAntivirusv3ReportsScan", + "parameters": [ + { + "description": "Retrieve one antivirus scan report.", + "in": "path", + "name": "v3ReportsScanId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus scan report.", + "schema": { + "$ref": "#/definitions/v3ReportsScansExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/reports/threats": { + "get": { + "description": "List antivirus threat reports.", + "operationId": "getAntivirusv3ReportsThreats", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If present, only returns threat reports associated with the given scan report.", + "in": "query", + "name": "scan_id", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If present, only returns threat reports for the given file.", + "in": "query", + "name": "file", + "type": "string" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "If present, only returns threat reports with the given remediation.", + "in": "query", + "name": "remediation", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List antivirus threat reports.", + "schema": { + "$ref": "#/definitions/v3ReportsThreats" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/reports/threats/{v3ReportsThreatId}": { + "get": { + "description": "Retrieve one antivirus threat report.", + "operationId": "getAntivirusv3ReportsThreat", + "parameters": [ + { + "description": "Retrieve one antivirus threat report.", + "in": "path", + "name": "v3ReportsThreatId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus threat report.", + "schema": { + "$ref": "#/definitions/v3ReportsThreatsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/scan": { + "post": { + "description": "Manually scan a file.", + "operationId": "createAntivirusv3AntivirusScanItem", + "parameters": [ + { + "in": "body", + "name": "v3AntivirusScanItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3AntivirusScanItem" + } + } + ], + "responses": { + "200": { + "description": "Manually scan a file.", + "schema": { + "$ref": "#/definitions/Createv11AntivirusScanItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/servers": { + "delete": { + "description": "Delete all antivirus servers.", + "operationId": "deleteAntivirusv3AntivirusServers", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "List antivirus servers.", + "operationId": "listAntivirusv3AntivirusServers", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List antivirus servers.", + "schema": { + "$ref": "#/definitions/v3AntivirusServers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "post": { + "description": "Create new antivirus servers.", + "operationId": "createAntivirusv3AntivirusServer", + "parameters": [ + { + "in": "body", + "name": "v3AntivirusServer", + "required": true, + "schema": { + "$ref": "#/definitions/v3AntivirusServer" + } + } + ], + "responses": { + "200": { + "description": "Create new antivirus servers.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/servers/{v3AntivirusServerId}": { + "delete": { + "description": "Delete an antivirus server entry.", + "operationId": "deleteAntivirusv3AntivirusServer", + "parameters": [ + { + "description": "Delete an antivirus server entry.", + "in": "path", + "name": "v3AntivirusServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "get": { + "description": "Retrieve one antivirus server entry.", + "operationId": "getAntivirusv3AntivirusServer", + "parameters": [ + { + "description": "Retrieve one antivirus server entry.", + "in": "path", + "name": "v3AntivirusServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one antivirus server entry.", + "schema": { + "$ref": "#/definitions/v3AntivirusServersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "put": { + "description": "Modify an antivirus server entry.", + "operationId": "updateAntivirusv3AntivirusServer", + "parameters": [ + { + "in": "body", + "name": "v3AntivirusServer", + "required": true, + "schema": { + "$ref": "#/definitions/v3AntivirusServerExtendedExtended" + } + }, + { + "description": "Modify an antivirus server entry.", + "in": "path", + "name": "v3AntivirusServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/antivirus/settings": { + "get": { + "description": "Retrieve the Antivirus settings.", + "operationId": "getAntivirusv3AntivirusSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the Antivirus settings.", + "schema": { + "$ref": "#/definitions/v3AntivirusSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "put": { + "description": "Modify the Antivirus settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateAntivirusv3AntivirusSettings", + "parameters": [ + { + "in": "body", + "name": "v3AntivirusSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3AntivirusSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/3/audit/settings": { + "get": { + "description": "View per-Access Zone Audit settings.", + "operationId": "getAuditv3AuditSettings", + "parameters": [ + { + "description": "Access zone which contains audit settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "View per-Access Zone Audit settings.", + "schema": { + "$ref": "#/definitions/v3AuditSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "put": { + "description": "Modify per-Access Zone Audit settings.", + "operationId": "updateAuditv3AuditSettings", + "parameters": [ + { + "description": "Access zone which contains audit settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3AuditSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3AuditSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/3/audit/settings/global": { + "get": { + "description": "View Global Audit settings.", + "operationId": "getAuditv3SettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "View Global Audit settings.", + "schema": { + "$ref": "#/definitions/v1AuditSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "put": { + "description": "Modify Global Audit settings.", + "operationId": "updateAuditv3SettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v3SettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuditSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/3/auth/log-level": { + "get": { + "description": "Get the current authentications service and netlogon logging level.", + "operationId": "getAuthv3AuthLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Get the current authentications service and netlogon logging level.", + "schema": { + "$ref": "#/definitions/v3AuthLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Set the current authentication service and netlogon logging level.", + "operationId": "updateAuthv3AuthLogLevel", + "parameters": [ + { + "in": "body", + "name": "v3AuthLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v3AuthLogLevelExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/mapping/dump": { + "get": { + "description": "Retrieve all identity mappings (uid, gid, sid, and on-disk) for the supplied source persona.", + "operationId": "getAuthv3MappingDump", + "parameters": [ + { + "description": "Idmap should attempt to create missing identity mappings.", + "in": "query", + "name": "nocreate", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve all identity mappings (uid, gid, sid, and on-disk) for the supplied source persona.", + "schema": { + "$ref": "#/definitions/v3MappingDump" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/mapping/import": { + "put": { + "description": "Set or update a list of mappings between two personae.", + "operationId": "updateAuthv3MappingImport", + "parameters": [ + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Specify whether existing mappings should be replaced. The default behavior is to leave existing mappings intact and return an error.", + "in": "query", + "name": "replace", + "type": "boolean" + }, + { + "in": "body", + "name": "v3MappingImport", + "required": true, + "schema": { + "$ref": "#/definitions/v3MappingDump" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/ads": { + "get": { + "description": "List all ADS providers.", + "operationId": "listAuthv3ProvidersAds", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS providers.", + "schema": { + "$ref": "#/definitions/v3ProvidersAds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new ADS provider.", + "operationId": "createAuthv3ProvidersAdsItem", + "parameters": [ + { + "in": "body", + "name": "v3ProvidersAdsItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersAdsItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new ADS provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/ads/{Id}/controllers": { + "get": { + "description": "List all ADS controllers.", + "operationId": "getAuthProvidersv3AdsProviderControllers", + "parameters": [ + { + "description": "Domain Controller site name", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "dc_site", + "type": "string" + }, + { + "description": "Groupnet identifier", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS controllers.", + "schema": { + "$ref": "#/definitions/v1AdsProviderControllers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthProviders" + ] + } + }, + "/platform/3/auth/providers/ads/{Id}/domains": { + "get": { + "description": "List all ADS domains.", + "operationId": "getAuthProvidersv3AdsProviderDomains", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS domains.", + "schema": { + "$ref": "#/definitions/v3AdsProviderDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthProviders" + ] + } + }, + "/platform/3/auth/providers/ads/{Id}/domains/{v3ProvidersAdsIdDomainId}": { + "get": { + "description": "Retrieve the ADS domain information.", + "operationId": "getAuthv3ProvidersAdsIdDomain", + "parameters": [ + { + "description": "Retrieve the ADS domain information.", + "in": "path", + "name": "v3ProvidersAdsIdDomainId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ADS domain information.", + "schema": { + "$ref": "#/definitions/v3AdsProviderDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/ads/{v3ProvidersAdsId}": { + "delete": { + "description": "Delete the ADS provider.", + "operationId": "deleteAuthv3ProvidersAdsById", + "parameters": [ + { + "description": "Delete the ADS provider.", + "in": "path", + "name": "v3ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the ADS provider.", + "operationId": "getAuthv3ProvidersAdsById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the ADS provider.", + "in": "path", + "name": "v3ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ADS provider.", + "schema": { + "$ref": "#/definitions/v3ProvidersAdsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the ADS provider.", + "operationId": "updateAuthv3ProvidersAdsById", + "parameters": [ + { + "in": "body", + "name": "v3ProvidersAdsIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersAdsIdParams" + } + }, + { + "description": "Modify the ADS provider.", + "in": "path", + "name": "v3ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/krb5": { + "get": { + "description": "List all KRB5 providers.", + "operationId": "listAuthv3ProvidersKrb5", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all KRB5 providers.", + "schema": { + "$ref": "#/definitions/v3ProvidersKrb5" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new KRB5 provider.", + "operationId": "createAuthv3ProvidersKrb5Item", + "parameters": [ + { + "in": "body", + "name": "v3ProvidersKrb5Item", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersKrb5Item" + } + } + ], + "responses": { + "200": { + "description": "Create a new KRB5 provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/krb5/{v3ProvidersKrb5Id}": { + "delete": { + "description": "Delete the KRB5 provider.", + "operationId": "deleteAuthv3ProvidersKrb5ById", + "parameters": [ + { + "description": "Delete the KRB5 provider.", + "in": "path", + "name": "v3ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the KRB5 provider.", + "operationId": "getAuthv3ProvidersKrb5ById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the KRB5 provider.", + "in": "path", + "name": "v3ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the KRB5 provider.", + "schema": { + "$ref": "#/definitions/v3ProvidersKrb5Extended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the KRB5 provider.", + "operationId": "updateAuthv3ProvidersKrb5ById", + "parameters": [ + { + "in": "body", + "name": "v3ProvidersKrb5IdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersKrb5IdParams" + } + }, + { + "description": "Modify the KRB5 provider.", + "in": "path", + "name": "v3ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/ldap": { + "get": { + "description": "List all LDAP providers.", + "operationId": "listAuthv3ProvidersLdap", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all LDAP providers.", + "schema": { + "$ref": "#/definitions/v3ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new LDAP provider.", + "operationId": "createAuthv3ProvidersLdapItem", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v3ProvidersLdapItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersLdapItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new LDAP provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/ldap/{v3ProvidersLdapId}": { + "delete": { + "description": "Delete the LDAP provider.", + "operationId": "deleteAuthv3ProvidersLdapById", + "parameters": [ + { + "description": "Delete the LDAP provider.", + "in": "path", + "name": "v3ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the LDAP provider.", + "operationId": "getAuthv3ProvidersLdapById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the LDAP provider.", + "in": "path", + "name": "v3ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the LDAP provider.", + "schema": { + "$ref": "#/definitions/v3ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the LDAP provider.", + "operationId": "updateAuthv3ProvidersLdapById", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v3ProvidersLdapIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersLdapIdParams" + } + }, + { + "description": "Modify the LDAP provider.", + "in": "path", + "name": "v3ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/nis": { + "get": { + "description": "List all NIS providers.", + "operationId": "listAuthv3ProvidersNis", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NIS providers.", + "schema": { + "$ref": "#/definitions/v3ProvidersNis" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new NIS provider.", + "operationId": "createAuthv3ProvidersNisItem", + "parameters": [ + { + "in": "body", + "name": "v3ProvidersNisItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersNisItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new NIS provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/nis/{v3ProvidersNisId}": { + "delete": { + "description": "Delete the NIS provider.", + "operationId": "deleteAuthv3ProvidersNisById", + "parameters": [ + { + "description": "Delete the NIS provider.", + "in": "path", + "name": "v3ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the NIS provider.", + "operationId": "getAuthv3ProvidersNisById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the NIS provider.", + "in": "path", + "name": "v3ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the NIS provider.", + "schema": { + "$ref": "#/definitions/v3ProvidersNis" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the NIS provider.", + "operationId": "updateAuthv3ProvidersNisById", + "parameters": [ + { + "in": "body", + "name": "v3ProvidersNisIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersNisIdParams" + } + }, + { + "description": "Modify the NIS provider.", + "in": "path", + "name": "v3ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/providers/summary": { + "get": { + "description": "Retrieve the summary information.", + "operationId": "getAuthv3ProvidersSummary", + "parameters": [ + { + "description": "Filter providers by groupnet.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "Filter providers by zone.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the summary information.", + "schema": { + "$ref": "#/definitions/v3ProvidersSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/refresh": { + "post": { + "description": "Refresh the authentication service configuration.", + "operationId": "createAuthv3AuthRefreshItem", + "parameters": [ + { + "in": "body", + "name": "v3AuthRefreshItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Refresh the authentication service configuration.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/settings/acls": { + "get": { + "description": "Retrieve the ACL policy settings and preset configurations.", + "operationId": "getAuthv3SettingsAcls", + "parameters": [ + { + "description": "If specified the preset configuration values for all applicable ACL policies are returned.", + "enum": [ + "balanced", + "unix", + "windows" + ], + "in": "query", + "name": "preset", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ACL policy settings and preset configurations.", + "schema": { + "$ref": "#/definitions/v3SettingsAcls" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify cluster ACL policy settings.", + "operationId": "updateAuthv3SettingsAcls", + "parameters": [ + { + "in": "body", + "name": "v3SettingsAcls", + "required": true, + "schema": { + "$ref": "#/definitions/v3SettingsAclsAclPolicySettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/auth/users/{User}/change-password": { + "put": { + "description": "Change the user's password.", + "operationId": "updateAuthUsersv3UserChangePassword", + "parameters": [ + { + "description": "Specifies access zone containing user.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3UserChangePassword", + "required": true, + "schema": { + "$ref": "#/definitions/v3UserChangePassword" + } + }, + { + "in": "path", + "name": "User", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthUsers" + ] + } + }, + "/platform/3/auth/users/{User}/member-of": { + "get": { + "description": "List all groups the user is a member of.", + "operationId": "listAuthUsersv3UserMemberOf", + "parameters": [ + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Filter groups by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter groups by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "path", + "name": "User", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all groups the user is a member of.", + "schema": { + "$ref": "#/definitions/v3UserMemberOf" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthUsers" + ] + }, + "post": { + "description": "Add the user to a group.", + "operationId": "createAuthUsersv3UserMemberOfItem", + "parameters": [ + { + "description": "Filter groups by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter groups by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v3UserMemberOfItem", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + { + "in": "path", + "name": "User", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add the user to a group.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthUsers" + ] + } + }, + "/platform/3/auth/users/{User}/member-of/{v3UsersUserMemberOfMemberOf}": { + "delete": { + "description": "Remove the user from the group.", + "operationId": "deleteAuthv3UsersUserMemberOfMemberOf", + "parameters": [ + { + "description": "Filter groups by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter groups by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Remove the user from the group.", + "in": "path", + "name": "v3UsersUserMemberOfMemberOf", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "User", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/3/cloud/access": { + "get": { + "description": "List all accessible cluster identifiers.", + "operationId": "listCloudv3CloudAccess", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all accessible cluster identifiers.", + "schema": { + "$ref": "#/definitions/v3CloudAccess" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "post": { + "description": "Add a cluster identifier to access list.", + "operationId": "createCloudv3CloudAccessItem", + "parameters": [ + { + "in": "body", + "name": "v3CloudAccessItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3CloudAccessItem" + } + } + ], + "responses": { + "200": { + "description": "Add a cluster identifier to access list.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cloud/access/{v3CloudAccessGuid}": { + "delete": { + "description": "Delete cloud access.", + "operationId": "deleteCloudv3CloudAccessGuid", + "parameters": [ + { + "description": "Delete cloud access.", + "in": "path", + "name": "v3CloudAccessGuid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "get": { + "description": "Retrieve cloud access information.", + "operationId": "getCloudv3CloudAccessGuid", + "parameters": [ + { + "description": "Retrieve cloud access information.", + "in": "path", + "name": "v3CloudAccessGuid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve cloud access information.", + "schema": { + "$ref": "#/definitions/v3CloudAccessExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cloud/jobs": { + "get": { + "description": "List all cloudpools jobs.", + "operationId": "listCloudv3CloudJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all cloudpools jobs.", + "schema": { + "$ref": "#/definitions/v3CloudJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "post": { + "description": "Create a new job.", + "operationId": "createCloudv3CloudJob", + "parameters": [ + { + "in": "body", + "name": "v3CloudJob", + "required": true, + "schema": { + "$ref": "#/definitions/v3CloudJob" + } + } + ], + "responses": { + "200": { + "description": "Create a new job.", + "schema": { + "$ref": "#/definitions/Createv3CloudJobResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cloud/jobs-files/{v3CloudJobsFileId}": { + "get": { + "description": "Retrieve files associated with a cloudpool job.", + "operationId": "getCloudv3CloudJobsFile", + "parameters": [ + { + "description": "The field that will be used for sorting. Output is limited to maximum of 100000 files.", + "enum": [ + "state", + "name" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Number of files to display; range from 1 to 100000.", + "in": "query", + "maximum": 100000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Specifies the starting entry to be displayed.", + "in": "query", + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "Used with limit option. If exists, specifies the starting page to display where page size is specified by limit. This option will be deprecated; please use offset option instead.", + "in": "query", + "minimum": 1, + "name": "page", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Retrieve files associated with a cloudpool job.", + "in": "path", + "name": "v3CloudJobsFileId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve files associated with a cloudpool job.", + "schema": { + "$ref": "#/definitions/v3CloudJobsFiles" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cloud/jobs/{v3CloudJobId}": { + "get": { + "description": "Retrieve cloudpool job information.", + "operationId": "getCloudv3CloudJob", + "parameters": [ + { + "description": "Retrieve cloudpool job information.", + "in": "path", + "name": "v3CloudJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve cloudpool job information.", + "schema": { + "$ref": "#/definitions/v3CloudJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "put": { + "description": "Modify a cloud job or operation.", + "operationId": "updateCloudv3CloudJob", + "parameters": [ + { + "in": "body", + "name": "v3CloudJob", + "required": true, + "schema": { + "$ref": "#/definitions/v3CloudJobExtendedExtended" + } + }, + { + "description": "Modify a cloud job or operation.", + "in": "path", + "name": "v3CloudJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cloud/settings": { + "get": { + "description": "List all cloud settings.", + "operationId": "getCloudv3CloudSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all cloud settings.", + "schema": { + "$ref": "#/definitions/v3CloudSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateCloudv3CloudSettings", + "parameters": [ + { + "in": "body", + "name": "v3CloudSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3CloudSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cloud/settings/encryption-key": { + "post": { + "description": "Regenerate master encryption key.", + "operationId": "createCloudv3SettingsEncryptionKeyItem", + "parameters": [ + { + "in": "body", + "name": "v3SettingsEncryptionKeyItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Regenerate master encryption key.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cloud/settings/reporting-eula": { + "delete": { + "description": "Revoke acceptance of telemetry collection EULA.", + "operationId": "deleteCloudv3SettingsReportingEula", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "get": { + "description": "View telemetry collection EULA acceptance and content URI.", + "operationId": "listCloudv3SettingsReportingEula", + "parameters": [], + "responses": { + "200": { + "description": "View telemetry collection EULA acceptance and content URI.", + "schema": { + "$ref": "#/definitions/v3SettingsReportingEula" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "post": { + "description": "Accept telemetry collection EULA.", + "operationId": "createCloudv3SettingsReportingEulaItem", + "parameters": [ + { + "in": "body", + "name": "v3SettingsReportingEulaItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Accept telemetry collection EULA.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/3/cluster/add-node": { + "post": { + "description": "Serial number and arguments of node to add.", + "operationId": "createClusterv3ClusterAddNodeItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterAddNodeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterAddNodeItem" + } + } + ], + "responses": { + "200": { + "description": "Serial number and arguments of node to add.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/config": { + "get": { + "description": "Retrieve the cluster information.", + "operationId": "getClusterv3ClusterConfig", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the cluster information.", + "schema": { + "$ref": "#/definitions/v3ClusterConfig" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/gather": { + "get": { + "description": "Get the status of isi_gather_info.", + "operationId": "getClusterv3DiagnosticsGather", + "parameters": [], + "responses": { + "200": { + "description": "Get the status of isi_gather_info.", + "schema": { + "$ref": "#/definitions/v3DiagnosticsGather" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/gather/settings": { + "get": { + "description": "Get the default options for isi_gather_info.", + "operationId": "getClusterv3DiagnosticsGatherSettings", + "parameters": [], + "responses": { + "200": { + "description": "Get the default options for isi_gather_info.", + "schema": { + "$ref": "#/definitions/v3DiagnosticsGatherSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Set the default options for isi_gather_info.", + "operationId": "updateClusterv3DiagnosticsGatherSettings", + "parameters": [ + { + "in": "body", + "name": "v3DiagnosticsGatherSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3DiagnosticsGatherSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/gather/start": { + "post": { + "description": "Start a new gather", + "operationId": "createClusterv3DiagnosticsGatherStartItem", + "parameters": [ + { + "in": "body", + "name": "v3DiagnosticsGatherStartItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3DiagnosticsGatherSettingsExtended" + } + } + ], + "responses": { + "200": { + "description": "Start a new gather", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/gather/status": { + "get": { + "description": "Get the status of isi_gather_info.", + "operationId": "getClusterv3DiagnosticsGatherStatus", + "parameters": [], + "responses": { + "200": { + "description": "Get the status of isi_gather_info.", + "schema": { + "$ref": "#/definitions/v3DiagnosticsGather" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/gather/stop": { + "post": { + "description": "Stop a running gather", + "operationId": "createClusterv3DiagnosticsGatherStopItem", + "parameters": [ + { + "in": "body", + "name": "v3DiagnosticsGatherStopItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Stop a running gather", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/netlogger": { + "get": { + "description": "Get the status of isi_netlogger.", + "operationId": "getClusterv3DiagnosticsNetlogger", + "parameters": [], + "responses": { + "200": { + "description": "Get the status of isi_netlogger.", + "schema": { + "$ref": "#/definitions/v3DiagnosticsNetlogger" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/netlogger/settings": { + "get": { + "description": "Get the default options for isi_netlogger.", + "operationId": "getClusterv3DiagnosticsNetloggerSettings", + "parameters": [], + "responses": { + "200": { + "description": "Get the default options for isi_netlogger.", + "schema": { + "$ref": "#/definitions/v3DiagnosticsNetloggerSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Set the default options for isi_netlogger.", + "operationId": "updateClusterv3DiagnosticsNetloggerSettings", + "parameters": [ + { + "in": "body", + "name": "v3DiagnosticsNetloggerSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3DiagnosticsNetloggerSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/netlogger/start": { + "post": { + "description": "Start a new packet capture", + "operationId": "createClusterv3DiagnosticsNetloggerStartItem", + "parameters": [ + { + "in": "body", + "name": "v3DiagnosticsNetloggerStartItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3DiagnosticsNetloggerSettingsSettings" + } + } + ], + "responses": { + "200": { + "description": "Start a new packet capture", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/netlogger/status": { + "get": { + "description": "Get the status of isi_netlogger.", + "operationId": "getClusterv3DiagnosticsNetloggerStatus", + "parameters": [], + "responses": { + "200": { + "description": "Get the status of isi_netlogger.", + "schema": { + "$ref": "#/definitions/v3DiagnosticsNetlogger" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/diagnostics/netlogger/stop": { + "post": { + "description": "Stop a running packet capture", + "operationId": "createClusterv3DiagnosticsNetloggerStopItem", + "parameters": [ + { + "in": "body", + "name": "v3DiagnosticsNetloggerStopItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Stop a running packet capture", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/identity": { + "get": { + "description": "Retrieve the login information.", + "operationId": "getClusterv3ClusterIdentity", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the login information.", + "schema": { + "$ref": "#/definitions/v1ClusterIdentity" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify the login information.", + "operationId": "updateClusterv3ClusterIdentity", + "parameters": [ + { + "in": "body", + "name": "v3ClusterIdentity", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterIdentity" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/nodes": { + "get": { + "description": "List the nodes on this cluster.", + "operationId": "getClusterv3ClusterNodes", + "parameters": [], + "responses": { + "200": { + "description": "List the nodes on this cluster.", + "schema": { + "format": "int64", + "$ref": "#/definitions/v3ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/nodes-available": { + "get": { + "description": "List all nodes that are available to add to this cluster.", + "operationId": "getClusterv3ClusterNodesAvailable", + "parameters": [], + "responses": { + "200": { + "description": "List all nodes that are available to add to this cluster.", + "schema": { + "$ref": "#/definitions/v3ClusterNodesAvailable" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives": { + "get": { + "description": "List the drives on this node.", + "operationId": "getClusterNodesv3NodeDrives", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List the drives on this node.", + "schema": { + "$ref": "#/definitions/v3NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives-purposelist": { + "get": { + "description": "Lists the available purposes for drives in this node.", + "operationId": "getClusterNodesv3NodeDrivesPurposelist", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Lists the available purposes for drives in this node.", + "schema": { + "$ref": "#/definitions/v3NodeDrivesPurposelist" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/add": { + "post": { + "description": "Add a drive to a node.", + "operationId": "createClusterNodesv3DrivesDriveAddItem", + "parameters": [ + { + "in": "body", + "name": "v3DrivesDriveAddItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a drive to a node.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/firmware": { + "get": { + "description": "Retrieve drive firmware information.", + "operationId": "getClusterNodesv3DrivesDriveFirmware", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve drive firmware information.", + "schema": { + "$ref": "#/definitions/v3DrivesDriveFirmware" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/firmware/update": { + "get": { + "description": "Retrieve firmware update information.", + "operationId": "listClusterNodesv3DrivesDriveFirmwareUpdate", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve firmware update information.", + "schema": { + "$ref": "#/definitions/v3DrivesDriveFirmwareUpdate" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "post": { + "description": "Start a drive firmware update.", + "operationId": "createClusterNodesv3DrivesDriveFirmwareUpdateItem", + "parameters": [ + { + "in": "body", + "name": "v3DrivesDriveFirmwareUpdateItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3DrivesDriveFirmwareUpdateItem" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Start a drive firmware update.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/format": { + "post": { + "description": "Format a drive for use by OneFS.", + "operationId": "createClusterNodesv3DrivesDriveFormatItem", + "parameters": [ + { + "in": "body", + "name": "v3DrivesDriveFormatItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3DrivesDriveFormatItem" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Format a drive for use by OneFS.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/purpose": { + "post": { + "description": "Assign a drive to a specific use case.", + "operationId": "createClusterNodesv3DrivesDrivePurposeItem", + "parameters": [ + { + "in": "body", + "name": "v3DrivesDrivePurposeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3DrivesDrivePurposeItem" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Assign a drive to a specific use case.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/smartfail": { + "post": { + "description": "Remove a drive from use by OneFS.", + "operationId": "createClusterNodesv3DrivesDriveSmartfailItem", + "parameters": [ + { + "in": "body", + "name": "v3DrivesDriveSmartfailItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Remove a drive from use by OneFS.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/stopfail": { + "post": { + "description": "Stop restriping from a smartfailing drive.", + "operationId": "createClusterNodesv3DrivesDriveStopfailItem", + "parameters": [ + { + "in": "body", + "name": "v3DrivesDriveStopfailItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Stop restriping from a smartfailing drive.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{Driveid}/suspend": { + "post": { + "description": "Temporarily remove a drive from use by OneFS.", + "operationId": "createClusterNodesv3DrivesDriveSuspendItem", + "parameters": [ + { + "in": "body", + "name": "v3DrivesDriveSuspendItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Temporarily remove a drive from use by OneFS.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/drives/{v3NodesLnnDriveId}": { + "get": { + "description": "Retrieve drive information.", + "operationId": "getClusterv3NodesLnnDrive", + "parameters": [ + { + "description": "Retrieve drive information.", + "in": "path", + "name": "v3NodesLnnDriveId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve drive information.", + "schema": { + "$ref": "#/definitions/v3NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/hardware": { + "get": { + "description": "Retrieve node hardware identity information.", + "operationId": "getClusterNodesv3NodeHardware", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node hardware identity information.", + "schema": { + "$ref": "#/definitions/v3NodeHardware" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/hardware-fast": { + "get": { + "description": "Quickly retrieve a subset of node hardware identity information.", + "operationId": "getClusterNodesv3NodeHardwareFast", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Quickly retrieve a subset of node hardware identity information.", + "schema": { + "$ref": "#/definitions/v3NodeHardwareFast" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/partitions": { + "get": { + "description": "Retrieve node partition information.", + "operationId": "getClusterNodesv3NodePartitions", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node partition information.", + "schema": { + "$ref": "#/definitions/v3NodePartitions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/reboot": { + "post": { + "description": "Reboot the node specified by .", + "operationId": "createClusterNodesv3NodeRebootItem", + "parameters": [ + { + "in": "body", + "name": "v3NodeRebootItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Reboot the node specified by .", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/sensors": { + "get": { + "description": "Retrieve node sensor information.", + "operationId": "getClusterNodesv3NodeSensors", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node sensor information.", + "schema": { + "$ref": "#/definitions/v3NodeSensors" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/shutdown": { + "post": { + "description": "Shutdown the node specified by .", + "operationId": "createClusterNodesv3NodeShutdownItem", + "parameters": [ + { + "in": "body", + "name": "v3NodeShutdownItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Shutdown the node specified by .", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/state": { + "get": { + "description": "Retrieve node state information.", + "operationId": "getClusterNodesv3NodeState", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node state information.", + "schema": { + "$ref": "#/definitions/v3NodeState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/state/readonly": { + "get": { + "description": "Retrieve node readonly state information.", + "operationId": "getClusterNodesv3NodeStateReadonly", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node readonly state information.", + "schema": { + "$ref": "#/definitions/v3NodeStateReadonly" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "put": { + "description": "Modify one or more node readonly state settings.", + "operationId": "updateClusterNodesv3NodeStateReadonly", + "parameters": [ + { + "in": "body", + "name": "v3NodeStateReadonly", + "required": true, + "schema": { + "$ref": "#/definitions/v10ClusterNodeStateReadonly" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/state/servicelight": { + "get": { + "description": "Retrieve node service light state information.", + "operationId": "getClusterNodesv3NodeStateServicelight", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node service light state information.", + "schema": { + "$ref": "#/definitions/v3NodeStateServicelight" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "put": { + "description": "Modify one or more node service light state settings.", + "operationId": "updateClusterNodesv3NodeStateServicelight", + "parameters": [ + { + "in": "body", + "name": "v3NodeStateServicelight", + "required": true, + "schema": { + "$ref": "#/definitions/v3NodeStateServicelightExtended" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/state/smartfail": { + "get": { + "description": "Retrieve node smartfail state information.", + "operationId": "getClusterNodesv3NodeStateSmartfail", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node smartfail state information.", + "schema": { + "$ref": "#/definitions/v3NodeStateSmartfail" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "put": { + "description": "Modify smartfail state of the node. Only the 'smartfailed' body member has any effect on node smartfail state.", + "operationId": "updateClusterNodesv3NodeStateSmartfail", + "parameters": [ + { + "in": "body", + "name": "v3NodeStateSmartfail", + "required": true, + "schema": { + "$ref": "#/definitions/v10ClusterNodeStateSmartfail" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/status": { + "get": { + "description": "Retrieve node status information.", + "operationId": "getClusterNodesv3NodeStatus", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node status information.", + "schema": { + "$ref": "#/definitions/v3NodeStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{Lnn}/status/batterystatus": { + "get": { + "description": "Retrieve node battery status information.", + "operationId": "getClusterNodesv3NodeStatusBatterystatus", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node battery status information.", + "schema": { + "$ref": "#/definitions/v3NodeStatusBatterystatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/3/cluster/nodes/{v3ClusterNodeId}": { + "get": { + "description": "Retrieve node information.", + "operationId": "getClusterv3ClusterNode", + "parameters": [ + { + "description": "Retrieve node information.", + "in": "path", + "name": "v3ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node information.", + "schema": { + "format": "int64", + "$ref": "#/definitions/v3ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify one or more node settings.", + "operationId": "updateClusterv3ClusterNode", + "parameters": [ + { + "in": "body", + "name": "v3ClusterNode", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterNodeExtended" + } + }, + { + "description": "Modify one or more node settings.", + "in": "path", + "name": "v3ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/time": { + "get": { + "description": "Retrieve the current time as reported by each node.", + "operationId": "getClusterv3ClusterTime", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the current time as reported by each node.", + "schema": { + "$ref": "#/definitions/v3ClusterTime" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Set cluster time. Time will mostly be synchronized across nodes, but there may be slight drift.", + "operationId": "updateClusterv3ClusterTime", + "parameters": [ + { + "in": "body", + "name": "v3ClusterTime", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterTimeExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/timezone": { + "get": { + "description": "Get the cluster timezone.", + "operationId": "getClusterv3ClusterTimezone", + "parameters": [], + "responses": { + "200": { + "description": "Get the cluster timezone.", + "schema": { + "$ref": "#/definitions/v3ClusterTimezone" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Set a new timezone for the cluster.", + "operationId": "updateClusterv3ClusterTimezone", + "parameters": [ + { + "in": "body", + "name": "v3ClusterTimezone", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterTimezoneExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/timezone/regions/{v3TimezoneRegionId}": { + "get": { + "description": "List timezone regions.", + "operationId": "getClusterv3TimezoneRegion", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Show all timezones within the region specified in the URI.", + "in": "query", + "name": "show_all", + "type": "boolean" + }, + { + "description": "This query arg is not needed in normal use cases.", + "in": "query", + "name": "dst_reset", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "List timezone regions.", + "in": "path", + "name": "v3TimezoneRegionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List timezone regions.", + "schema": { + "$ref": "#/definitions/v3TimezoneRegions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/timezone/settings": { + "get": { + "description": "Retrieve the cluster timezone.", + "operationId": "getClusterv3TimezoneSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the cluster timezone.", + "schema": { + "$ref": "#/definitions/v3TimezoneSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify the cluster timezone.", + "operationId": "updateClusterv3TimezoneSettings", + "parameters": [ + { + "in": "body", + "name": "v3TimezoneSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3TimezoneRegionTimezone" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/cluster/version": { + "get": { + "description": "Retrieve the OneFS version as reported by each node.", + "operationId": "getClusterv3ClusterVersion", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the OneFS version as reported by each node.", + "schema": { + "$ref": "#/definitions/v3ClusterVersion" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/3/event/alert-conditions": { + "delete": { + "description": "Bulk delete of alert conditions.", + "operationId": "deleteEventv3EventAlertConditions", + "parameters": [ + { + "description": "Delete only conditions for this channel", + "in": "query", + "name": "channel", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "List all alert conditions.", + "operationId": "listEventv3EventAlertConditions", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return only conditions for the specified channel:", + "in": "query", + "name": "channel_ids", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all alert conditions.", + "schema": { + "$ref": "#/definitions/v3EventAlertConditions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "post": { + "description": "Create a new alert condition.", + "operationId": "createEventv3EventAlertCondition", + "parameters": [ + { + "in": "body", + "name": "v3EventAlertCondition", + "required": true, + "schema": { + "$ref": "#/definitions/v3EventAlertCondition" + } + } + ], + "responses": { + "200": { + "description": "Create a new alert condition.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/alert-conditions/{v3EventAlertConditionId}": { + "delete": { + "description": "Delete the alert-condition.", + "operationId": "deleteEventv3EventAlertCondition", + "parameters": [ + { + "description": "Delete the alert-condition.", + "in": "path", + "name": "v3EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "Retrieve the alert-condition.", + "operationId": "getEventv3EventAlertCondition", + "parameters": [ + { + "description": "Retrieve the alert-condition.", + "in": "path", + "name": "v3EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the alert-condition.", + "schema": { + "$ref": "#/definitions/v3EventAlertConditionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify the alert-condition", + "operationId": "updateEventv3EventAlertCondition", + "parameters": [ + { + "in": "body", + "name": "v3EventAlertCondition", + "required": true, + "schema": { + "$ref": "#/definitions/v3EventAlertConditionExtended" + } + }, + { + "description": "Modify the alert-condition", + "in": "path", + "name": "v3EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/categories": { + "get": { + "description": "List all eventgroup categories.", + "operationId": "getEventv3EventCategories", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all eventgroup categories.", + "schema": { + "$ref": "#/definitions/v3EventCategories" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/categories/{v3EventCategoryId}": { + "get": { + "description": "Retrieve the eventgroup category.", + "operationId": "getEventv3EventCategory", + "parameters": [ + { + "description": "Retrieve the eventgroup category.", + "in": "path", + "name": "v3EventCategoryId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the eventgroup category.", + "schema": { + "$ref": "#/definitions/v3EventCategoriesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/channels": { + "get": { + "description": "List all channels.", + "operationId": "listEventv3EventChannels", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all channels.", + "schema": { + "$ref": "#/definitions/v3EventChannels" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "post": { + "description": "Create a new channel.", + "operationId": "createEventv3EventChannels", + "parameters": [ + { + "in": "body", + "name": "v3EventChannels", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventChannels" + } + } + ], + "responses": { + "200": { + "description": "Create a new channel.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/channels/{v3EventChannelId}": { + "delete": { + "description": "Delete the channel.", + "operationId": "deleteEventv3EventChannel", + "parameters": [ + { + "description": "Delete the channel.", + "in": "path", + "name": "v3EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "Retrieve the channel.", + "operationId": "getEventv3EventChannel", + "parameters": [ + { + "description": "Retrieve the channel.", + "in": "path", + "name": "v3EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the channel.", + "schema": { + "$ref": "#/definitions/v3EventChannelsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify the channel.", + "operationId": "updateEventv3EventChannel", + "parameters": [ + { + "in": "body", + "name": "v3EventChannel", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventChannelExtended" + } + }, + { + "description": "Modify the channel.", + "in": "path", + "name": "v3EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/eventgroup-definitions": { + "get": { + "description": "List all eventgroup definitions.", + "operationId": "getEventv3EventEventgroupDefinitions", + "parameters": [ + { + "description": "Return eventgroups in the specified category", + "in": "query", + "name": "category", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all eventgroup definitions.", + "schema": { + "$ref": "#/definitions/v3EventEventgroupDefinitions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/eventgroup-definitions/{v3EventEventgroupDefinitionId}": { + "get": { + "description": "Retrieve the eventgroup definition.", + "operationId": "getEventv3EventEventgroupDefinition", + "parameters": [ + { + "description": "Retrieve the eventgroup definition.", + "in": "path", + "name": "v3EventEventgroupDefinitionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the eventgroup definition.", + "schema": { + "$ref": "#/definitions/v3EventEventgroupDefinitionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/eventgroup-occurrences": { + "get": { + "description": "List all eventgroup occurrences.", + "operationId": "getEventv3EventEventgroupOccurrences", + "parameters": [ + { + "description": "Filter by resolved eventgroups.", + "in": "query", + "name": "resolved", + "type": "boolean" + }, + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Events that are in progress after this time.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Events that were in progress before this time.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Filter by severity.", + "in": "query", + "items": { + "enum": [ + "information", + "warning", + "critical", + "emergency" + ], + "type": "string" + }, + "name": "severity", + "type": "array" + }, + { + "description": "Events for which event_count > this.", + "in": "query", + "name": "event_count", + "type": "integer" + }, + { + "description": "Filter by devid.", + "in": "query", + "items": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": "devid", + "type": "array" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter by ignored eventgroups.", + "in": "query", + "name": "ignore", + "type": "boolean" + }, + { + "description": "Filter eventgroups by those that have last_event before this time.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "last_event_end", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter by partial long-cause description.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "partial_cause_long", + "type": "string" + }, + { + "description": "Filter by eventgroup resolver.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "resolver", + "type": "string" + }, + { + "description": "Filter by partial eventgroup id.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "partial_eventgroup_id", + "type": "string" + }, + { + "description": "Filter eventgroups by there associated event's event-type number.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "partial_event_type", + "type": "string" + }, + { + "description": "Filter by cause.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "cause", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Filter eventgroups by those that have last_event after this time.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "last_event_begin", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List all eventgroup occurrences.", + "schema": { + "$ref": "#/definitions/v3EventEventgroupOccurrences" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify all eventgroup occurrences, resolve or ignore all.", + "operationId": "updateEventv3EventEventgroupOccurrences", + "parameters": [ + { + "in": "body", + "name": "v3EventEventgroupOccurrences", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventEventgroupOccurrencesExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/eventgroup-occurrences/{v3EventEventgroupOccurrenceId}": { + "get": { + "description": "Retrieve individual eventgroup occurrence.", + "operationId": "getEventv3EventEventgroupOccurrence", + "parameters": [ + { + "description": "Retrieve individual eventgroup occurrence.", + "in": "path", + "name": "v3EventEventgroupOccurrenceId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve individual eventgroup occurrence.", + "schema": { + "$ref": "#/definitions/v3EventEventgroupOccurrencesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "modify eventgroup occurrence.", + "operationId": "updateEventv3EventEventgroupOccurrence", + "parameters": [ + { + "in": "body", + "name": "v3EventEventgroupOccurrence", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventEventgroupOccurrencesExtended" + } + }, + { + "description": "modify eventgroup occurrence.", + "in": "path", + "name": "v3EventEventgroupOccurrenceId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/eventlists": { + "get": { + "description": "List all event occurrences grouped by eventgroup occurrence.", + "operationId": "getEventv3EventEventlists", + "parameters": [ + { + "description": "Return only this event occurrence.", + "in": "query", + "name": "event_instance", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter by eventgroup id.", + "in": "query", + "items": { + "maximum": 2147483646, + "minimum": 1, + "type": "integer" + }, + "name": "eventgroup_id", + "type": "array" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all event occurrences grouped by eventgroup occurrence.", + "schema": { + "$ref": "#/definitions/v3EventEventlists" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/eventlists/{v3EventEventlistId}": { + "get": { + "description": "Retrieve the list of events for an eventgroup occurrence.", + "operationId": "getEventv3EventEventlist", + "parameters": [ + { + "description": "Retrieve the list of events for an eventgroup occurrence.", + "in": "path", + "name": "v3EventEventlistId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the list of events for an eventgroup occurrence.", + "schema": { + "$ref": "#/definitions/v3EventEventlistsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/events": { + "post": { + "description": "Create a test event.", + "operationId": "createEventv3EventEvent", + "parameters": [ + { + "in": "body", + "name": "v3EventEvent", + "required": true, + "schema": { + "$ref": "#/definitions/v3EventEvent" + } + } + ], + "responses": { + "200": { + "description": "Create a test event.", + "schema": { + "$ref": "#/definitions/Createv3EventEventResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/event/settings": { + "get": { + "description": "Retrieve the settings.", + "operationId": "getEventv3EventSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the settings.", + "schema": { + "$ref": "#/definitions/v3EventSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Update settings", + "operationId": "updateEventv3EventSettings", + "parameters": [ + { + "in": "body", + "name": "v3EventSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3EventSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/3/file-filter/settings": { + "get": { + "description": "View File Filtering settings of an access zone", + "operationId": "getFileFilterv3FileFilterSettings", + "parameters": [ + { + "description": "Specifies the access zones in which these settings apply.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "View File Filtering settings of an access zone", + "schema": { + "$ref": "#/definitions/v3FileFilterSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FileFilter" + ] + }, + "put": { + "description": "Modify one or more File Filtering settings for an access zone", + "operationId": "updateFileFilterv3FileFilterSettings", + "parameters": [ + { + "description": "Specifies the access zones in which these settings apply.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3FileFilterSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3FileFilterSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FileFilter" + ] + } + }, + "/platform/3/fsa/results": { + "get": { + "description": "List all results.", + "operationId": "getFsav3FsaResults", + "parameters": [], + "responses": { + "200": { + "description": "List all results.", + "schema": { + "$ref": "#/definitions/v3FsaResults" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/3/fsa/results/{Id}/directories": { + "get": { + "description": "This resource retrieves directory information. ID in the resource path is the result set ID.", + "operationId": "getFsaResultsv3ResultDirectories", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Primary directory path to report usage information, which may be specified instead of a LIN.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Limit the number of reported subdirectories.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves directory information. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultDirectories" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FsaResults" + ] + } + }, + "/platform/3/fsa/results/{Id}/directories/{v3ResultsIdDirectoryId}": { + "get": { + "description": "This resource retrieves directory information. ID in the resource path is the result set ID.", + "operationId": "getFsav3ResultsIdDirectory", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Limit the number of reported subdirectories.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "This resource retrieves directory information. ID in the resource path is the result set ID.", + "in": "path", + "name": "v3ResultsIdDirectoryId", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves directory information. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultsIdDirectories" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/3/fsa/results/{Id}/histogram": { + "get": { + "description": "This resource retrieves a histogram of file counts for an individual FSA result set. ID in the resource path is the result set ID.", + "operationId": "getFsaResultsv3ResultHistogram", + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves a histogram of file counts for an individual FSA result set. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultHistogram" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FsaResults" + ] + } + }, + "/platform/3/fsa/results/{Id}/histogram/{Stat}/by": { + "get": { + "description": "This resource retrieves a histogram breakout for an individual FSA result set. ID in the resource path is the result set ID.", + "operationId": "getFsaResultsv3HistogramStatBy", + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Stat", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves a histogram breakout for an individual FSA result set. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3HistogramStatBy" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FsaResults" + ] + } + }, + "/platform/3/fsa/results/{Id}/histogram/{Stat}/by/{v3ResultsIdHistogramStatByBreakout}": { + "get": { + "description": "This resource retrieves a histogram breakout for an individual FSA result set. ID in the resource path is the result set ID.", + "operationId": "getFsav3ResultsIdHistogramStatByBreakout", + "parameters": [ + { + "description": "Filter according to a specific directory, which includes all of its subdirectories.", + "in": "query", + "name": "directory_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a file user attribute.", + "in": "query", + "name": "attribute_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a node pool, which is a set of disk pools that belong to nodes of the same equivalence class.", + "in": "query", + "name": "node_pool_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a disk pool, which is a set of drives that represent an independent failure domain.", + "in": "query", + "name": "disk_pool_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a storage tier, which is a user-created set of node pools.", + "in": "query", + "name": "tier_filter", + "type": "string" + }, + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "Filter according to file logical size, where the filter value specifies the lower bound in bytes to a set of files that have been grouped by logical size. The list of valid log_size filter values may be found by performing a histogram breakout by log_size and viewing the resulting key values.", + "in": "query", + "name": "log_size_filter", + "type": "integer" + }, + { + "description": "Filter according to file physical size, where the filter value specifies the lower bound in bytes to a set of files that have been grouped by physical size. The list of valid phys_size filter values may be found by performing a histogram breakout by phys_size and viewing the resulting key values.", + "in": "query", + "name": "phys_size_filter", + "type": "integer" + }, + { + "description": "Limit the number of breakout results.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Filter according to the name of a single file extension.", + "in": "query", + "name": "path_ext_filter", + "type": "string" + }, + { + "description": "Filter according to file modified time, where the filter value specifies a negative number of seconds representing a time before the begin time of the report. The list of valid ctime filter values may be found by performing a histogram breakout by ctime and viewing the resulting key values.", + "in": "query", + "name": "ctime_filter", + "type": "integer" + }, + { + "description": "Filter according to file accessed time, where the filter value specifies a negative number of seconds representing a time before the begin time of the report. The list of valid atime filter values may be found by performing a histogram breakout by atime and viewing the resulting key values.", + "in": "query", + "name": "atime_filter", + "type": "integer" + }, + { + "description": "This resource retrieves a histogram breakout for an individual FSA result set. ID in the resource path is the result set ID.", + "in": "path", + "name": "v3ResultsIdHistogramStatByBreakout", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Stat", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves a histogram breakout for an individual FSA result set. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3HistogramStatBy" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/3/fsa/results/{Id}/histogram/{v3ResultsIdHistogramStat}": { + "get": { + "description": "This resource retrieves a histogram of file counts for an individual FSA result set. ID in the resource path is the result set ID.", + "operationId": "getFsav3ResultsIdHistogramStat", + "parameters": [ + { + "description": "Filter according to a specific directory, which includes all of its subdirectories.", + "in": "query", + "name": "directory_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a file user attribute.", + "in": "query", + "name": "attribute_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a node pool, which is a set of disk pools that belong to nodes of the same equivalence class.", + "in": "query", + "name": "node_pool_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a disk pool, which is a set of drives that represent an independent failure domain.", + "in": "query", + "name": "disk_pool_filter", + "type": "string" + }, + { + "description": "Filter according to the name of a storage tier, which is a user-created set of node pools.", + "in": "query", + "name": "tier_filter", + "type": "string" + }, + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "Filter according to file logical size, where the filter value specifies the lower bound in bytes to a set of files that have been grouped by logical size. The list of valid log_size filter values may be found by performing a histogram breakout by log_size and viewing the resulting key values.", + "in": "query", + "name": "log_size_filter", + "type": "integer" + }, + { + "description": "Filter according to file physical size, where the filter value specifies the lower bound in bytes to a set of files that have been grouped by physical size. The list of valid phys_size filter values may be found by performing a histogram breakout by phys_size and viewing the resulting key values.", + "in": "query", + "name": "phys_size_filter", + "type": "integer" + }, + { + "description": "Filter according to the name of a single file extension.", + "in": "query", + "name": "path_ext_filter", + "type": "string" + }, + { + "description": "Filter according to file modified time, where the filter value specifies a negative number of seconds representing a time before the begin time of the report. The list of valid ctime filter values may be found by performing a histogram breakout by ctime and viewing the resulting key values.", + "in": "query", + "name": "ctime_filter", + "type": "integer" + }, + { + "description": "Filter according to file accessed time, where the filter value specifies a negative number of seconds representing a time before the begin time of the report. The list of valid atime filter values may be found by performing a histogram breakout by atime and viewing the resulting key values.", + "in": "query", + "name": "atime_filter", + "type": "integer" + }, + { + "description": "This resource retrieves a histogram of file counts for an individual FSA result set. ID in the resource path is the result set ID.", + "in": "path", + "name": "v3ResultsIdHistogramStat", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves a histogram of file counts for an individual FSA result set. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultHistogram" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/3/fsa/results/{Id}/top-dirs": { + "get": { + "description": "This resource retrieves the top directories. ID in the resource path is the result set ID.", + "operationId": "getFsaResultsv3ResultTopDirs", + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves the top directories. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultTopDirs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FsaResults" + ] + } + }, + "/platform/3/fsa/results/{Id}/top-dirs/{v3ResultsIdTopDirId}": { + "get": { + "description": "This resource retrieves the top directories. ID in the resource path is the result set ID.", + "operationId": "getFsav3ResultsIdTopDir", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Starting index for results. Default value of 0.", + "in": "query", + "name": "start", + "type": "integer" + }, + { + "description": "Number of results from start index. Default value of 1000.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "This resource retrieves the top directories. ID in the resource path is the result set ID.", + "in": "path", + "name": "v3ResultsIdTopDirId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves the top directories. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultTopDirs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/3/fsa/results/{Id}/top-files": { + "get": { + "description": "This resource retrieves the top files. ID in the resource path is the result set ID.", + "operationId": "getFsaResultsv3ResultTopFiles", + "parameters": [ + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves the top files. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultTopFiles" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FsaResults" + ] + } + }, + "/platform/3/fsa/results/{Id}/top-files/{v3ResultsIdTopFileId}": { + "get": { + "description": "This resource retrieves the top files. ID in the resource path is the result set ID.", + "operationId": "getFsav3ResultsIdTopFile", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Starting index for results. Default value of 0.", + "in": "query", + "name": "start", + "type": "integer" + }, + { + "description": "Number of results from start index. Default value of 1000.", + "in": "query", + "name": "limit", + "type": "integer" + }, + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "This resource retrieves the top files. ID in the resource path is the result set ID.", + "in": "path", + "name": "v3ResultsIdTopFileId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This resource retrieves the top files. ID in the resource path is the result set ID.", + "schema": { + "$ref": "#/definitions/v3ResultTopFiles" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/3/fsa/results/{v3FsaResultId}": { + "delete": { + "description": "Delete the result set.", + "operationId": "deleteFsav3FsaResult", + "parameters": [ + { + "description": "Delete the result set.", + "in": "path", + "name": "v3FsaResultId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + }, + "get": { + "description": "Retrieve result set information.", + "operationId": "getFsav3FsaResult", + "parameters": [ + { + "description": "Retrieve result set information.", + "in": "path", + "name": "v3FsaResultId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve result set information.", + "schema": { + "$ref": "#/definitions/v3FsaResultsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + }, + "put": { + "description": "Modify result set. Only the pinned property can be changed at this time.", + "operationId": "updateFsav3FsaResult", + "parameters": [ + { + "in": "body", + "name": "v3FsaResult", + "required": true, + "schema": { + "$ref": "#/definitions/v3FsaResultExtended" + } + }, + { + "description": "Modify result set. Only the pinned property can be changed at this time.", + "in": "path", + "name": "v3FsaResultId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/3/hardening/apply": { + "post": { + "description": "Apply hardening on the cluster.", + "operationId": "createHardeningv3HardeningApplyItem", + "parameters": [ + { + "in": "body", + "name": "v3HardeningApplyItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3HardeningApplyItem" + } + } + ], + "responses": { + "200": { + "description": "Apply hardening on the cluster.", + "schema": { + "$ref": "#/definitions/Createv3HardeningApplyItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardening" + ] + } + }, + "/platform/3/hardening/resolve": { + "post": { + "description": "Resolve issues related to hardening, found in current cluster configuration.", + "operationId": "createHardeningv3HardeningResolveItem", + "parameters": [ + { + "description": "If true, execution proceeds to resolve all issues. If false, execution aborts. This is a required argument.", + "in": "query", + "name": "accept", + "type": "boolean" + }, + { + "in": "body", + "name": "v3HardeningResolveItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3HardeningResolveItem" + } + } + ], + "responses": { + "200": { + "description": "Resolve issues related to hardening, found in current cluster configuration.", + "schema": { + "$ref": "#/definitions/Createv3HardeningResolveItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardening" + ] + } + }, + "/platform/3/hardening/revert": { + "post": { + "description": "Revert hardening on the cluster.", + "operationId": "createHardeningv3HardeningRevertItem", + "parameters": [ + { + "description": "If specified, revert operation continues even in case of a failure. Default is false in which case revert stops at the first failure.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v3HardeningRevertItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Revert hardening on the cluster.", + "schema": { + "$ref": "#/definitions/Createv3HardeningRevertItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardening" + ] + } + }, + "/platform/3/hardening/state": { + "get": { + "description": "Get the state of the current hardening operation, if one is happening. Note that this is different from the /status resource, which returns the overall hardening status of the cluster.", + "operationId": "getHardeningv3HardeningState", + "parameters": [], + "responses": { + "200": { + "description": "Get the state of the current hardening operation, if one is happening. Note that this is different from the /status resource, which returns the overall hardening status of the cluster.", + "schema": { + "$ref": "#/definitions/v3HardeningState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardening" + ] + } + }, + "/platform/3/hardening/status": { + "get": { + "description": "Get a message indicating whether or not the cluster is hardened. Note that this is different from the /state resource, which returns the state of a specific hardening operation (apply or revert).", + "operationId": "getHardeningv3HardeningStatus", + "parameters": [], + "responses": { + "200": { + "description": "Get a message indicating whether or not the cluster is hardened. Note that this is different from the /state resource, which returns the state of a specific hardening operation (apply or revert).", + "schema": { + "$ref": "#/definitions/v3HardeningStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardening" + ] + } + }, + "/platform/3/hardware/fcports": { + "get": { + "description": "Get list of fibre-channel ports", + "operationId": "getHardwarev3HardwareFcports", + "parameters": [ + { + "description": "Logical node number.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get list of fibre-channel ports", + "schema": { + "$ref": "#/definitions/v3HardwareFcports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardware" + ] + } + }, + "/platform/3/hardware/fcports/{v3HardwareFcportId}": { + "get": { + "description": "Get one fibre-channel port", + "operationId": "getHardwarev3HardwareFcport", + "parameters": [ + { + "description": "Logical node number.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "description": "Get one fibre-channel port", + "in": "path", + "name": "v3HardwareFcportId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Get one fibre-channel port", + "schema": { + "$ref": "#/definitions/v3HardwareFcports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardware" + ] + }, + "put": { + "description": "Change wwnn, wwpn, state, topology, or rate of a FC port", + "operationId": "updateHardwarev3HardwareFcport", + "parameters": [ + { + "description": "Logical node number.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "in": "body", + "name": "v3HardwareFcport", + "required": true, + "schema": { + "$ref": "#/definitions/v3HardwareFcport" + } + }, + { + "description": "Change wwnn, wwpn, state, topology, or rate of a FC port", + "in": "path", + "name": "v3HardwareFcportId", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardware" + ] + } + }, + "/platform/3/hardware/tape/{v3HardwareTapeName}": { + "delete": { + "description": "Tape/Changer devices remove", + "operationId": "deleteHardwarev3HardwareTapeName", + "parameters": [ + { + "description": "Tape/Changer devices remove", + "in": "path", + "name": "v3HardwareTapeName", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardware" + ] + }, + "post": { + "description": "Tape/Changer devices rescan", + "operationId": "createHardwarev3HardwareTapeName", + "parameters": [ + { + "description": "Logical node number.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "description": "Scan only specified port.", + "in": "query", + "name": "port", + "type": "integer" + }, + { + "description": "Timeout for request.", + "in": "query", + "name": "timeout", + "type": "number" + }, + { + "description": "Remove entries for devices or paths that have become inaccessible.", + "in": "query", + "name": "reconcile", + "type": "boolean" + }, + { + "in": "body", + "name": "v3HardwareTapeName", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "description": "Tape/Changer devices rescan", + "in": "path", + "name": "v3HardwareTapeName", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Tape/Changer devices rescan", + "schema": { + "$ref": "#/definitions/Createv3HardwareTapeNameResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardware" + ] + }, + "put": { + "description": "Tape/Changer device modify", + "operationId": "updateHardwarev3HardwareTapeName", + "parameters": [ + { + "in": "body", + "name": "v3HardwareTapeNameParams", + "required": true, + "schema": { + "$ref": "#/definitions/v3HardwareTapeNameParams" + } + }, + { + "description": "Tape/Changer device modify", + "in": "path", + "name": "v3HardwareTapeName", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardware" + ] + } + }, + "/platform/3/hardware/tapes": { + "get": { + "description": "Get list Tape and Changer devices", + "operationId": "getHardwarev3HardwareTapes", + "parameters": [ + { + "description": "List only devices on the specified node.", + "in": "query", + "name": "node", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "List only the named device.", + "in": "query", + "name": "devname", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "List devices with only active paths.", + "in": "query", + "name": "activepath", + "type": "string" + }, + { + "description": "Restrict to list on tape or mc device.", + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get list Tape and Changer devices", + "schema": { + "$ref": "#/definitions/v3HardwareTapes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Hardware" + ] + } + }, + "/platform/3/healthcheck/checklists": { + "get": { + "description": "List checklists.", + "operationId": "getHealthcheckv3HealthcheckChecklists", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List checklists.", + "schema": { + "$ref": "#/definitions/v10HealthcheckChecklists" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/healthcheck/checklists/{v3HealthcheckChecklistId}": { + "get": { + "description": "Retrieve a checklist definition.", + "operationId": "getHealthcheckv3HealthcheckChecklist", + "parameters": [ + { + "description": "Retrieve a checklist definition.", + "in": "path", + "name": "v3HealthcheckChecklistId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a checklist definition.", + "schema": { + "$ref": "#/definitions/v10HealthcheckChecklistsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/healthcheck/evaluations": { + "get": { + "description": "List evaluations.", + "operationId": "listHealthcheckv3HealthcheckEvaluations", + "parameters": [ + { + "description": "Also return details for items that pass", + "in": "query", + "name": "detailed", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List evaluations.", + "schema": { + "$ref": "#/definitions/v3HealthcheckEvaluations" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "post": { + "description": "Request an evaluation.", + "operationId": "createHealthcheckv3HealthcheckEvaluation", + "parameters": [ + { + "in": "body", + "name": "v3HealthcheckEvaluation", + "required": true, + "schema": { + "$ref": "#/definitions/v3HealthcheckEvaluation" + } + } + ], + "responses": { + "200": { + "description": "Request an evaluation.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/healthcheck/evaluations/{v3HealthcheckEvaluationId}": { + "delete": { + "description": "Cancel an evaluation.", + "operationId": "deleteHealthcheckv3HealthcheckEvaluation", + "parameters": [ + { + "description": "Cancel an evaluation.", + "in": "path", + "name": "v3HealthcheckEvaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "get": { + "description": "Retrieve individual evaluation.", + "operationId": "getHealthcheckv3HealthcheckEvaluation", + "parameters": [ + { + "description": "Also return details for items that pass", + "in": "query", + "name": "detailed", + "type": "boolean" + }, + { + "description": "Retrieve individual evaluation.", + "in": "path", + "name": "v3HealthcheckEvaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve individual evaluation.", + "schema": { + "$ref": "#/definitions/v3HealthcheckEvaluationsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "put": { + "description": "Pause or resume an evaluation.", + "operationId": "updateHealthcheckv3HealthcheckEvaluation", + "parameters": [ + { + "in": "body", + "name": "v3HealthcheckEvaluation", + "required": true, + "schema": { + "$ref": "#/definitions/v10HealthcheckEvaluationExtendedExtended" + } + }, + { + "description": "Pause or resume an evaluation.", + "in": "path", + "name": "v3HealthcheckEvaluationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/healthcheck/items": { + "get": { + "description": "List items.", + "operationId": "getHealthcheckv3HealthcheckItems", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List items.", + "schema": { + "$ref": "#/definitions/v3HealthcheckItems" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/healthcheck/items/{v3HealthcheckItemId}": { + "get": { + "description": "Retrieve an item definition.", + "operationId": "getHealthcheckv3HealthcheckItem", + "parameters": [ + { + "description": "Retrieve an item definition.", + "in": "path", + "name": "v3HealthcheckItemId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve an item definition.", + "schema": { + "$ref": "#/definitions/v3HealthcheckItemsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/healthcheck/parameters": { + "get": { + "description": "List parameters.", + "operationId": "listHealthcheckv3HealthcheckParameters", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List parameters.", + "schema": { + "$ref": "#/definitions/v3HealthcheckParameters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "post": { + "description": "Create a parameter.", + "operationId": "createHealthcheckv3HealthcheckParameter", + "parameters": [ + { + "in": "body", + "name": "v3HealthcheckParameter", + "required": true, + "schema": { + "$ref": "#/definitions/v3HealthcheckParameter" + } + } + ], + "responses": { + "200": { + "description": "Create a parameter.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/healthcheck/parameters/{v3HealthcheckParameterId}": { + "delete": { + "description": "Delete a parameter.", + "operationId": "deleteHealthcheckv3HealthcheckParameter", + "parameters": [ + { + "description": "Delete a parameter.", + "in": "path", + "name": "v3HealthcheckParameterId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "get": { + "description": "Retrieve individual parameter.", + "operationId": "getHealthcheckv3HealthcheckParameter", + "parameters": [ + { + "description": "Retrieve individual parameter.", + "in": "path", + "name": "v3HealthcheckParameterId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve individual parameter.", + "schema": { + "$ref": "#/definitions/v3HealthcheckParametersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + }, + "put": { + "description": "Modify a parameter value.", + "operationId": "updateHealthcheckv3HealthcheckParameter", + "parameters": [ + { + "in": "body", + "name": "v3HealthcheckParameter", + "required": true, + "schema": { + "$ref": "#/definitions/v3HealthcheckParameterExtendedExtended" + } + }, + { + "description": "Modify a parameter value.", + "in": "path", + "name": "v3HealthcheckParameterId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Healthcheck" + ] + } + }, + "/platform/3/job/events": { + "get": { + "description": "List job events.", + "operationId": "getJobv3JobEvents", + "parameters": [ + { + "description": "Restrict the query to events at or after the given time, in seconds since the Epoch.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Restrict the query to events before the given time, in seconds since the Epoch.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Restrict the query to the given job ID.", + "in": "query", + "name": "job_id", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Restrict the query to the given job type.", + "in": "query", + "name": "job_type", + "type": "string" + }, + { + "description": "Query timeout in milliseconds. The default is 10000 ms.", + "in": "query", + "name": "timeout_ms", + "type": "integer" + }, + { + "description": "Restrict the query to events containing the given state. This parameter cannot be used with ended_jobs_only", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority", + "cancelled_user", + "cancelled_system", + "failed", + "succeeded", + "unknown", + "failed_not_retried" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Request all jobs that ended. This parameter cannot be used with the 'state' parameter. Ended states are 'cancelled_user', 'cancelled_system', 'failed' or 'succeeded'", + "in": "query", + "name": "ended_jobs_only", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Restrict the query to the given key name.", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List job events.", + "schema": { + "$ref": "#/definitions/v3JobEvents" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/3/job/jobs": { + "get": { + "description": "List running and paused jobs.", + "operationId": "listJobv3JobJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, other arguments are ignored, and the query will return all results, unsorted, as quickly as possible.", + "in": "query", + "name": "batch", + "type": "boolean" + }, + { + "description": "Limit the results to jobs in the specified state.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List running and paused jobs.", + "schema": { + "$ref": "#/definitions/v1JobJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "post": { + "description": "Queue a new instance of a job type.", + "operationId": "createJobv3JobJob", + "parameters": [ + { + "in": "body", + "name": "v3JobJob", + "required": true, + "schema": { + "$ref": "#/definitions/v3JobJob" + } + } + ], + "responses": { + "200": { + "description": "Queue a new instance of a job type.", + "schema": { + "$ref": "#/definitions/Createv1JobJobResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/3/job/jobs/{v3JobJobId}": { + "get": { + "description": "View a single job instance.", + "operationId": "getJobv3JobJob", + "parameters": [ + { + "description": "View a single job instance.", + "in": "path", + "name": "v3JobJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single job instance.", + "schema": { + "$ref": "#/definitions/v1JobJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "put": { + "description": "Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.", + "operationId": "updateJobv3JobJob", + "parameters": [ + { + "in": "body", + "name": "v3JobJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1JobJobExtendedExtended" + } + }, + { + "description": "Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v3JobJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/3/job/recent": { + "get": { + "description": "List recently completed jobs.", + "operationId": "getJobv3JobRecent", + "parameters": [ + { + "description": "Query timeout in milliseconds. The default is 10000 ms.", + "in": "query", + "name": "timeout_ms", + "type": "integer" + }, + { + "description": "Max number of recent jobs to return. The default is 8, the max is 100.", + "in": "query", + "name": "limit", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List recently completed jobs.", + "schema": { + "$ref": "#/definitions/v3JobRecent" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/3/job/reports": { + "get": { + "description": "List job reports.", + "operationId": "getJobv3JobReports", + "parameters": [ + { + "description": "Restrict the query to reports at or after the given time, in seconds since the Epoch.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Restrict the query to reports before the given time, in seconds since the Epoch.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Restrict the query to the given job ID.", + "in": "query", + "name": "job_id", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Restrict the query to the given job type.", + "in": "query", + "name": "job_type", + "type": "string" + }, + { + "description": "Query timeout in milliseconds. The default is 10000 ms.", + "in": "query", + "name": "timeout_ms", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Restrict the query to the given report key.", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "Display more detailed information, including job engine framework statistics.", + "in": "query", + "name": "verbose", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List job reports.", + "schema": { + "$ref": "#/definitions/v3JobReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/3/network/dnscache": { + "get": { + "description": "View network dns cache settings.", + "operationId": "getNetworkv3NetworkDnscache", + "parameters": [], + "responses": { + "200": { + "description": "View network dns cache settings.", + "schema": { + "$ref": "#/definitions/v3NetworkDnscache" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify network dns cache settings.", + "operationId": "updateNetworkv3NetworkDnscache", + "parameters": [ + { + "in": "body", + "name": "v3NetworkDnscache", + "required": true, + "schema": { + "$ref": "#/definitions/v3NetworkDnscacheExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/dnscache/flush": { + "post": { + "description": "Flush the DNSCache.", + "operationId": "createNetworkv3DnscacheFlushItem", + "parameters": [ + { + "in": "body", + "name": "v3DnscacheFlushItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Flush the DNSCache.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/external": { + "get": { + "description": "View external network settings.", + "operationId": "getNetworkv3NetworkExternal", + "parameters": [], + "responses": { + "200": { + "description": "View external network settings.", + "schema": { + "$ref": "#/definitions/v3NetworkExternal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify external network settings.", + "operationId": "updateNetworkv3NetworkExternal", + "parameters": [ + { + "in": "body", + "name": "v3NetworkExternal", + "required": true, + "schema": { + "$ref": "#/definitions/v3NetworkExternalExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/groupnets": { + "get": { + "description": "Get a list of groupnets.", + "operationId": "listNetworkv3NetworkGroupnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of groupnets.", + "schema": { + "$ref": "#/definitions/v3NetworkGroupnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "post": { + "description": "Create a new groupnet.", + "operationId": "createNetworkv3NetworkGroupnet", + "parameters": [ + { + "in": "body", + "name": "v3NetworkGroupnet", + "required": true, + "schema": { + "$ref": "#/definitions/v3NetworkGroupnet" + } + } + ], + "responses": { + "200": { + "description": "Create a new groupnet.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets": { + "get": { + "description": "Get a list of subnets.", + "operationId": "listNetworkGroupnetsv3GroupnetSubnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of subnets.", + "schema": { + "$ref": "#/definitions/v3GroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + }, + "post": { + "description": "Create a new subnet.", + "operationId": "createNetworkGroupnetsv3GroupnetSubnet", + "parameters": [ + { + "in": "body", + "name": "v3GroupnetSubnet", + "required": true, + "schema": { + "$ref": "#/definitions/v3GroupnetSubnet" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new subnet.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools": { + "get": { + "description": "Get a list of network pools.", + "operationId": "listNetworkGroupnetsv3SubnetsSubnetPools", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If specified, only pools with this zone name will be returned.", + "in": "query", + "name": "access_zone", + "type": "string" + }, + { + "description": "If specified, only pools with this allocation type will be returned.", + "enum": [ + "static", + "dynamic" + ], + "in": "query", + "name": "alloc_method", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of network pools.", + "schema": { + "$ref": "#/definitions/v3SubnetsSubnetPools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + }, + "post": { + "description": "Create a new pool.", + "operationId": "createNetworkGroupnetsv3SubnetsSubnetPool", + "parameters": [ + { + "description": "Force creating this pool even if it causes an MTU conflict.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v3SubnetsSubnetPool", + "required": true, + "schema": { + "$ref": "#/definitions/v3SubnetsSubnetPool" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new pool.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{Pool}/rebalance-ips": { + "post": { + "description": "Rebalance IP addresses in specified pool.", + "operationId": "createNetworkGroupnetsSubnetsv3PoolsPoolRebalanceIp", + "parameters": [ + { + "in": "body", + "name": "v3PoolsPoolRebalanceIp", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Rebalance IP addresses in specified pool.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnetsSubnets" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{Pool}/rules": { + "get": { + "description": "Get a list of network rules.", + "operationId": "listNetworkGroupnetsSubnetsv3PoolsPoolRules", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of network rules.", + "schema": { + "$ref": "#/definitions/v3PoolsPoolRules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnetsSubnets" + ] + }, + "post": { + "description": "Create a new rule.", + "operationId": "createNetworkGroupnetsSubnetsv3PoolsPoolRule", + "parameters": [ + { + "in": "body", + "name": "v3PoolsPoolRule", + "required": true, + "schema": { + "$ref": "#/definitions/v3PoolsPoolRule" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new rule.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnetsSubnets" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{Pool}/rules/{v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRuleId}": { + "delete": { + "description": "Delete a network rule.", + "operationId": "deleteNetworkv3GroupnetsGroupnetSubnetsSubnetPoolsPoolRule", + "parameters": [ + { + "description": "Delete a network rule.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRuleId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a single network rule.", + "operationId": "getNetworkv3GroupnetsGroupnetSubnetsSubnetPoolsPoolRule", + "parameters": [ + { + "description": "View a single network rule.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRuleId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single network rule.", + "schema": { + "$ref": "#/definitions/v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network rule.", + "operationId": "updateNetworkv3GroupnetsGroupnetSubnetsSubnetPoolsPoolRule", + "parameters": [ + { + "in": "body", + "name": "v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRule", + "required": true, + "schema": { + "$ref": "#/definitions/v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRule" + } + }, + { + "description": "Modify a network rule.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetsSubnetPoolsPoolRuleId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{Pool}/sc-resume-nodes": { + "post": { + "description": "Resume suspended nodes.", + "operationId": "createNetworkGroupnetsSubnetsv3PoolsPoolScResumeNode", + "parameters": [ + { + "in": "body", + "name": "v3PoolsPoolScResumeNode", + "required": true, + "schema": { + "$ref": "#/definitions/v3PoolsPoolScResumeNode" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resume suspended nodes.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnetsSubnets" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{Pool}/sc-suspend-nodes": { + "post": { + "description": "Suspend nodes.", + "operationId": "createNetworkGroupnetsSubnetsv3PoolsPoolScSuspendNode", + "parameters": [ + { + "in": "body", + "name": "v3PoolsPoolScSuspendNode", + "required": true, + "schema": { + "$ref": "#/definitions/v3PoolsPoolScResumeNode" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Suspend nodes.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnetsSubnets" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{v3GroupnetsGroupnetSubnetsSubnetPoolId}": { + "delete": { + "description": "Delete a network pool.", + "operationId": "deleteNetworkv3GroupnetsGroupnetSubnetsSubnetPool", + "parameters": [ + { + "description": "Delete a network pool.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetsSubnetPoolId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a single network pool.", + "operationId": "getNetworkv3GroupnetsGroupnetSubnetsSubnetPool", + "parameters": [ + { + "description": "View a single network pool.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetsSubnetPoolId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single network pool.", + "schema": { + "$ref": "#/definitions/v3GroupnetsGroupnetSubnetsSubnetPools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network pool.", + "operationId": "updateNetworkv3GroupnetsGroupnetSubnetsSubnetPool", + "parameters": [ + { + "description": "Force creating this pool even if it causes an MTU conflict.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v3GroupnetsGroupnetSubnetsSubnetPool", + "required": true, + "schema": { + "$ref": "#/definitions/v3GroupnetsGroupnetSubnetsSubnetPool" + } + }, + { + "description": "Modify a network pool.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetsSubnetPoolId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/groupnets/{Groupnet}/subnets/{v3GroupnetsGroupnetSubnetId}": { + "delete": { + "description": "Delete a network subnet.", + "operationId": "deleteNetworkv3GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "Force deleting this subnet even if pools in other subnets rely on this subnet's SC VIP.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a network subnet.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a network subnet.", + "operationId": "getNetworkv3GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "View a network subnet.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a network subnet.", + "schema": { + "$ref": "#/definitions/v3GroupnetsGroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network subnet.", + "operationId": "updateNetworkv3GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "Force modifying this subnet even if it causes an MTU conflict.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v3GroupnetsGroupnetSubnet", + "required": true, + "schema": { + "$ref": "#/definitions/v3GroupnetsGroupnetSubnet" + } + }, + { + "description": "Modify a network subnet.", + "in": "path", + "name": "v3GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/groupnets/{v3NetworkGroupnetId}": { + "delete": { + "description": "Delete a network groupnet.", + "operationId": "deleteNetworkv3NetworkGroupnet", + "parameters": [ + { + "description": "Delete a network groupnet.", + "in": "path", + "name": "v3NetworkGroupnetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a network groupnet.", + "operationId": "getNetworkv3NetworkGroupnet", + "parameters": [ + { + "description": "View a network groupnet.", + "in": "path", + "name": "v3NetworkGroupnetId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a network groupnet.", + "schema": { + "$ref": "#/definitions/v3NetworkGroupnetsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network groupnet.", + "operationId": "updateNetworkv3NetworkGroupnet", + "parameters": [ + { + "in": "body", + "name": "v3NetworkGroupnet", + "required": true, + "schema": { + "$ref": "#/definitions/v3NetworkGroupnetExtendedExtended" + } + }, + { + "description": "Modify a network groupnet.", + "in": "path", + "name": "v3NetworkGroupnetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/pools": { + "get": { + "description": "Get a list of flexnet pools.", + "operationId": "getNetworkv3NetworkPools", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If specified, only pools for this subnet will be returned.", + "in": "query", + "name": "subnet", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If specified, only pools with this zone name will be returned.", + "in": "query", + "name": "access_zone", + "type": "string" + }, + { + "description": "If specified, only pools with this allocation type will be returned.", + "enum": [ + "static", + "dynamic" + ], + "in": "query", + "name": "alloc_method", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only pools for this groupnet will be returned.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of flexnet pools.", + "schema": { + "$ref": "#/definitions/v3NetworkPools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/rules": { + "get": { + "description": "Get a list of network rules.", + "operationId": "getNetworkv3NetworkRules", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Name of the subnet to list rules from.", + "in": "query", + "name": "subnet", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Name of the groupnet to list rules from.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "Name of the pool to list rules from.", + "in": "query", + "name": "pool", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of network rules.", + "schema": { + "$ref": "#/definitions/v3PoolsPoolRules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/sc-rebalance-all": { + "post": { + "description": "Rebalance IP addresses in all pools.", + "operationId": "createNetworkv3NetworkScRebalanceAllItem", + "parameters": [ + { + "in": "body", + "name": "v3NetworkScRebalanceAllItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Rebalance IP addresses in all pools.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/network/subnets": { + "get": { + "description": "Get a list of subnets.", + "operationId": "getNetworkv3NetworkSubnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If specified, only subnets for this groupnet will be returned.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of subnets.", + "schema": { + "$ref": "#/definitions/v3GroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/3/protocols/ftp/settings": { + "get": { + "description": "Retrieve the FTP settings.", + "operationId": "getProtocolsv3FtpSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the FTP settings.", + "schema": { + "$ref": "#/definitions/v3FtpSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the FTP settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv3FtpSettings", + "parameters": [ + { + "in": "body", + "name": "v3FtpSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3FtpSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/hdfs/log-level": { + "get": { + "description": "Retrieve the HDFS service log-level.", + "operationId": "getProtocolsv3HdfsLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the HDFS service log-level.", + "schema": { + "$ref": "#/definitions/v3HdfsLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the HDFS service log-level.", + "operationId": "updateProtocolsv3HdfsLogLevel", + "parameters": [ + { + "in": "body", + "name": "v3HdfsLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v3HdfsLogLevel" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/http/settings": { + "get": { + "description": "Retrieve HTTP properties.", + "operationId": "getProtocolsv3HttpSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve HTTP properties.", + "schema": { + "$ref": "#/definitions/v3HttpSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HTTP properties.", + "operationId": "updateProtocolsv3HttpSettings", + "parameters": [ + { + "in": "body", + "name": "v3HttpSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3HttpSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/contexts/backup": { + "get": { + "description": "Get List of NDMP Backup Contexts.", + "operationId": "getProtocolsv3NdmpContextsBackup", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get List of NDMP Backup Contexts.", + "schema": { + "$ref": "#/definitions/v3NdmpContextsBackup" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/contexts/backup/{v3NdmpContextsBackupId}": { + "delete": { + "description": "Delete a backup context", + "operationId": "deleteProtocolsv3NdmpContextsBackupById", + "parameters": [ + { + "description": "Delete a backup context", + "in": "path", + "name": "v3NdmpContextsBackupId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "View a NDMP backup context", + "operationId": "getProtocolsv3NdmpContextsBackupById", + "parameters": [ + { + "description": "View a NDMP backup context", + "in": "path", + "name": "v3NdmpContextsBackupId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a NDMP backup context", + "schema": { + "$ref": "#/definitions/v3NdmpContextsBackupExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/contexts/bre": { + "get": { + "description": "Get list of NDMP BRE Contexts.", + "operationId": "getProtocolsv3NdmpContextsBre", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get list of NDMP BRE Contexts.", + "schema": { + "$ref": "#/definitions/v3NdmpContextsBre" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/contexts/bre/{v3NdmpContextsBreId}": { + "delete": { + "description": "Delete a NDMP BRE context", + "operationId": "deleteProtocolsv3NdmpContextsBreById", + "parameters": [ + { + "description": "Delete a NDMP BRE context", + "in": "path", + "name": "v3NdmpContextsBreId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "View a NDMP BRE context", + "operationId": "getProtocolsv3NdmpContextsBreById", + "parameters": [ + { + "description": "View a NDMP BRE context", + "in": "path", + "name": "v3NdmpContextsBreId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a NDMP BRE context", + "schema": { + "$ref": "#/definitions/v3NdmpContextsBreExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/contexts/restore": { + "get": { + "description": "Get List of NDMP Restore Contexts.", + "operationId": "getProtocolsv3NdmpContextsRestore", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get List of NDMP Restore Contexts.", + "schema": { + "$ref": "#/definitions/v3NdmpContextsBackup" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/contexts/restore/{v3NdmpContextsRestoreId}": { + "delete": { + "description": "Delete a restore context", + "operationId": "deleteProtocolsv3NdmpContextsRestoreById", + "parameters": [ + { + "description": "Delete a restore context", + "in": "path", + "name": "v3NdmpContextsRestoreId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "View a NDMP restore context", + "operationId": "getProtocolsv3NdmpContextsRestoreById", + "parameters": [ + { + "description": "View a NDMP restore context", + "in": "path", + "name": "v3NdmpContextsRestoreId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a NDMP restore context", + "schema": { + "$ref": "#/definitions/v3NdmpContextsBackupExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/diagnostics": { + "get": { + "description": "List ndmp diagnostics settings.", + "operationId": "getProtocolsv3NdmpDiagnostics", + "parameters": [], + "responses": { + "200": { + "description": "List ndmp diagnostics settings.", + "schema": { + "$ref": "#/definitions/v3NdmpDiagnostics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify ndmp diagnostics settings.", + "operationId": "updateProtocolsv3NdmpDiagnostics", + "parameters": [ + { + "in": "body", + "name": "v3NdmpDiagnostics", + "required": true, + "schema": { + "$ref": "#/definitions/v3NdmpDiagnosticsDiagnostics" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/dumpdates/{v3NdmpDumpdateId}": { + "delete": { + "description": "Delete dumpdates entries of a specified path.", + "operationId": "deleteProtocolsv3NdmpDumpdate", + "parameters": [ + { + "description": "Level is an input from 0 to 10.", + "in": "query", + "name": "level", + "type": "integer" + }, + { + "description": "Delete dumpdates entries of a specified path.", + "in": "path", + "name": "v3NdmpDumpdateId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List of dumpdates entries.", + "operationId": "getProtocolsv3NdmpDumpdate", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter by dumpdate level.", + "in": "query", + "name": "level", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter by file path.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "List of dumpdates entries.", + "in": "path", + "name": "v3NdmpDumpdateId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of dumpdates entries.", + "schema": { + "$ref": "#/definitions/v3NdmpDumpdates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/logs": { + "get": { + "description": "Get NDMP logs", + "operationId": "getProtocolsv3NdmpLogs", + "parameters": [ + { + "description": "Logical node number.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "description": "The page number of the NDMP logs file.", + "in": "query", + "name": "page", + "type": "integer" + }, + { + "description": "The page size of each page of the NDMP log file.", + "in": "query", + "name": "pagesize", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Get NDMP logs", + "schema": { + "$ref": "#/definitions/v3NdmpLogs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/sessions": { + "get": { + "description": "List all ndmp sessions.", + "operationId": "getProtocolsv3NdmpSessions", + "parameters": [ + { + "description": "Combine sessions in the same context.", + "in": "query", + "name": "consolidate", + "type": "boolean" + }, + { + "description": "Only return sessions of the node.", + "in": "query", + "name": "node", + "type": "string" + }, + { + "description": "Only return the specified session.", + "in": "query", + "name": "session", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ndmp sessions.", + "schema": { + "$ref": "#/definitions/v3NdmpSessions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/sessions/{v3NdmpSessionId}": { + "delete": { + "description": "Delete the ndmp session.", + "operationId": "deleteProtocolsv3NdmpSession", + "parameters": [ + { + "description": "Logical node number.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "description": "Delete the ndmp session.", + "in": "path", + "name": "v3NdmpSessionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve the ndmp session.", + "operationId": "getProtocolsv3NdmpSession", + "parameters": [ + { + "description": "Logical node number.", + "in": "query", + "name": "lnn", + "type": "string" + }, + { + "description": "Retrieve the ndmp session.", + "in": "path", + "name": "v3NdmpSessionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ndmp session.", + "schema": { + "$ref": "#/definitions/v3NdmpSessionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/settings/dmas": { + "get": { + "description": "List of supported dma vendors.", + "operationId": "getProtocolsv3NdmpSettingsDmas", + "parameters": [], + "responses": { + "200": { + "description": "List of supported dma vendors.", + "schema": { + "$ref": "#/definitions/v3NdmpSettingsDmas" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/settings/global": { + "get": { + "description": "List global ndmp settings.", + "operationId": "getProtocolsv3NdmpSettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "List global ndmp settings.", + "schema": { + "$ref": "#/definitions/v3NdmpSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv3NdmpSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v3NdmpSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v3NdmpSettingsGlobalGlobal" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/settings/variables/{v3NdmpSettingsVariableId}": { + "delete": { + "description": "Delete preferred environment variable entries", + "operationId": "deleteProtocolsv3NdmpSettingsVariable", + "parameters": [ + { + "description": "Name of the variable to delete.", + "in": "query", + "name": "name", + "type": "string" + }, + { + "description": "Delete preferred environment variable entries", + "in": "path", + "name": "v3NdmpSettingsVariableId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List of preferred environment variables.", + "operationId": "getProtocolsv3NdmpSettingsVariable", + "parameters": [ + { + "description": "Return variables of the path.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "List of preferred environment variables.", + "in": "path", + "name": "v3NdmpSettingsVariableId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of preferred environment variables.", + "schema": { + "$ref": "#/definitions/v3NdmpSettingsVariables" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a preferred NDMP environment variable.", + "operationId": "createProtocolsv3NdmpSettingsVariable", + "parameters": [ + { + "in": "body", + "name": "v3NdmpSettingsVariable", + "required": true, + "schema": { + "$ref": "#/definitions/v3NdmpSettingsVariableCreateParams" + } + }, + { + "description": "Create a preferred NDMP environment variable.", + "in": "path", + "name": "v3NdmpSettingsVariableId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a preferred NDMP environment variable.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify or create a NDMP preferred environment variable.", + "operationId": "updateProtocolsv3NdmpSettingsVariable", + "parameters": [ + { + "description": "Name of the variable to modify.", + "in": "query", + "name": "name", + "type": "string" + }, + { + "in": "body", + "name": "v3NdmpSettingsVariable", + "required": true, + "schema": { + "$ref": "#/definitions/v3NdmpSettingsVariable" + } + }, + { + "description": "Modify or create a NDMP preferred environment variable.", + "in": "path", + "name": "v3NdmpSettingsVariableId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/users": { + "get": { + "description": "List all ndmp administrators.", + "operationId": "listProtocolsv3NdmpUsers", + "parameters": [], + "responses": { + "200": { + "description": "List all ndmp administrators.", + "schema": { + "$ref": "#/definitions/v3NdmpUsers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Created a new user.", + "operationId": "createProtocolsv3NdmpUser", + "parameters": [ + { + "in": "body", + "name": "v3NdmpUser", + "required": true, + "schema": { + "$ref": "#/definitions/v3NdmpUser" + } + } + ], + "responses": { + "200": { + "description": "Created a new user.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ndmp/users/{v3NdmpUserId}": { + "delete": { + "description": "Delete the user.", + "operationId": "deleteProtocolsv3NdmpUser", + "parameters": [ + { + "description": "Delete the user.", + "in": "path", + "name": "v3NdmpUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve the user.", + "operationId": "getProtocolsv3NdmpUser", + "parameters": [ + { + "description": "Retrieve the user.", + "in": "path", + "name": "v3NdmpUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the user.", + "schema": { + "$ref": "#/definitions/v3NdmpUsersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the user", + "operationId": "updateProtocolsv3NdmpUser", + "parameters": [ + { + "in": "body", + "name": "v3NdmpUser", + "required": true, + "schema": { + "$ref": "#/definitions/v3NdmpUserExtendedExtended" + } + }, + { + "description": "Modify the user", + "in": "path", + "name": "v3NdmpUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/log-level": { + "get": { + "description": "Get the current NFS service logging level.", + "operationId": "getProtocolsv3NfsLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Get the current NFS service logging level.", + "schema": { + "$ref": "#/definitions/v3NfsLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Set the current NFS service logging level.", + "operationId": "updateProtocolsv3NfsLogLevel", + "parameters": [ + { + "in": "body", + "name": "v3NfsLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v3NfsLogLevel" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/netgroup": { + "get": { + "description": "Get the current NFS netgroup cache settings.", + "operationId": "getProtocolsv3NfsNetgroup", + "parameters": [ + { + "description": "Host to retrieve netgroup cache settings from.", + "in": "query", + "name": "host", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get the current NFS netgroup cache settings.", + "schema": { + "$ref": "#/definitions/v3NfsNetgroup" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the current NFS netgroup settings.", + "operationId": "updateProtocolsv3NfsNetgroup", + "parameters": [ + { + "description": "Host to retrieve netgroup cache settings for.", + "in": "query", + "name": "host", + "type": "string" + }, + { + "in": "body", + "name": "v3NfsNetgroup", + "required": true, + "schema": { + "$ref": "#/definitions/v3NfsNetgroup" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/netgroup/check": { + "post": { + "description": "Update the NFS netgroups in the cache.", + "operationId": "createProtocolsv3NfsNetgroupCheckItem", + "parameters": [ + { + "description": "IP address of node to update. If unspecified, the local nodes cache is updated.", + "in": "query", + "name": "host", + "type": "string" + }, + { + "in": "body", + "name": "v3NfsNetgroupCheckItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Update the NFS netgroups in the cache.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/netgroup/flush": { + "post": { + "description": "Flush the NFS netgroups in the cache.", + "operationId": "createProtocolsv3NfsNetgroupFlushItem", + "parameters": [ + { + "description": "IP address of node to flush. If unspecified, all nodes on the cluster are flushed.", + "in": "query", + "name": "host", + "type": "string" + }, + { + "in": "body", + "name": "v3NfsNetgroupFlushItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Flush the NFS netgroups in the cache.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/nlm/sessions": { + "get": { + "description": "List all NSM clients (optionally filtered by either zone or IP)", + "operationId": "getProtocolsv3NfsNlmSessions", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "An IP address for which NSM has client records", + "in": "query", + "name": "ip", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Represents an extant auth zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NSM clients (optionally filtered by either zone or IP)", + "schema": { + "$ref": "#/definitions/v3NfsNlmSessions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/nlm/sessions-check": { + "post": { + "description": "Perform an active scan for lost NFSv3 locks.", + "operationId": "createProtocolsv3NfsNlmSessionsCheckItem", + "parameters": [ + { + "description": "An IP address for which NSM has client records", + "in": "query", + "name": "cluster_ip", + "type": "string" + }, + { + "description": "Represents an extant auth zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3NfsNlmSessionsCheckItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Perform an active scan for lost NFSv3 locks.", + "schema": { + "$ref": "#/definitions/Createv3NfsNlmSessionsCheckItemResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/nlm/sessions/{v3NfsNlmSessionId}": { + "delete": { + "description": "Delete all lock state for this host.", + "operationId": "deleteProtocolsv3NfsNlmSession", + "parameters": [ + { + "description": "An IP address for which NSM has client records", + "in": "query", + "name": "cluster_ip", + "type": "string" + }, + { + "description": "Represents an extant auth zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "if set to true, the client will be given a chance to reclaim its locks before they are destroyed", + "in": "query", + "name": "refresh", + "type": "boolean" + }, + { + "description": "Delete all lock state for this host.", + "in": "path", + "name": "v3NfsNlmSessionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve all lock state for a single client.", + "operationId": "getProtocolsv3NfsNlmSession", + "parameters": [ + { + "description": "An IP address for which NSM has client records", + "in": "query", + "name": "cluster_ip", + "type": "string" + }, + { + "description": "Represents an extant auth zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve all lock state for a single client.", + "in": "path", + "name": "v3NfsNlmSessionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve all lock state for a single client.", + "schema": { + "$ref": "#/definitions/v3NfsNlmSessionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/reload": { + "post": { + "description": "Reload default NFS export configuration.", + "operationId": "createProtocolsv3NfsReloadItem", + "parameters": [ + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3NfsReloadItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Reload default NFS export configuration.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/nfs/settings/global": { + "get": { + "description": "Retrieve the NFS configuration.", + "operationId": "getProtocolsv3NfsSettingsGlobal", + "parameters": [ + { + "description": "When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the NFS configuration.", + "schema": { + "$ref": "#/definitions/v3NfsSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the default values for NFS exports. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv3NfsSettingsGlobal", + "parameters": [ + { + "description": "When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "in": "body", + "name": "v3NfsSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v3NfsSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ntp/servers": { + "delete": { + "description": "Delete all NTP server entries.", + "operationId": "deleteProtocolsv3NtpServers", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List all NTP servers.", + "operationId": "listProtocolsv3NtpServers", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NTP servers.", + "schema": { + "$ref": "#/definitions/v3NtpServers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create an NTP server entry.", + "operationId": "createProtocolsv3NtpServer", + "parameters": [ + { + "in": "body", + "name": "v3NtpServer", + "required": true, + "schema": { + "$ref": "#/definitions/v3NtpServer" + } + } + ], + "responses": { + "200": { + "description": "Create an NTP server entry.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ntp/servers/{v3NtpServerId}": { + "delete": { + "description": "Delete an NTP server entry.", + "operationId": "deleteProtocolsv3NtpServer", + "parameters": [ + { + "description": "Delete an NTP server entry.", + "in": "path", + "name": "v3NtpServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve one NTP server.", + "operationId": "getProtocolsv3NtpServer", + "parameters": [ + { + "description": "Retrieve one NTP server.", + "in": "path", + "name": "v3NtpServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve one NTP server.", + "schema": { + "$ref": "#/definitions/v3NtpServersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the key value for an NTP server.", + "operationId": "updateProtocolsv3NtpServer", + "parameters": [ + { + "in": "body", + "name": "v3NtpServer", + "required": true, + "schema": { + "$ref": "#/definitions/v3NtpServerExtendedExtended" + } + }, + { + "description": "Modify the key value for an NTP server.", + "in": "path", + "name": "v3NtpServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/ntp/settings": { + "get": { + "description": "Retrieve the NTP settings.", + "operationId": "getProtocolsv3NtpSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the NTP settings.", + "schema": { + "$ref": "#/definitions/v3NtpSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the NTP settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv3NtpSettings", + "parameters": [ + { + "in": "body", + "name": "v3NtpSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3NtpSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/smb/log-level": { + "get": { + "description": "Get the current SMB logging level.", + "operationId": "getProtocolsv3SmbLogLevel", + "parameters": [], + "responses": { + "200": { + "description": "Get the current SMB logging level.", + "schema": { + "$ref": "#/definitions/v3SmbLogLevel" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Set the current SMB logging level.", + "operationId": "updateProtocolsv3SmbLogLevel", + "parameters": [ + { + "in": "body", + "name": "v3SmbLogLevel", + "required": true, + "schema": { + "$ref": "#/definitions/v3SmbLogLevel" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/smb/log-level/filters": { + "delete": { + "description": "Delete existing SMB log filters.", + "operationId": "deleteProtocolsv3SmbLogLevelFilters", + "parameters": [ + { + "description": "Valid SMB logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "in": "query", + "name": "level", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Get the current SMB log filters.", + "operationId": "listProtocolsv3SmbLogLevelFilters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Valid SMB logging levels", + "enum": [ + "always", + "error", + "warning", + "info", + "verbose", + "debug", + "trace" + ], + "in": "query", + "name": "level", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get the current SMB log filters.", + "schema": { + "$ref": "#/definitions/v3SmbLogLevelFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Add an SMB log filter.", + "operationId": "createProtocolsv3SmbLogLevelFilter", + "parameters": [ + { + "in": "body", + "name": "v3SmbLogLevelFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v3SmbLogLevelFilter" + } + } + ], + "responses": { + "200": { + "description": "Add an SMB log filter.", + "schema": { + "$ref": "#/definitions/Createv3SmbLogLevelFilterResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/smb/log-level/filters/{v3SmbLogLevelFilterId}": { + "delete": { + "description": "Delete log filter.", + "operationId": "deleteProtocolsv3SmbLogLevelFilter", + "parameters": [ + { + "description": "Delete log filter.", + "in": "path", + "name": "v3SmbLogLevelFilterId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "View log filter.", + "operationId": "getProtocolsv3SmbLogLevelFilter", + "parameters": [ + { + "description": "View log filter.", + "in": "path", + "name": "v3SmbLogLevelFilterId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View log filter.", + "schema": { + "$ref": "#/definitions/v3SmbLogLevelFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/smb/settings/global": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv3SmbSettingsGlobal", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v3SmbSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv3SmbSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v3SmbSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v3SmbSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/smb/settings/share": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv3SmbSettingsShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Zone which contains these share settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v3SmbSettingsShare" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv3SmbSettingsShare", + "parameters": [ + { + "description": "Zone which contains these share settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3SmbSettingsShare", + "required": true, + "schema": { + "$ref": "#/definitions/v3SmbSettingsShareSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/smb/shares": { + "delete": { + "description": "Delete multiple smb shares.", + "operationId": "deleteProtocolsv3SmbShares", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List all shares.", + "operationId": "listProtocolsv3SmbShares", + "parameters": [ + { + "description": "Order results by this field. Default is id.", + "enum": [ + "id", + "name", + "path", + "description" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 5000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all shares.", + "schema": { + "$ref": "#/definitions/v3SmbShares" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new share.", + "operationId": "createProtocolsv3SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v3SmbShare" + } + } + ], + "responses": { + "200": { + "description": "Create a new share.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/smb/shares/{v3SmbShareId}": { + "delete": { + "description": "Delete the share.", + "operationId": "deleteProtocolsv3SmbShare", + "parameters": [ + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the share.", + "in": "path", + "name": "v3SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve share.", + "operationId": "getProtocolsv3SmbShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve share.", + "in": "path", + "name": "v3SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve share.", + "schema": { + "$ref": "#/definitions/v3SmbSharesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv3SmbShare", + "parameters": [ + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v3SmbShareExtendedExtended" + } + }, + { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v3SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/snmp/settings": { + "get": { + "description": "Retrieve the SNMP settings.", + "operationId": "getProtocolsv3SnmpSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the SNMP settings.", + "schema": { + "$ref": "#/definitions/v3SnmpSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the SNMO settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv3SnmpSettings", + "parameters": [ + { + "in": "body", + "name": "v3SnmpSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3SnmpSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/swift/accounts": { + "get": { + "description": "List all swift accounts.", + "operationId": "listProtocolsv3SwiftAccounts", + "parameters": [ + { + "description": "Access zone which contains Swift accounts.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all swift accounts.", + "schema": { + "$ref": "#/definitions/v3SwiftAccounts" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new Swift account", + "operationId": "createProtocolsv3SwiftAccount", + "parameters": [ + { + "description": "Access zone which contains Swift account.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3SwiftAccount", + "required": true, + "schema": { + "$ref": "#/definitions/v3SwiftAccount" + } + } + ], + "responses": { + "200": { + "description": "Create a new Swift account", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/protocols/swift/accounts/{v3SwiftAccountId}": { + "delete": { + "description": "Delete a Swift account.", + "operationId": "deleteProtocolsv3SwiftAccount", + "parameters": [ + { + "description": "Access zone which contains Swift account.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete a Swift account.", + "in": "path", + "name": "v3SwiftAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List a swift account.", + "operationId": "getProtocolsv3SwiftAccount", + "parameters": [ + { + "description": "Access zone which contains Swift account.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "List a swift account.", + "in": "path", + "name": "v3SwiftAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List a swift account.", + "schema": { + "$ref": "#/definitions/v3SwiftAccountsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify a Swift account", + "operationId": "updateProtocolsv3SwiftAccount", + "parameters": [ + { + "description": "Access zone which contains Swift account.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v3SwiftAccount", + "required": true, + "schema": { + "$ref": "#/definitions/v3SwiftAccount" + } + }, + { + "description": "Modify a Swift account", + "in": "path", + "name": "v3SwiftAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/3/snapshot/schedules": { + "delete": { + "description": "Delete all snapshot schedules.", + "operationId": "deleteSnapshotv3SnapshotSchedules", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "get": { + "description": "List all or matching schedules.", + "operationId": "listSnapshotv3SnapshotSchedules", + "parameters": [ + { + "description": "The field that will be used for sorting. Choices are id, name, path, pattern, schedule, duration, alias, next_run, and next_snapshot. Default is id.", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching schedules.", + "schema": { + "$ref": "#/definitions/v1SnapshotSchedules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + }, + "post": { + "description": "Create a new schedule.", + "operationId": "createSnapshotv3SnapshotSchedule", + "parameters": [ + { + "in": "body", + "name": "v3SnapshotSchedule", + "required": true, + "schema": { + "$ref": "#/definitions/v1SnapshotSchedule" + } + } + ], + "responses": { + "200": { + "description": "Create a new schedule.", + "schema": { + "$ref": "#/definitions/Createv1SnapshotScheduleResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/3/statistics/operations": { + "get": { + "description": "Retrieve operations list.", + "operationId": "getStatisticsv3StatisticsOperations", + "parameters": [ + { + "description": "A comma separated list. Only report operations for specified protocol(s). Default is all. ", + "in": "query", + "items": { + "type": "string" + }, + "name": "protocols", + "type": "array" + } + ], + "responses": { + "200": { + "description": "Retrieve operations list.", + "schema": { + "$ref": "#/definitions/v3StatisticsOperations" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/3/statistics/summary/client": { + "get": { + "description": "Description for Statistics3 v3Summary Client", + "operationId": "getStatisticsv3SummaryClient", + "parameters": [ + { + "description": "Sort data by the specified comma-separated field(s). (num_operations | operation_rate | in_max | in_min | in | in_avg | out_max | out_min | out | out_avg | time_max | time_min | time_avg | node | protocol | class | user_id | user_name | local_addr | local_name | remote_addr | remote_name) Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "A comma separated list specifying what should be unique. (node | protocol | class | local_addr | local_name | remote_addr | remote_name | user_id | user_name | devid). Aggregation is performed over all the fields not specified in the list.", + "in": "query", + "name": "totalby", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for operations requested by users with resolved names enumerated. ", + "in": "query", + "name": "user_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for operations requested by the remote clients with dotted-quad IP addresses enumerated. ", + "in": "query", + "name": "remote_addresses", + "type": "string" + }, + { + "description": "Do not resolve hostnames and usernames to their human readable form(s). Default is false. ", + "in": "query", + "name": "numeric", + "type": "boolean" + }, + { + "description": "A comma separated list. Only report statistics for operations handled by the local hosts with resolved names enumerated. ", + "in": "query", + "name": "local_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for operations requested by users with numeric UIDs enumerated. ", + "in": "query", + "name": "user_ids", + "type": "string" + }, + { + "description": "A comma separated list. Default is all. (other | write | read | namespace_read | namespace_write)", + "in": "query", + "name": "classes", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "A comma separated list. Only report statistics for operations handled by the local hosts with dotted-quad IP addresses enumerated. ", + "in": "query", + "name": "local_addresses", + "type": "string" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "A comma separated list. Only report statistics for operations requested by the remote clients with resolved names enumerated. ", + "in": "query", + "name": "remote_names", + "type": "string" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "A comma separated list. Default is all. (nfs3 | smb1 | nlm | ftp | http | siq | smb2 | nfs4 | nfsrdma | papi | jobd | irp | lsass_in | lsass_out | hdfs | s3 | internal | external)", + "in": "query", + "name": "protocols", + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v3SummaryClient" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/3/statistics/summary/drive": { + "get": { + "description": "Description for Statistics3 v3Summary Drive", + "operationId": "getStatisticsv3SummaryDrive", + "parameters": [ + { + "description": "Sort data by the specified comma-separated field(s). (drive_id | type | xfers_in | bytes_in | xfer_size_in | xfers_out | bytes_out | xfer_size_out | access_latency | access_slow | iosched_latency | iosched_queue | busy | used_bytes_percent | used_inodes). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "Specify drive type(s) for which statistics should be reported.", + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v3SummaryDrive" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/3/statistics/summary/heat": { + "get": { + "description": "File heat map, i.e. rate of file operations, and the type of operation listed by path/lin(s).", + "operationId": "getStatisticsv3SummaryHeat", + "parameters": [ + { + "description": "Sort data by the specified comma-separated field(s). (operation_rate | node | event_name | class_name | lin | path). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Convert lin to hex. Default is true. ", + "in": "query", + "name": "convertlin", + "type": "boolean" + }, + { + "description": "A comma separated list specifying what should be unique. (node | event_name | event_class | operation_rate | path | lin). Aggregation is performed over all the fields not specified in the list.", + "in": "query", + "name": "totalby", + "type": "string" + }, + { + "description": "Squash paths to this directory depth. Defaults to none, i.e. the paths are not limited (subject to the system limits).", + "in": "query", + "name": "pathdepth", + "type": "integer" + }, + { + "description": "Do not resolve LINs into filenames. Default is false. ", + "in": "query", + "name": "numeric", + "type": "boolean" + }, + { + "description": "A comma separated list. Default is all. Only report specified event types(s). (blocked | contended | deadlocked | getattr | link | lock | lookup | read | rename | setattr | unlink | write).", + "in": "query", + "name": "events", + "type": "string" + }, + { + "description": "Maximum bytes allocated for looking up a path. An ASCII character is 1 byte (it may be more for other types of encoding). The default is 4096 bytes. Zero (0) means unlimited (subject to the system limits).", + "in": "query", + "name": "maxpath", + "type": "integer" + }, + { + "description": "A comma separated list. Default is all. (other | write | read | namespace_read | namespace_write).", + "in": "query", + "name": "classes", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "File heat map, i.e. rate of file operations, and the type of operation listed by path/lin(s).", + "schema": { + "$ref": "#/definitions/v3SummaryHeat" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/3/statistics/summary/protocol": { + "get": { + "description": "Description for Statistics3 v3Summary Protocol", + "operationId": "getStatisticsv3SummaryProtocol", + "parameters": [ + { + "description": "Specify operation(s) for which statistics should be reported (See the cli command: 'isi statistics list operations', for a total list). Default is all. ", + "in": "query", + "name": "operations", + "type": "string" + }, + { + "description": "Sort data by the specified comma-separated field(s). (time | operation_count | operation_rate | in_max | in_min | in | in_avg | in_standard_dev | out_max | out_min | out | out_avg | out_standard_dev | time_max | time_min | time_avg | time_standard_dev | node | protocol | class | operation). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "A comma separated list specifying what should be unique. (node | protocol | class | operation). Aggregation is performed over all the fields not specified in the list.", + "in": "query", + "name": "totalby", + "type": "string" + }, + { + "description": "Show table entries with no values.", + "in": "query", + "name": "zero", + "type": "boolean" + }, + { + "description": "A comma separated list. Default is all. (other | write | read | create | delete | namespace_read | namespace_write | file_state | session_state).", + "in": "query", + "name": "classes", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "A comma separated list. Default is all external protocols. (nfs3 | smb1 | nlm | ftp | http | siq | smb2 | nfs4 | nfsrdma | papi | jobd | irp | lsass_in | lsass_out | hdfs | s3 | all | internal | external)", + "in": "query", + "name": "protocols", + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v3SummaryProtocol" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/3/statistics/summary/protocol-stats": { + "get": { + "description": "Description for Statistics3 v3Summary ProtocolStats", + "operationId": "getStatisticsv3SummaryProtocolStats", + "parameters": [ + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "A single protocol. Default is nfs3. (nfs3 | smb1 | nlm | ftp | http | siq | smb2 | nfs4 | nfsrdma | papi | jobd | irp | lsass_in | lsass_out | hdfs | s3)", + "in": "query", + "name": "protocol", + "type": "string" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v3SummaryProtocolStats" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/3/statistics/summary/system": { + "get": { + "description": "Description for Statistics3 v3Summary System", + "operationId": "getStatisticsv3SummarySystem", + "parameters": [ + { + "description": "Sort data by the specified comma-separated field(s). (time | node | cpu | smb | ftp | http | nfs | hdfs | s3 | total | net_in | net_out | disk_in). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Display protocol operation rate statistics rather than the default throughput statistics.", + "in": "query", + "name": "oprates", + "type": "boolean" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v3SummarySystem" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/3/storagepool/nodepools": { + "delete": { + "description": "Delete all node pools.", + "operationId": "deleteStoragepoolv3StoragepoolNodepools", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "get": { + "description": "List all node pools.", + "operationId": "listStoragepoolv3StoragepoolNodepools", + "parameters": [], + "responses": { + "200": { + "description": "List all node pools.", + "schema": { + "$ref": "#/definitions/v3StoragepoolNodepools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "post": { + "description": "Create a new node pool.", + "operationId": "createStoragepoolv3StoragepoolNodepool", + "parameters": [ + { + "in": "body", + "name": "v3StoragepoolNodepool", + "required": true, + "schema": { + "$ref": "#/definitions/v1StoragepoolNodepool" + } + } + ], + "responses": { + "200": { + "description": "Create a new node pool.", + "schema": { + "$ref": "#/definitions/Createv1StoragepoolNodepoolResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/3/storagepool/nodepools/{v3StoragepoolNodepoolId}": { + "delete": { + "description": "Delete node pool.", + "operationId": "deleteStoragepoolv3StoragepoolNodepool", + "parameters": [ + { + "description": "Delete node pool.", + "in": "path", + "name": "v3StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "get": { + "description": "Retrieve node pool information.", + "operationId": "getStoragepoolv3StoragepoolNodepool", + "parameters": [ + { + "description": "Retrieve node pool information.", + "in": "path", + "name": "v3StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve node pool information.", + "schema": { + "$ref": "#/definitions/v3StoragepoolNodepoolsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "put": { + "description": "Modify node pool. All input fields are optional, but one or more must be supplied.", + "operationId": "updateStoragepoolv3StoragepoolNodepool", + "parameters": [ + { + "in": "body", + "name": "v3StoragepoolNodepool", + "required": true, + "schema": { + "$ref": "#/definitions/v1StoragepoolNodepoolExtendedExtended" + } + }, + { + "description": "Modify node pool. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v3StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/3/storagepool/storagepools": { + "get": { + "description": "List all storage pools.", + "operationId": "getStoragepoolv3StoragepoolStoragepools", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If true, node pools contained within tiers will be filtered out of results.", + "in": "query", + "name": "toplevels", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all storage pools.", + "schema": { + "$ref": "#/definitions/v3StoragepoolStoragepools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/3/storagepool/suggested-protection/{v3StoragepoolSuggestedProtectionNid}": { + "get": { + "description": "Retrieve the suggested protection policy.", + "operationId": "getStoragepoolv3StoragepoolSuggestedProtectionNid", + "parameters": [ + { + "description": "Retrieve the suggested protection policy.", + "in": "path", + "name": "v3StoragepoolSuggestedProtectionNid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the suggested protection policy.", + "schema": { + "$ref": "#/definitions/v3StoragepoolSuggestedProtection" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/3/sync/history/cpu": { + "get": { + "description": "List cpu performance data.", + "operationId": "getSyncv3HistoryCpu", + "parameters": [ + { + "description": "Begin timestamp for time-series report.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "End timestamp for time-series report.", + "in": "query", + "name": "end", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List cpu performance data.", + "schema": { + "$ref": "#/definitions/v3HistoryCpu" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/history/worker": { + "get": { + "description": "List worker performance data.", + "operationId": "getSyncv3HistoryWorker", + "parameters": [ + { + "description": "Begin timestamp for time-series report.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "End timestamp for time-series report.", + "in": "query", + "name": "end", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List worker performance data.", + "schema": { + "$ref": "#/definitions/v3HistoryWorker" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/jobs": { + "delete": { + "description": "Cancel all SyncIQ jobs.", + "operationId": "deleteSyncv3SyncJobs", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "Get a list of SyncIQ jobs.", + "operationId": "listSyncv3SyncJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ jobs.", + "schema": { + "$ref": "#/definitions/v3SyncJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Start a SyncIQ job.", + "operationId": "createSyncv3SyncJob", + "parameters": [ + { + "in": "body", + "name": "v3SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncJob" + } + } + ], + "responses": { + "200": { + "description": "Start a SyncIQ job.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/jobs/{v3SyncJobId}": { + "get": { + "description": "View a single SyncIQ job.", + "operationId": "getSyncv3SyncJob", + "parameters": [ + { + "description": "View a single SyncIQ job.", + "in": "path", + "name": "v3SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ job.", + "schema": { + "$ref": "#/definitions/v3SyncJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "operationId": "updateSyncv3SyncJob", + "parameters": [ + { + "in": "body", + "name": "v3SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncJobExtendedExtended" + } + }, + { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "in": "path", + "name": "v3SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/policies": { + "delete": { + "description": "Delete all SyncIQ policies.", + "operationId": "deleteSyncv3SyncPolicies", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "List all SyncIQ policies.", + "operationId": "listSyncv3SyncPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Show only summary properties", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ policies.", + "schema": { + "$ref": "#/definitions/v3SyncPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Create a SyncIQ policy.", + "operationId": "createSyncv3SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v3SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v3SyncPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a SyncIQ policy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/policies/{v3SyncPolicyId}": { + "delete": { + "description": "Delete a single SyncIQ policy.", + "operationId": "deleteSyncv3SyncPolicy", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a single SyncIQ policy.", + "in": "path", + "name": "v3SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ policy.", + "operationId": "getSyncv3SyncPolicy", + "parameters": [ + { + "description": "View a single SyncIQ policy.", + "in": "path", + "name": "v3SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ policy.", + "schema": { + "$ref": "#/definitions/v3SyncPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a single SyncIQ policy.", + "operationId": "updateSyncv3SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v3SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v3SyncPolicyExtendedExtended" + } + }, + { + "description": "Modify a single SyncIQ policy.", + "in": "path", + "name": "v3SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/rules": { + "delete": { + "description": "Delete all SyncIQ performance rules or all rules of a specified type.", + "operationId": "deleteSyncv3SyncRules", + "parameters": [ + { + "description": "Delete all rules of the specified rule type only.", + "enum": [ + "bandwidth", + "file_count", + "cpu", + "worker" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "List all SyncIQ performance rules.", + "operationId": "listSyncv3SyncRules", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Filter the returned rules to include only those with this rule type.", + "enum": [ + "bandwidth", + "file_count", + "cpu", + "worker" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ performance rules.", + "schema": { + "$ref": "#/definitions/v3SyncRules" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Create a new SyncIQ performance rule.", + "operationId": "createSyncv3SyncRule", + "parameters": [ + { + "in": "body", + "name": "v3SyncRule", + "required": true, + "schema": { + "$ref": "#/definitions/v3SyncRule" + } + } + ], + "responses": { + "200": { + "description": "Create a new SyncIQ performance rule.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/rules/{v3SyncRuleId}": { + "delete": { + "description": "Delete a single SyncIQ performance rule.", + "operationId": "deleteSyncv3SyncRule", + "parameters": [ + { + "description": "Delete a single SyncIQ performance rule.", + "in": "path", + "name": "v3SyncRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ performance rule.", + "operationId": "getSyncv3SyncRule", + "parameters": [ + { + "description": "View a single SyncIQ performance rule.", + "in": "path", + "name": "v3SyncRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ performance rule.", + "schema": { + "$ref": "#/definitions/v3SyncRulesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a single SyncIQ performance rule.", + "operationId": "updateSyncv3SyncRule", + "parameters": [ + { + "in": "body", + "name": "v3SyncRule", + "required": true, + "schema": { + "$ref": "#/definitions/v3SyncRuleExtendedExtended" + } + }, + { + "description": "Modify a single SyncIQ performance rule.", + "in": "path", + "name": "v3SyncRuleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/sync/settings": { + "get": { + "description": "Retrieve the global SyncIQ settings.", + "operationId": "getSyncv3SyncSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the global SyncIQ settings.", + "schema": { + "$ref": "#/definitions/v3SyncSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify the global SyncIQ settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSyncv3SyncSettings", + "parameters": [ + { + "in": "body", + "name": "v3SyncSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v3SyncSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/3/upgrade/cluster": { + "get": { + "description": "Cluster wide upgrade status info.", + "operationId": "getUpgradev3UpgradeCluster", + "parameters": [], + "responses": { + "200": { + "description": "Cluster wide upgrade status info.", + "schema": { + "$ref": "#/definitions/v3UpgradeCluster" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/add_remaining_nodes": { + "post": { + "description": "Let system absorb any remaining or new nodes inside the existing upgrade.", + "operationId": "createUpgradev3ClusterAddRemainingNode", + "parameters": [ + { + "in": "body", + "name": "v3ClusterAddRemainingNode", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Let system absorb any remaining or new nodes inside the existing upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/archive": { + "post": { + "description": "Start an archive of an upgrade.", + "operationId": "createUpgradev3ClusterArchiveItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterArchiveItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterArchiveItem" + } + } + ], + "responses": { + "200": { + "description": "Start an archive of an upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/assess": { + "post": { + "description": "Start upgrade assessment on cluster.", + "operationId": "createUpgradev3ClusterAssessItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterAssessItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterAssessItem" + } + } + ], + "responses": { + "200": { + "description": "Start upgrade assessment on cluster.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/commit": { + "post": { + "description": "Commit the upgrade of a cluster.", + "operationId": "createUpgradev3ClusterCommitItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterCommitItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Commit the upgrade of a cluster.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/firmware/progress": { + "get": { + "description": "Cluster wide firmware upgrade status info.", + "operationId": "getUpgradev3ClusterFirmwareProgress", + "parameters": [], + "responses": { + "200": { + "description": "Cluster wide firmware upgrade status info.", + "schema": { + "$ref": "#/definitions/v3ClusterFirmwareProgress" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/firmware/status": { + "get": { + "description": "The firmware status for the cluster.", + "operationId": "getUpgradev3ClusterFirmwareStatus", + "parameters": [ + { + "description": "Re-gather firmware status. Default is false.", + "in": "query", + "name": "refresh", + "type": "boolean" + }, + { + "description": "Show devices. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "devices", + "type": "boolean" + }, + { + "description": "Show package. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "package", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The firmware status for the cluster.", + "schema": { + "$ref": "#/definitions/v10ClusterFirmwareDevice" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/nodes": { + "get": { + "description": "View information about nodes during an upgrade, rollback, or pre-upgrade assessment.", + "operationId": "getUpgradev3ClusterNodes", + "parameters": [], + "responses": { + "200": { + "description": "View information about nodes during an upgrade, rollback, or pre-upgrade assessment.", + "schema": { + "$ref": "#/definitions/v3ClusterNodesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/nodes/{Lnn}/firmware/status": { + "get": { + "description": "The firmware status for the node.", + "operationId": "getUpgradeClusterv3NodesNodeFirmwareStatus", + "parameters": [ + { + "description": "Show devices. If false, this returns an empty list. Default is false.", + "in": "query", + "name": "devices", + "type": "boolean" + }, + { + "description": "Show package. If false, this returns an empty list.Default is false.", + "in": "query", + "name": "package", + "type": "boolean" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "The firmware status for the node.", + "schema": { + "$ref": "#/definitions/v3NodesNodeFirmwareStatus" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "UpgradeCluster" + ] + } + }, + "/platform/3/upgrade/cluster/nodes/{v3ClusterNodeId}": { + "get": { + "description": "The node details useful during an upgrade or assessment.", + "operationId": "getUpgradev3ClusterNode", + "parameters": [ + { + "description": "The node details useful during an upgrade or assessment.", + "in": "path", + "name": "v3ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "The node details useful during an upgrade or assessment.", + "schema": { + "$ref": "#/definitions/v3ClusterNodeExtendedExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/patch/abort": { + "post": { + "description": "Abort the previous action performed by the patch system.", + "operationId": "createUpgradev3ClusterPatchAbortItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterPatchAbortItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Abort the previous action performed by the patch system.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/patch/patches": { + "get": { + "description": "List all patches.", + "operationId": "listUpgradev3ClusterPatchPatches", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Path location of patch file.", + "in": "query", + "name": "location", + "type": "string" + }, + { + "description": "Whether to view patches on the local node only.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all patches.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatches" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "post": { + "description": "Install a patch.", + "operationId": "createUpgradev3ClusterPatchPatch", + "parameters": [ + { + "description": "Whether to ignore patch system validation and force the installation.", + "in": "query", + "name": "override", + "type": "boolean" + }, + { + "description": "Whether to install the patch on one node at a time. Defaults to true.", + "in": "query", + "name": "rolling", + "type": "boolean" + }, + { + "in": "body", + "name": "v3ClusterPatchPatch", + "required": true, + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatch" + } + } + ], + "responses": { + "200": { + "description": "Install a patch.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/patch/patches/{v3ClusterPatchPatchId}": { + "delete": { + "description": "Uninstall a patch.", + "operationId": "deleteUpgradev3ClusterPatchPatch", + "parameters": [ + { + "description": "Whether to ignore patch system validation and force the uninstallation.", + "in": "query", + "name": "override", + "type": "boolean" + }, + { + "description": "Whether to uninstall the patch on one node at a time. Defaults to true.", + "in": "query", + "name": "rolling", + "type": "boolean" + }, + { + "description": "Uninstall a patch.", + "in": "path", + "name": "v3ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "get": { + "description": "View a single patch.", + "operationId": "getUpgradev3ClusterPatchPatch", + "parameters": [ + { + "description": "Only view patch information on the local node.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "Path location of patch file.", + "in": "query", + "name": "location", + "type": "string" + }, + { + "description": "View a single patch.", + "in": "path", + "name": "v3ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single patch.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatchesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/retry_last_action": { + "post": { + "description": "Retry the last upgrade action, in-case the previous attempt failed.", + "operationId": "createUpgradev3ClusterRetryLastActionItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterRetryLastActionItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterRetryLastActionItem" + } + } + ], + "responses": { + "200": { + "description": "Retry the last upgrade action, in-case the previous attempt failed.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/rollback": { + "post": { + "description": "Rollback the upgrade of a cluster.", + "operationId": "createUpgradev3ClusterRollbackItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterRollbackItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Rollback the upgrade of a cluster.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/upgrade/cluster/upgrade": { + "post": { + "description": "The settings necessary to start an upgrade.", + "operationId": "createUpgradev3ClusterUpgradeItem", + "parameters": [ + { + "in": "body", + "name": "v3ClusterUpgradeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterUpgradeItem" + } + } + ], + "responses": { + "200": { + "description": "The settings necessary to start an upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "put": { + "description": "Add nodes to a running upgrade.", + "operationId": "updateUpgradev3ClusterUpgrade", + "parameters": [ + { + "in": "body", + "name": "v3ClusterUpgrade", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterUpgrade" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/3/zones": { + "get": { + "description": "List all access zones.", + "operationId": "listZonesv3Zones", + "parameters": [], + "responses": { + "200": { + "description": "List all access zones.", + "schema": { + "$ref": "#/definitions/v3Zones" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + }, + "post": { + "description": "Create a new access zone.", + "operationId": "createZonesv3Zone", + "parameters": [ + { + "in": "body", + "name": "v3Zone", + "required": true, + "schema": { + "$ref": "#/definitions/v3Zone" + } + } + ], + "responses": { + "200": { + "description": "Create a new access zone.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + } + }, + "/platform/3/zones/{v3ZoneId}": { + "delete": { + "description": "Delete the access zone.", + "operationId": "deleteZonesv3Zone", + "parameters": [ + { + "description": "Delete the access zone.", + "in": "path", + "name": "v3ZoneId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + }, + "get": { + "description": "Retrieve the access zone information.", + "operationId": "getZonesv3Zone", + "parameters": [ + { + "description": "Retrieve the access zone information.", + "in": "path", + "name": "v3ZoneId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the access zone information.", + "schema": { + "$ref": "#/definitions/v3ZonesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + }, + "put": { + "description": "Modify the access zone. All input fields are optional, but one or more must be supplied.", + "operationId": "updateZonesv3Zone", + "parameters": [ + { + "in": "body", + "name": "v3Zone", + "required": true, + "schema": { + "$ref": "#/definitions/v3ZoneExtendedExtended" + } + }, + { + "description": "Modify the access zone. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v3ZoneId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Zones" + ] + } + }, + "/platform/4/audit/progress": { + "get": { + "description": "View current audit log time.", + "operationId": "getAuditv4AuditProgress", + "parameters": [ + { + "description": "lnn of the node.", + "in": "query", + "name": "lnn", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "View current audit log time.", + "schema": { + "$ref": "#/definitions/v4AuditProgress" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/4/audit/progress/global": { + "get": { + "description": "View the global audit log time.", + "operationId": "getAuditv4ProgressGlobal", + "parameters": [], + "responses": { + "200": { + "description": "View the global audit log time.", + "schema": { + "$ref": "#/definitions/v4ProgressGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/4/auth/cache": { + "post": { + "description": "Flush the Security Objects Cache.", + "operationId": "createAuthv4AuthCacheItem", + "parameters": [ + { + "description": "Specifies access zone from which to flush objects.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v4AuthCacheItem", + "required": true, + "schema": { + "$ref": "#/definitions/v4AuthCacheItem" + } + } + ], + "responses": { + "200": { + "description": "Flush the Security Objects Cache.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/4/auth/ldap-templates": { + "get": { + "description": "List all LDAP provider templates.", + "operationId": "getAuthv4AuthLdapTemplates", + "parameters": [], + "responses": { + "200": { + "description": "List all LDAP provider templates.", + "schema": { + "$ref": "#/definitions/v4AuthLdapTemplates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/4/auth/ldap-templates/{v4AuthLdapTemplateId}": { + "get": { + "description": "Retrieve the LDAP provider template.", + "operationId": "getAuthv4AuthLdapTemplate", + "parameters": [ + { + "description": "Retrieve the LDAP provider template.", + "in": "path", + "name": "v4AuthLdapTemplateId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the LDAP provider template.", + "schema": { + "$ref": "#/definitions/v4AuthLdapTemplates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/4/auth/providers/ldap": { + "get": { + "description": "List all LDAP providers.", + "operationId": "listAuthv4ProvidersLdap", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all LDAP providers.", + "schema": { + "$ref": "#/definitions/v4ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new LDAP provider.", + "operationId": "createAuthv4ProvidersLdapItem", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v4ProvidersLdapItem", + "required": true, + "schema": { + "$ref": "#/definitions/v4ProvidersLdapItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new LDAP provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/4/auth/providers/ldap/{v4ProvidersLdapId}": { + "delete": { + "description": "Delete the LDAP provider.", + "operationId": "deleteAuthv4ProvidersLdapById", + "parameters": [ + { + "description": "Delete the LDAP provider.", + "in": "path", + "name": "v4ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the LDAP provider.", + "operationId": "getAuthv4ProvidersLdapById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the LDAP provider.", + "in": "path", + "name": "v4ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the LDAP provider.", + "schema": { + "$ref": "#/definitions/v4ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the LDAP provider.", + "operationId": "updateAuthv4ProvidersLdapById", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v4ProvidersLdapIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v4ProvidersLdapIdParams" + } + }, + { + "description": "Modify the LDAP provider.", + "in": "path", + "name": "v4ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/4/certificate/server": { + "get": { + "description": "Retrieve a list of all configured TLS server certificates.", + "operationId": "listCertificatev4CertificateServer", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of all configured TLS server certificates.", + "schema": { + "$ref": "#/definitions/v4CertificateServer" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + }, + "post": { + "description": "Import a TLS server certificate.", + "operationId": "createCertificatev4CertificateServerItem", + "parameters": [ + { + "in": "body", + "name": "v4CertificateServerItem", + "required": true, + "schema": { + "$ref": "#/definitions/v4CertificateServerItem" + } + } + ], + "responses": { + "200": { + "description": "Import a TLS server certificate.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + } + }, + "/platform/4/certificate/server/{v4CertificateServerId}": { + "delete": { + "description": "Delete a TLS server certificate.", + "operationId": "deleteCertificatev4CertificateServerById", + "parameters": [ + { + "description": "Delete a TLS server certificate.", + "in": "path", + "name": "v4CertificateServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + }, + "get": { + "description": "Retrieve a single TLS server certificate.", + "operationId": "getCertificatev4CertificateServerById", + "parameters": [ + { + "description": "Retrieve a single TLS server certificate.", + "in": "path", + "name": "v4CertificateServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a single TLS server certificate.", + "schema": { + "$ref": "#/definitions/v4CertificateServerExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + }, + "put": { + "description": "Modify a TLS server certificate.", + "operationId": "updateCertificatev4CertificateServerById", + "parameters": [ + { + "in": "body", + "name": "v4CertificateServerIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityIdParams" + } + }, + { + "description": "Modify a TLS server certificate.", + "in": "path", + "name": "v4CertificateServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + } + }, + "/platform/4/cloud/proxies": { + "get": { + "description": "List all proxies.", + "operationId": "listCloudv4CloudProxies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all proxies.", + "schema": { + "$ref": "#/definitions/v4CloudProxies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "post": { + "description": "Create a new proxy.", + "operationId": "createCloudv4CloudProxy", + "parameters": [ + { + "in": "body", + "name": "v4CloudProxy", + "required": true, + "schema": { + "$ref": "#/definitions/v4CloudProxy" + } + } + ], + "responses": { + "200": { + "description": "Create a new proxy.", + "schema": { + "$ref": "#/definitions/Createv4CloudProxyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/4/cloud/proxies/{v4CloudProxyId}": { + "delete": { + "description": "Delete cloud account.", + "operationId": "deleteCloudv4CloudProxy", + "parameters": [ + { + "description": "Delete cloud account.", + "in": "path", + "name": "v4CloudProxyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "get": { + "description": "Retrieve cloud account information.", + "operationId": "getCloudv4CloudProxy", + "parameters": [ + { + "description": "Retrieve cloud account information.", + "in": "path", + "name": "v4CloudProxyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve cloud account information.", + "schema": { + "$ref": "#/definitions/v4CloudProxiesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "put": { + "description": "Modify cloud account. All fields are optional, but one or more must be supplied.", + "operationId": "updateCloudv4CloudProxy", + "parameters": [ + { + "in": "body", + "name": "v4CloudProxy", + "required": true, + "schema": { + "$ref": "#/definitions/v4CloudProxyExtendedExtended" + } + }, + { + "description": "Modify cloud account. All fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v4CloudProxyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/4/event/alert-conditions": { + "delete": { + "description": "Bulk delete of alert conditions.", + "operationId": "deleteEventv4EventAlertConditions", + "parameters": [ + { + "description": "Delete only conditions for this channel", + "in": "query", + "name": "channel", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "List all alert conditions.", + "operationId": "listEventv4EventAlertConditions", + "parameters": [ + { + "description": "Return only conditions for the specified channel:", + "in": "query", + "name": "channels", + "type": "string" + }, + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all alert conditions.", + "schema": { + "$ref": "#/definitions/v4EventAlertConditions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "post": { + "description": "Create a new alert condition.", + "operationId": "createEventv4EventAlertCondition", + "parameters": [ + { + "in": "body", + "name": "v4EventAlertCondition", + "required": true, + "schema": { + "$ref": "#/definitions/v4EventAlertCondition" + } + } + ], + "responses": { + "200": { + "description": "Create a new alert condition.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/4/event/alert-conditions/{v4EventAlertConditionId}": { + "delete": { + "description": "Delete the alert-condition.", + "operationId": "deleteEventv4EventAlertCondition", + "parameters": [ + { + "description": "Delete the alert-condition.", + "in": "path", + "name": "v4EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "Retrieve the alert-condition.", + "operationId": "getEventv4EventAlertCondition", + "parameters": [ + { + "description": "Retrieve the alert-condition.", + "in": "path", + "name": "v4EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the alert-condition.", + "schema": { + "$ref": "#/definitions/v4EventAlertConditionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify the alert-condition", + "operationId": "updateEventv4EventAlertCondition", + "parameters": [ + { + "in": "body", + "name": "v4EventAlertCondition", + "required": true, + "schema": { + "$ref": "#/definitions/v4EventAlertConditionExtended" + } + }, + { + "description": "Modify the alert-condition", + "in": "path", + "name": "v4EventAlertConditionId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/4/event/eventgroup-definitions": { + "get": { + "description": "List all eventgroup definitions.", + "operationId": "getEventv4EventEventgroupDefinitions", + "parameters": [ + { + "description": "Return eventgroups in the specified category", + "in": "query", + "name": "category", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all eventgroup definitions.", + "schema": { + "$ref": "#/definitions/v4EventEventgroupDefinitions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/4/event/eventgroup-definitions/{v4EventEventgroupDefinitionId}": { + "get": { + "description": "Retrieve the eventgroup definition.", + "operationId": "getEventv4EventEventgroupDefinition", + "parameters": [ + { + "description": "Retrieve the eventgroup definition.", + "in": "path", + "name": "v4EventEventgroupDefinitionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the eventgroup definition.", + "schema": { + "$ref": "#/definitions/v4EventEventgroupDefinitionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/4/filepool/default-policy": { + "get": { + "description": "List default file pool policy.", + "operationId": "getFilepoolv4FilepoolDefaultPolicy", + "parameters": [], + "responses": { + "200": { + "description": "List default file pool policy.", + "schema": { + "$ref": "#/definitions/v4FilepoolDefaultPolicy" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "put": { + "description": "Set default file pool policy.", + "operationId": "updateFilepoolv4FilepoolDefaultPolicy", + "parameters": [ + { + "in": "body", + "name": "v4FilepoolDefaultPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v1FilepoolDefaultPolicyExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/4/filepool/policies": { + "get": { + "description": "List all policies.", + "operationId": "listFilepoolv4FilepoolPolicies", + "parameters": [], + "responses": { + "200": { + "description": "List all policies.", + "schema": { + "$ref": "#/definitions/v4FilepoolPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "post": { + "description": "Create a new policy.", + "operationId": "createFilepoolv4FilepoolPolicy", + "parameters": [ + { + "in": "body", + "name": "v4FilepoolPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v12FilepoolPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a new policy.", + "schema": { + "$ref": "#/definitions/Createv1FilepoolPolicyResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/4/filepool/policies/{v4FilepoolPolicyId}": { + "delete": { + "description": "Delete file pool policy.", + "operationId": "deleteFilepoolv4FilepoolPolicy", + "parameters": [ + { + "description": "Delete file pool policy.", + "in": "path", + "name": "v4FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "get": { + "description": "Retrieve file pool policy information.", + "operationId": "getFilepoolv4FilepoolPolicy", + "parameters": [ + { + "description": "Retrieve file pool policy information.", + "in": "path", + "name": "v4FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve file pool policy information.", + "schema": { + "$ref": "#/definitions/v4FilepoolPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + }, + "put": { + "description": "Modify file pool policy. All input fields are optional, but one or more must be supplied.", + "operationId": "updateFilepoolv4FilepoolPolicy", + "parameters": [ + { + "in": "body", + "name": "v4FilepoolPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v4FilepoolPolicyExtended" + } + }, + { + "description": "Modify file pool policy. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v4FilepoolPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/4/filepool/templates": { + "get": { + "description": "List all templates.", + "operationId": "getFilepoolv4FilepoolTemplates", + "parameters": [], + "responses": { + "200": { + "description": "List all templates.", + "schema": { + "$ref": "#/definitions/v4FilepoolTemplates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/4/filepool/templates/{v4FilepoolTemplateId}": { + "get": { + "description": "List all templates.", + "operationId": "getFilepoolv4FilepoolTemplate", + "parameters": [ + { + "description": "List all templates.", + "in": "path", + "name": "v4FilepoolTemplateId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all templates.", + "schema": { + "$ref": "#/definitions/v4FilepoolTemplatesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filepool" + ] + } + }, + "/platform/4/network/groupnets/{Groupnet}/subnets": { + "get": { + "description": "Get a list of subnets.", + "operationId": "listNetworkGroupnetsv4GroupnetSubnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of subnets.", + "schema": { + "$ref": "#/definitions/v4GroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + }, + "post": { + "description": "Create a new subnet.", + "operationId": "createNetworkGroupnetsv4GroupnetSubnet", + "parameters": [ + { + "in": "body", + "name": "v4GroupnetSubnet", + "required": true, + "schema": { + "$ref": "#/definitions/v4GroupnetSubnet" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new subnet.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + } + }, + "/platform/4/network/groupnets/{Groupnet}/subnets/{v4GroupnetsGroupnetSubnetId}": { + "delete": { + "description": "Delete a network subnet.", + "operationId": "deleteNetworkv4GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "Force deleting this subnet even if pools in other subnets rely on this subnet's SC VIP.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a network subnet.", + "in": "path", + "name": "v4GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a network subnet.", + "operationId": "getNetworkv4GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "View a network subnet.", + "in": "path", + "name": "v4GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a network subnet.", + "schema": { + "$ref": "#/definitions/v4GroupnetsGroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network subnet.", + "operationId": "updateNetworkv4GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "Force modifying this subnet even if it causes an MTU conflict.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v4GroupnetsGroupnetSubnet", + "required": true, + "schema": { + "$ref": "#/definitions/v4GroupnetsGroupnetSubnet" + } + }, + { + "description": "Modify a network subnet.", + "in": "path", + "name": "v4GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/4/network/subnets": { + "get": { + "description": "Get a list of subnets.", + "operationId": "getNetworkv4NetworkSubnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If specified, only subnets for this groupnet will be returned.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of subnets.", + "schema": { + "$ref": "#/definitions/v4GroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/4/protocols/hdfs/ranger-plugin/settings": { + "get": { + "description": "Retrieve HDFS ranger-plugin properties.", + "operationId": "getProtocolsv4HdfsRangerPluginSettings", + "parameters": [ + { + "description": "Access zone which contains HDFS ranger-plugin settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve HDFS ranger-plugin properties.", + "schema": { + "$ref": "#/definitions/v4HdfsRangerPluginSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS ranger-plugin properties.", + "operationId": "updateProtocolsv4HdfsRangerPluginSettings", + "parameters": [ + { + "description": "Access zone which contains HDFS ranger-plugin settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v4HdfsRangerPluginSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v4HdfsRangerPluginSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/4/protocols/ndmp/settings/preferred-ips": { + "get": { + "description": "Get list of preferences.", + "operationId": "listProtocolsv4NdmpSettingsPreferredIps", + "parameters": [ + { + "description": "Either cluster or a network subnet defined in OneFS.", + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get list of preferences.", + "schema": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIps" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a preferred ip preference.", + "operationId": "createProtocolsv4NdmpSettingsPreferredIp", + "parameters": [ + { + "in": "body", + "name": "v4NdmpSettingsPreferredIp", + "required": true, + "schema": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIp" + } + } + ], + "responses": { + "200": { + "description": "Create a preferred ip preference.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/4/protocols/ndmp/settings/preferred-ips/{v4NdmpSettingsPreferredIpId}": { + "delete": { + "description": "Delete a preferred ip preference.", + "operationId": "deleteProtocolsv4NdmpSettingsPreferredIp", + "parameters": [ + { + "description": "Delete a preferred ip preference.", + "in": "path", + "name": "v4NdmpSettingsPreferredIpId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Get one preference by id.", + "operationId": "getProtocolsv4NdmpSettingsPreferredIp", + "parameters": [ + { + "description": "Get one preference by id.", + "in": "path", + "name": "v4NdmpSettingsPreferredIpId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get one preference by id.", + "schema": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIpsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify a preferred ip preference.", + "operationId": "updateProtocolsv4NdmpSettingsPreferredIp", + "parameters": [ + { + "in": "body", + "name": "v4NdmpSettingsPreferredIp", + "required": true, + "schema": { + "$ref": "#/definitions/v4NdmpSettingsPreferredIpExtended" + } + }, + { + "description": "Modify a preferred ip preference.", + "in": "path", + "name": "v4NdmpSettingsPreferredIpId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/4/protocols/nfs/exports": { + "get": { + "description": "List all NFS exports.", + "operationId": "listProtocolsv4NfsExports", + "parameters": [ + { + "description": "The field that will be used for sorting. Default is id.", + "enum": [ + "id", + "paths", + "description" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "When specified as 'effective', or not specified, all fields are returned. When specified as 'user', only fields with non-default values are shown. When specified as 'default', the original values are returned.", + "enum": [ + "effective", + "user" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 5000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "If specified, only exports that explicitly reference at least one of the given paths will be returned.", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Check for conflicts when listing exports.", + "in": "query", + "name": "check", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NFS exports.", + "schema": { + "$ref": "#/definitions/v2NfsExports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new NFS export.", + "operationId": "createProtocolsv4NfsExport", + "parameters": [ + { + "description": "If true, the export will be created even if it conflicts with another export.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Ignore unresolvable hosts.", + "in": "query", + "name": "ignore_unresolvable_hosts", + "type": "boolean" + }, + { + "description": "Access zone", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Ignore conflicts with existing exports.", + "in": "query", + "name": "ignore_conflicts", + "type": "boolean" + }, + { + "description": "Ignore nonexistent or otherwise bad paths.", + "in": "query", + "name": "ignore_bad_paths", + "type": "boolean" + }, + { + "description": "Ignore invalid users.", + "in": "query", + "name": "ignore_bad_auth", + "type": "boolean" + }, + { + "in": "body", + "name": "v4NfsExport", + "required": true, + "schema": { + "$ref": "#/definitions/v2NfsExport" + } + } + ], + "responses": { + "200": { + "description": "Create a new NFS export.", + "schema": { + "$ref": "#/definitions/Createv3EventEventResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/4/protocols/smb/shares": { + "delete": { + "description": "Delete multiple smb shares.", + "operationId": "deleteProtocolsv4SmbShares", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List all shares.", + "operationId": "listProtocolsv4SmbShares", + "parameters": [ + { + "description": "Order results by this field. Default is id.", + "enum": [ + "id", + "name", + "path", + "description" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 5000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all shares.", + "schema": { + "$ref": "#/definitions/v3SmbShares" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new share.", + "operationId": "createProtocolsv4SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v4SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v3SmbShare" + } + } + ], + "responses": { + "200": { + "description": "Create a new share.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/4/statistics/summary/workload": { + "get": { + "description": "Description for Statistics4 v4Summary Workload", + "operationId": "getStatisticsv4SummaryWorkload", + "parameters": [ + { + "description": "A comma separated list. Only report statistics for groups specified by Group Security IDs, if configured. ", + "in": "query", + "name": "group_sids", + "type": "string" + }, + { + "description": "Do not resolve addresses and usernames to their human readable form(s). Default is false. ", + "in": "query", + "name": "numeric", + "type": "boolean" + }, + { + "description": "Report workload performance metrics for specified dataset. Default is 'System'.", + "in": "query", + "name": "dataset", + "type": "string" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "A comma separated list. Only report statistics for shares specified by name, if configured. ", + "in": "query", + "name": "share_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for paths specified by name, if configured. ", + "in": "query", + "name": "paths", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by resolved names, if configured. ", + "in": "query", + "name": "usernames", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for remote clients specified by IP addresses, if configured. ", + "in": "query", + "name": "remote_addresses", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for job(s) specified by type, if configured. ", + "in": "query", + "items": { + "type": "string" + }, + "name": "job_types", + "type": "array" + }, + { + "description": "A comma separated list. Only report statistics for users in zone specified by id, if configured. ", + "in": "query", + "name": "zone_ids", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for groups specified by resolved names, if configured. ", + "in": "query", + "name": "groupnames", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by Security IDs, if configured. ", + "in": "query", + "name": "user_sids", + "type": "string" + }, + { + "description": "Sort data by the specified comma-separated field(s). ( node | workload_id | system_name | user_id | user_sid | username | group_id | group_sid | groupname | domain_id | path | zone_id | zone_name | local_addr | local_name | remote_addr | remote_name | protocol | share_name | job_type | cpu | bytes_in | bytes_out | ops | reads | writes | l2 | l3 | latency_read | latency_write | latency_other | error). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for domains specified by id, if configured. ", + "in": "query", + "name": "domain_ids", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users in zone specified by name, if configured. ", + "in": "query", + "name": "zone_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for local hosts specified by resolved names, if configured. ", + "in": "query", + "name": "local_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by numeric UIDs, if configured. ", + "in": "query", + "name": "user_ids", + "type": "string" + }, + { + "description": "A comma separated list specifying what should be unique. (node | system_name | user_id | user_sid | username | zone_id | zone_name | local_addr | local_name | remote_addr | remote_name | group_id | group_sid | groupname | domain_id | path | protocol | share_name | job_type). Aggregation is performed over all the fields not specified in the list.", + "in": "query", + "name": "totalby", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for local hosts specified by IP addresses, if configured. ", + "in": "query", + "name": "local_addresses", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for remote clients specified by resolved names, if configured. ", + "in": "query", + "name": "remote_names", + "type": "string" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "A comma separated list. Default is all. (smb1 and smb2 only at this time.)", + "in": "query", + "name": "protocols", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for groups specified by numeric GIDs, if configured. ", + "in": "query", + "name": "group_ids", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "A comma separated list. Only report statistics for systems specified by resolved names, if configured. ", + "in": "query", + "name": "system_names", + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v4SummaryWorkload" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/4/sync/reports": { + "get": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv4SyncReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v4SyncReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/4/sync/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ subreports for a report.", + "operationId": "getSyncReportsv4ReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ subreports for a report.", + "schema": { + "$ref": "#/definitions/v4ReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncReports" + ] + } + }, + "/platform/4/sync/reports/{Rid}/subreports/{v4ReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ subreport.", + "operationId": "getSyncv4ReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ subreport.", + "in": "path", + "name": "v4ReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ subreport.", + "schema": { + "$ref": "#/definitions/v4ReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/4/sync/reports/{v4SyncReportId}": { + "get": { + "description": "View a single SyncIQ report.", + "operationId": "getSyncv4SyncReport", + "parameters": [ + { + "description": "View a single SyncIQ report.", + "in": "path", + "name": "v4SyncReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ report.", + "schema": { + "$ref": "#/definitions/v4SyncReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/4/sync/target/reports": { + "get": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv4TargetReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "Return a summary rather than entire objects.", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v4TargetReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/4/sync/target/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ target subreports for a report.", + "operationId": "getSyncTargetv4ReportsReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target subreports for a report.", + "schema": { + "$ref": "#/definitions/v4ReportsReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncTarget" + ] + } + }, + "/platform/4/sync/target/reports/{Rid}/subreports/{v4TargetReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ target subreport.", + "operationId": "getSyncv4TargetReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ target subreport.", + "in": "path", + "name": "v4TargetReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target subreport.", + "schema": { + "$ref": "#/definitions/v4TargetReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/4/sync/target/reports/{v4TargetReportId}": { + "get": { + "description": "View a single SyncIQ target report.", + "operationId": "getSyncv4TargetReport", + "parameters": [ + { + "description": "View a single SyncIQ target report.", + "in": "path", + "name": "v4TargetReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target report.", + "schema": { + "$ref": "#/definitions/v4TargetReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/4/upgrade/cluster": { + "get": { + "description": "Cluster wide upgrade status info.", + "operationId": "getUpgradev4UpgradeCluster", + "parameters": [], + "responses": { + "200": { + "description": "Cluster wide upgrade status info.", + "schema": { + "$ref": "#/definitions/v4UpgradeCluster" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/4/upgrade/cluster/nodes/{Lnn}/patch/sync": { + "post": { + "description": "Retry any pending patch sync operations.", + "operationId": "createUpgradeClusterv4NodesNodePatchSyncItem", + "parameters": [ + { + "in": "body", + "name": "v4NodesNodePatchSyncItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retry any pending patch sync operations.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "UpgradeCluster" + ] + } + }, + "/platform/5/cluster/identity": { + "get": { + "description": "Retrieve the login information.", + "operationId": "getClusterv5ClusterIdentity", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the login information.", + "schema": { + "$ref": "#/definitions/v5ClusterIdentity" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify the login information.", + "operationId": "updateClusterv5ClusterIdentity", + "parameters": [ + { + "in": "body", + "name": "v5ClusterIdentity", + "required": true, + "schema": { + "$ref": "#/definitions/v5ClusterIdentityExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/5/cluster/nodes": { + "get": { + "description": "List the nodes on this cluster.", + "operationId": "getClusterv5ClusterNodes", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + } + ], + "responses": { + "200": { + "description": "List the nodes on this cluster.", + "schema": { + "$ref": "#/definitions/v5ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/driveconfig": { + "get": { + "description": "View a node's drive subsystem XML configuration file.", + "operationId": "getClusterNodesv5NodeDriveconfig", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "View a node's drive subsystem XML configuration file.", + "schema": { + "$ref": "#/definitions/v5NodeDriveconfig" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "put": { + "description": "Modify a node's drive subsystem XML configuration file.", + "operationId": "updateClusterNodesv5NodeDriveconfig", + "parameters": [ + { + "in": "body", + "name": "v5NodeDriveconfig", + "required": true, + "schema": { + "$ref": "#/definitions/v5NodeDriveconfigExtended" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/drives": { + "get": { + "description": "List the drives on this node.", + "operationId": "getClusterNodesv5NodeDrives", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List the drives on this node.", + "schema": { + "$ref": "#/definitions/v5NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/drives/{v5NodesLnnDriveId}": { + "get": { + "description": "Retrieve drive information.", + "operationId": "getClusterv5NodesLnnDrive", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve drive information.", + "in": "path", + "name": "v5NodesLnnDriveId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve drive information.", + "schema": { + "$ref": "#/definitions/v5NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/hardware": { + "get": { + "description": "Retrieve node hardware identity information.", + "operationId": "getClusterNodesv5NodeHardware", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node hardware identity information.", + "schema": { + "$ref": "#/definitions/v5NodeHardware" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/reboot": { + "post": { + "description": "Reboot the node specified by .", + "operationId": "createClusterNodesv5NodeRebootItem", + "parameters": [ + { + "description": "Force reboot on Infinity platform even if a drive sled is not present.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v5NodeRebootItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Reboot the node specified by .", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/shutdown": { + "post": { + "description": "Shutdown the node specified by .", + "operationId": "createClusterNodesv5NodeShutdownItem", + "parameters": [ + { + "description": "Force shutdown on Infinity platform even if a drive sled is not present.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v5NodeShutdownItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Shutdown the node specified by .", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/sleds": { + "get": { + "description": "Get detailed information for all sleds in this node.\nEquivalent to /5/cluster/nodes//sleds/all.", + "operationId": "getClusterNodesv5NodeSleds", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Get detailed information for all sleds in this node.\nEquivalent to /5/cluster/nodes//sleds/all.", + "schema": { + "$ref": "#/definitions/v5NodeSleds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/5/cluster/nodes/{Lnn}/sleds/{v5NodesLnnSledId}": { + "get": { + "description": "Get detailed information for the sled specified by , or all sleds in the case where is 'all', in the node specified by .\n\nAccepts in either 'sled' or 'all' formats.", + "operationId": "getClusterv5NodesLnnSled", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Get detailed information for the sled specified by , or all sleds in the case where is 'all', in the node specified by .\n\nAccepts in either 'sled' or 'all' formats.", + "in": "path", + "name": "v5NodesLnnSledId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Get detailed information for the sled specified by , or all sleds in the case where is 'all', in the node specified by .\n\nAccepts in either 'sled' or 'all' formats.", + "schema": { + "$ref": "#/definitions/v5NodeSleds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/5/cluster/nodes/{v5ClusterNodeId}": { + "get": { + "description": "Retrieve node information.", + "operationId": "getClusterv5ClusterNode", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve node information.", + "in": "path", + "name": "v5ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node information.", + "schema": { + "$ref": "#/definitions/v5ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify one or more node settings.", + "operationId": "updateClusterv5ClusterNode", + "parameters": [ + { + "in": "body", + "name": "v5ClusterNode", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterNodeExtended" + } + }, + { + "description": "Modify one or more node settings.", + "in": "path", + "name": "v5ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/5/groupnets-summary": { + "get": { + "description": "Retrieve groupnet summary information.", + "operationId": "getGroupnetsSummaryv5GroupnetsSummary", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve groupnet summary information.", + "schema": { + "$ref": "#/definitions/v5GroupnetsSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "GroupnetsSummary" + ] + } + }, + "/platform/5/license/generate": { + "get": { + "description": "Generate license activation file.", + "operationId": "getLicensev5LicenseGenerate", + "parameters": [ + { + "default": "license_list_only", + "description": "enum: license_list_only (default), generate_activation, download_activation. Generate an activation file or return a list of activated licenses. If generating an activation file and no licenses are specified, the default configuration is to generate an activation file with the current set of licensed features. download_activation returns HTTP headers and the same XML content as seen in the response activation.", + "enum": [ + "generate_activation", + "license_list_only", + "download_activation" + ], + "in": "query", + "minLength": 0, + "name": "action", + "type": "string" + }, + { + "description": "Licenses to include in activation file.", + "in": "query", + "maxLength": 2500, + "minLength": 1, + "name": "licenses_to_include", + "pattern": ".+", + "type": "string" + }, + { + "description": "Licenses to omit from activation file.", + "in": "query", + "maxLength": 2500, + "minLength": 1, + "name": "licenses_to_exclude", + "pattern": ".+", + "type": "string" + }, + { + "description": "Activate only the defined licenses. This setting overrides all other license activation settings.", + "in": "query", + "maxLength": 2500, + "minLength": 1, + "name": "only_these_licenses", + "pattern": ".+", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Generate license activation file.", + "schema": { + "$ref": "#/definitions/v5LicenseGenerate" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + } + }, + "/platform/5/license/licenses": { + "get": { + "description": "Retrieve license information for all licensable products.", + "operationId": "listLicensev5LicenseLicenses", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve license information for all licensable products.", + "schema": { + "$ref": "#/definitions/v5LicenseLicenses" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + }, + "post": { + "description": "Install a new license file and/or activate evaluation licenses.", + "operationId": "createLicensev5LicenseLicense", + "parameters": [ + { + "in": "body", + "name": "v5LicenseLicense", + "required": true, + "schema": { + "$ref": "#/definitions/v5LicenseLicense" + } + } + ], + "responses": { + "200": { + "description": "Install a new license file and/or activate evaluation licenses.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + } + }, + "/platform/5/license/licenses/{v5LicenseLicenseId}": { + "get": { + "description": "Retrieve license information for the feature.", + "operationId": "getLicensev5LicenseLicense", + "parameters": [ + { + "description": "Retrieve license information for the feature.", + "in": "path", + "name": "v5LicenseLicenseId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve license information for the feature.", + "schema": { + "$ref": "#/definitions/v5LicenseLicensesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "License" + ] + } + }, + "/platform/5/protocols/hdfs/fsimage/job": { + "get": { + "description": "Retrieve current HDFS FSImage job information.", + "operationId": "getProtocolsv5HdfsFsimageJob", + "parameters": [ + { + "description": "Access zone which contains job information.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve current HDFS FSImage job information.", + "schema": { + "$ref": "#/definitions/v5HdfsFsimageJob" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/5/protocols/hdfs/fsimage/job/settings": { + "get": { + "description": "Retrieve HDFS FSImage job properties.", + "operationId": "getProtocolsv5HdfsFsimageJobSettings", + "parameters": [ + { + "description": "Access zone which contains job settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve HDFS FSImage job properties.", + "schema": { + "$ref": "#/definitions/v5HdfsFsimageJobSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS FSImage job properties.", + "operationId": "updateProtocolsv5HdfsFsimageJobSettings", + "parameters": [ + { + "description": "Access zone which contains job settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v5HdfsFsimageJobSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v5HdfsFsimageJobSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/5/protocols/hdfs/fsimage/latest": { + "delete": { + "description": "Delete the latest HDFS FSImage, if there is one.", + "operationId": "deleteProtocolsv5HdfsFsimageLatest", + "parameters": [ + { + "description": "Access zone which contains HDFS FSImage.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve the latest HDFS FSImage information, if there is one.", + "operationId": "getProtocolsv5HdfsFsimageLatest", + "parameters": [ + { + "description": "Access zone which contains HDFS FSImage.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the latest HDFS FSImage information, if there is one.", + "schema": { + "$ref": "#/definitions/v5HdfsFsimageLatest" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/5/protocols/hdfs/fsimage/settings": { + "get": { + "description": "Retrieve HDFS FSImage properties.", + "operationId": "getProtocolsv5HdfsFsimageSettings", + "parameters": [ + { + "description": "Access zone which contains FSImage settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve HDFS FSImage properties.", + "schema": { + "$ref": "#/definitions/v5HdfsFsimageSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS FSImage properties.", + "operationId": "updateProtocolsv5HdfsFsimageSettings", + "parameters": [ + { + "description": "Access zone which contains FSImage settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v5HdfsFsimageSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v5HdfsFsimageSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/5/protocols/hdfs/inotify/settings": { + "get": { + "description": "Retrieve HDFS INotify properties.", + "operationId": "getProtocolsv5HdfsInotifySettings", + "parameters": [ + { + "description": "Access zone which contains INotify settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve HDFS INotify properties.", + "schema": { + "$ref": "#/definitions/v5HdfsInotifySettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS INotify properties.", + "operationId": "updateProtocolsv5HdfsInotifySettings", + "parameters": [ + { + "description": "Access zone which contains INotify settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v5HdfsInotifySettings", + "required": true, + "schema": { + "$ref": "#/definitions/v5HdfsInotifySettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/5/protocols/hdfs/inotify/stream": { + "delete": { + "description": "Delete all collected events, this has the effect of resetting the stream. Note that this may cause clients reading INotify to fail. The clients that want to track metadata changes may resume reading from INotify stream after updating filesystem metadata from other sources, like HDFS FSImage.", + "operationId": "deleteProtocolsv5HdfsInotifyStream", + "parameters": [ + { + "description": "Access zone which exposes HDFS INotify.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve information about the collection and availability of HDFS INotify edit events.", + "operationId": "getProtocolsv5HdfsInotifyStream", + "parameters": [ + { + "description": "Access zone which exposes HDFS INotify.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve information about the collection and availability of HDFS INotify edit events.", + "schema": { + "$ref": "#/definitions/v5HdfsInotifyStream" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/5/protocols/snmp/settings": { + "get": { + "description": "Retrieve the SNMP settings.", + "operationId": "getProtocolsv5SnmpSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the SNMP settings.", + "schema": { + "$ref": "#/definitions/v5SnmpSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the SNMP settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv5SnmpSettings", + "parameters": [ + { + "in": "body", + "name": "v5SnmpSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v5SnmpSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/5/quota/license": { + "get": { + "description": "Retrieve license information.", + "operationId": "getQuotav5QuotaLicense", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve license information.", + "schema": { + "$ref": "#/definitions/v5LicenseLicenseExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/5/snapshot/license": { + "get": { + "description": "Retrieve license information.", + "operationId": "getSnapshotv5SnapshotLicense", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve license information.", + "schema": { + "$ref": "#/definitions/v5LicenseLicenseExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/5/storagepool/settings": { + "get": { + "description": "List all storagepool settings.", + "operationId": "getStoragepoolv5StoragepoolSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all storagepool settings.", + "schema": { + "$ref": "#/definitions/v5StoragepoolSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateStoragepoolv5StoragepoolSettings", + "parameters": [ + { + "in": "body", + "name": "v5StoragepoolSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v5StoragepoolSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/5/sync/license": { + "get": { + "description": "Retrieve license information.", + "operationId": "getSyncv5SyncLicense", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve license information.", + "schema": { + "$ref": "#/definitions/v5LicenseLicenseExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/5/upgrade/cluster/assess": { + "post": { + "description": "Start upgrade assessment on cluster.", + "operationId": "createUpgradev5ClusterAssessItem", + "parameters": [ + { + "in": "body", + "name": "v5ClusterAssessItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterAssessItem" + } + } + ], + "responses": { + "200": { + "description": "Start upgrade assessment on cluster.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/5/upgrade/cluster/upgrade": { + "post": { + "description": "The settings necessary to start an upgrade.", + "operationId": "createUpgradev5ClusterUpgradeItem", + "parameters": [ + { + "in": "body", + "name": "v5ClusterUpgradeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterUpgradeItem" + } + } + ], + "responses": { + "200": { + "description": "The settings necessary to start an upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "put": { + "description": "Add nodes to a running upgrade.", + "operationId": "updateUpgradev5ClusterUpgrade", + "parameters": [ + { + "in": "body", + "name": "v5ClusterUpgrade", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterUpgrade" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/6/dedupe/inline/settings": { + "get": { + "description": "Retrieve the inline dedupe settings.", + "operationId": "getDedupev6InlineSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the inline dedupe settings.", + "schema": { + "$ref": "#/definitions/v6InlineSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Dedupe" + ] + }, + "put": { + "description": "Modify the inline dedupe settings.", + "operationId": "updateDedupev6InlineSettings", + "parameters": [ + { + "in": "body", + "name": "v6InlineSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v6InlineSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Dedupe" + ] + } + }, + "/platform/6/filesystem/settings/compression": { + "get": { + "description": "Retrieve settings for filesystem compression.", + "operationId": "getFilesystemv6SettingsCompression", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve settings for filesystem compression.", + "schema": { + "$ref": "#/definitions/v6SettingsCompression" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + }, + "put": { + "description": "Set settings for filesystem compression.", + "operationId": "updateFilesystemv6SettingsCompression", + "parameters": [ + { + "in": "body", + "name": "v6SettingsCompression", + "required": true, + "schema": { + "$ref": "#/definitions/v6SettingsCompressionExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + } + }, + "/platform/6/protocols/smb/settings/global": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv6SmbSettingsGlobal", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v6SmbSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv6SmbSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v6SmbSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v6SmbSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/6/protocols/smb/settings/share": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv6SmbSettingsShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Zone which contains these share settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v6SmbSettingsShare" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv6SmbSettingsShare", + "parameters": [ + { + "description": "Zone which contains these share settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v6SmbSettingsShare", + "required": true, + "schema": { + "$ref": "#/definitions/v6SmbSettingsShareSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/6/protocols/smb/settings/zone": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv6SmbSettingsZone", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Name of the access zone", + "in": "query", + "maxLength": 511, + "minLength": 1, + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v6SmbSettingsZone" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv6SmbSettingsZone", + "parameters": [ + { + "description": "Name of the access zone", + "in": "query", + "maxLength": 511, + "minLength": 1, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v6SmbSettingsZone", + "required": true, + "schema": { + "$ref": "#/definitions/v6SmbSettingsZoneSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/6/protocols/smb/shares": { + "delete": { + "description": "Delete multiple smb shares.", + "operationId": "deleteProtocolsv6SmbShares", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List all shares.", + "operationId": "listProtocolsv6SmbShares", + "parameters": [ + { + "description": "Order results by this field. Default is id.", + "enum": [ + "id", + "name", + "path", + "description" + ], + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 5000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all shares.", + "schema": { + "$ref": "#/definitions/v6SmbShares" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new share.", + "operationId": "createProtocolsv6SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v6SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v6SmbShare" + } + } + ], + "responses": { + "200": { + "description": "Create a new share.", + "schema": { + "$ref": "#/definitions/Createv12SmbShareResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/6/protocols/smb/shares/{v6SmbShareId}": { + "delete": { + "description": "Delete the share.", + "operationId": "deleteProtocolsv6SmbShare", + "parameters": [ + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Delete the share.", + "in": "path", + "name": "v6SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve share.", + "operationId": "getProtocolsv6SmbShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve share.", + "in": "path", + "name": "v6SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve share.", + "schema": { + "$ref": "#/definitions/v6SmbSharesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv6SmbShare", + "parameters": [ + { + "description": "Zone which contains this share.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v6SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v6SmbShareExtendedExtended" + } + }, + { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v6SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/antivirus/settings": { + "get": { + "description": "Retrieve the Antivirus settings.", + "operationId": "getAntivirusv7AntivirusSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the Antivirus settings.", + "schema": { + "$ref": "#/definitions/v7AntivirusSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + }, + "put": { + "description": "Modify the Antivirus settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateAntivirusv7AntivirusSettings", + "parameters": [ + { + "in": "body", + "name": "v7AntivirusSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v7AntivirusSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Antivirus" + ] + } + }, + "/platform/7/audit/settings": { + "get": { + "description": "View per-Access Zone Audit settings.", + "operationId": "getAuditv7AuditSettings", + "parameters": [ + { + "description": "Access zone which contains audit settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "View per-Access Zone Audit settings.", + "schema": { + "$ref": "#/definitions/v7AuditSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "put": { + "description": "Modify per-Access Zone Audit settings.", + "operationId": "updateAuditv7AuditSettings", + "parameters": [ + { + "description": "Access zone which contains audit settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7AuditSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v7AuditSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/7/audit/settings/global": { + "get": { + "description": "View Global Audit settings.", + "operationId": "getAuditv7SettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "View Global Audit settings.", + "schema": { + "$ref": "#/definitions/v7SettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + }, + "put": { + "description": "Modify Global Audit settings.", + "operationId": "updateAuditv7SettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v7SettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v7SettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Audit" + ] + } + }, + "/platform/7/auth/error/{v7AuthErrorError}": { + "get": { + "description": "Get descriptions for auth error codes", + "operationId": "getAuthv7AuthErrorError", + "parameters": [ + { + "description": "Get descriptions for auth error codes", + "in": "path", + "name": "v7AuthErrorError", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get descriptions for auth error codes", + "schema": { + "$ref": "#/definitions/v7AuthError" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/ldap-templates": { + "get": { + "description": "List all LDAP provider templates.", + "operationId": "getAuthv7AuthLdapTemplates", + "parameters": [], + "responses": { + "200": { + "description": "List all LDAP provider templates.", + "schema": { + "$ref": "#/definitions/v7AuthLdapTemplates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/ldap-templates/{v7AuthLdapTemplateId}": { + "get": { + "description": "Retrieve the LDAP provider template.", + "operationId": "getAuthv7AuthLdapTemplate", + "parameters": [ + { + "description": "Retrieve the LDAP provider template.", + "in": "path", + "name": "v7AuthLdapTemplateId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the LDAP provider template.", + "schema": { + "$ref": "#/definitions/v7AuthLdapTemplates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/privileges": { + "get": { + "description": "List all privileges.", + "operationId": "getAuthv7AuthPrivileges", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all privileges.", + "schema": { + "$ref": "#/definitions/v1AuthPrivileges" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/ads": { + "get": { + "description": "List all ADS providers.", + "operationId": "listAuthv7ProvidersAds", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS providers.", + "schema": { + "$ref": "#/definitions/v7ProvidersAds" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new ADS provider.", + "operationId": "createAuthv7ProvidersAdsItem", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersAdsItem", + "required": true, + "schema": { + "$ref": "#/definitions/v7ProvidersAdsItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new ADS provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/ads/{Id}/controllers": { + "get": { + "description": "List all ADS controllers.", + "operationId": "getAuthProvidersv7AdsProviderControllers", + "parameters": [ + { + "description": "Domain Controller site name", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "dc_site", + "type": "string" + }, + { + "description": "Groupnet identifier", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS controllers.", + "schema": { + "$ref": "#/definitions/v1AdsProviderControllers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthProviders" + ] + } + }, + "/platform/7/auth/providers/ads/{Id}/domains": { + "get": { + "description": "List all ADS domains.", + "operationId": "getAuthProvidersv7AdsProviderDomains", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all ADS domains.", + "schema": { + "$ref": "#/definitions/v3AdsProviderDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthProviders" + ] + } + }, + "/platform/7/auth/providers/ads/{Id}/domains/{v7ProvidersAdsIdDomainId}": { + "get": { + "description": "Retrieve the ADS domain information.", + "operationId": "getAuthv7ProvidersAdsIdDomain", + "parameters": [ + { + "description": "Retrieve the ADS domain information.", + "in": "path", + "name": "v7ProvidersAdsIdDomainId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ADS domain information.", + "schema": { + "$ref": "#/definitions/v3AdsProviderDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/ads/{v7ProvidersAdsId}": { + "delete": { + "description": "Delete the ADS provider.", + "operationId": "deleteAuthv7ProvidersAdsById", + "parameters": [ + { + "description": "Delete the ADS provider.", + "in": "path", + "name": "v7ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the ADS provider.", + "operationId": "getAuthv7ProvidersAdsById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the ADS provider.", + "in": "path", + "name": "v7ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ADS provider.", + "schema": { + "$ref": "#/definitions/v7ProvidersAdsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the ADS provider.", + "operationId": "updateAuthv7ProvidersAdsById", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersAdsIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v7ProvidersAdsIdParams" + } + }, + { + "description": "Modify the ADS provider.", + "in": "path", + "name": "v7ProvidersAdsId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/duo": { + "get": { + "description": "Retrieve Duo provider.", + "operationId": "getAuthv7ProvidersDuo", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve Duo provider.", + "schema": { + "$ref": "#/definitions/v7ProvidersDuo" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify Duo provider.", + "operationId": "updateAuthv7ProvidersDuo", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersDuo", + "required": true, + "schema": { + "$ref": "#/definitions/v7ProvidersDuoExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/file": { + "get": { + "description": "List all file providers.", + "operationId": "listAuthv7ProvidersFile", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all file providers.", + "schema": { + "$ref": "#/definitions/v7ProvidersFile" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new file provider.", + "operationId": "createAuthv7ProvidersFileItem", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersFileItem", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersFileItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new file provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/file/{v7ProvidersFileId}": { + "delete": { + "description": "Delete the file provider.", + "operationId": "deleteAuthv7ProvidersFileById", + "parameters": [ + { + "description": "Delete the file provider.", + "in": "path", + "name": "v7ProvidersFileId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the file provider.", + "operationId": "getAuthv7ProvidersFileById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the file provider.", + "in": "path", + "name": "v7ProvidersFileId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the file provider.", + "schema": { + "$ref": "#/definitions/v7ProvidersFile" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the file provider.", + "operationId": "updateAuthv7ProvidersFileById", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersFileIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersFileIdParams" + } + }, + { + "description": "Modify the file provider.", + "in": "path", + "name": "v7ProvidersFileId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/krb5": { + "get": { + "description": "List all KRB5 providers.", + "operationId": "listAuthv7ProvidersKrb5", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all KRB5 providers.", + "schema": { + "$ref": "#/definitions/v7ProvidersKrb5" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new KRB5 provider.", + "operationId": "createAuthv7ProvidersKrb5Item", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersKrb5Item", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersKrb5Item" + } + } + ], + "responses": { + "200": { + "description": "Create a new KRB5 provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/krb5/{v7ProvidersKrb5Id}": { + "delete": { + "description": "Delete the KRB5 provider.", + "operationId": "deleteAuthv7ProvidersKrb5ById", + "parameters": [ + { + "description": "Delete the KRB5 provider.", + "in": "path", + "name": "v7ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the KRB5 provider.", + "operationId": "getAuthv7ProvidersKrb5ById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the KRB5 provider.", + "in": "path", + "name": "v7ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the KRB5 provider.", + "schema": { + "$ref": "#/definitions/v7ProvidersKrb5Extended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the KRB5 provider.", + "operationId": "updateAuthv7ProvidersKrb5ById", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersKrb5IdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersKrb5IdParams" + } + }, + { + "description": "Modify the KRB5 provider.", + "in": "path", + "name": "v7ProvidersKrb5Id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/ldap": { + "get": { + "description": "List all LDAP providers.", + "operationId": "listAuthv7ProvidersLdap", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all LDAP providers.", + "schema": { + "$ref": "#/definitions/v7ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new LDAP provider.", + "operationId": "createAuthv7ProvidersLdapItem", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v7ProvidersLdapItem", + "required": true, + "schema": { + "$ref": "#/definitions/v7ProvidersLdapItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new LDAP provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/ldap/{v7ProvidersLdapId}": { + "delete": { + "description": "Delete the LDAP provider.", + "operationId": "deleteAuthv7ProvidersLdapById", + "parameters": [ + { + "description": "Delete the LDAP provider.", + "in": "path", + "name": "v7ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the LDAP provider.", + "operationId": "getAuthv7ProvidersLdapById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the LDAP provider.", + "in": "path", + "name": "v7ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the LDAP provider.", + "schema": { + "$ref": "#/definitions/v7ProvidersLdap" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the LDAP provider.", + "operationId": "updateAuthv7ProvidersLdapById", + "parameters": [ + { + "description": "Ignore unresolvable server URIs.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v7ProvidersLdapIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v7ProvidersLdapIdParams" + } + }, + { + "description": "Modify the LDAP provider.", + "in": "path", + "name": "v7ProvidersLdapId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/local": { + "get": { + "description": "List all local providers.", + "operationId": "getAuthv7ProvidersLocal", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all local providers.", + "schema": { + "$ref": "#/definitions/v7ProvidersLocal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/local/{v7ProvidersLocalId}": { + "get": { + "description": "Retrieve the local provider.", + "operationId": "getAuthv7ProvidersLocalById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the local provider.", + "in": "path", + "name": "v7ProvidersLocalId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the local provider.", + "schema": { + "$ref": "#/definitions/v7ProvidersLocal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the local provider.", + "operationId": "updateAuthv7ProvidersLocalById", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersLocalIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersLocalIdParams" + } + }, + { + "description": "Modify the local provider.", + "in": "path", + "name": "v7ProvidersLocalId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/nis": { + "get": { + "description": "List all NIS providers.", + "operationId": "listAuthv7ProvidersNis", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all NIS providers.", + "schema": { + "$ref": "#/definitions/v7ProvidersNis" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new NIS provider.", + "operationId": "createAuthv7ProvidersNisItem", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersNisItem", + "required": true, + "schema": { + "$ref": "#/definitions/v3ProvidersNisItem" + } + } + ], + "responses": { + "200": { + "description": "Create a new NIS provider.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/providers/nis/{v7ProvidersNisId}": { + "delete": { + "description": "Delete the NIS provider.", + "operationId": "deleteAuthv7ProvidersNisById", + "parameters": [ + { + "description": "Delete the NIS provider.", + "in": "path", + "name": "v7ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the NIS provider.", + "operationId": "getAuthv7ProvidersNisById", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "Retrieve the NIS provider.", + "in": "path", + "name": "v7ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the NIS provider.", + "schema": { + "$ref": "#/definitions/v7ProvidersNis" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the NIS provider.", + "operationId": "updateAuthv7ProvidersNisById", + "parameters": [ + { + "in": "body", + "name": "v7ProvidersNisIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v1ProvidersNisIdParams" + } + }, + { + "description": "Modify the NIS provider.", + "in": "path", + "name": "v7ProvidersNisId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/roles": { + "get": { + "description": "List all roles.", + "operationId": "listAuthv7AuthRoles", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all roles.", + "schema": { + "$ref": "#/definitions/v1AuthRoles" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new role.", + "operationId": "createAuthv7AuthRole", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7AuthRole", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthRole" + } + } + ], + "responses": { + "200": { + "description": "Create a new role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/roles/{Role}/members": { + "get": { + "description": "List all the members of the role.", + "operationId": "listAuthRolesv7RoleMembers", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the members of the role.", + "schema": { + "$ref": "#/definitions/v1RoleMembers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + }, + "post": { + "description": "Add a member to the role.", + "operationId": "createAuthRolesv7RoleMember", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7RoleMember", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a member to the role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + } + }, + "/platform/7/auth/roles/{Role}/members/{v7RolesRoleMemberId}": { + "delete": { + "description": "Remove a member from the role.", + "operationId": "deleteAuthv7RolesRoleMember", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Remove a member from the role.", + "in": "path", + "name": "v7RolesRoleMemberId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/roles/{Role}/privileges": { + "get": { + "description": "List all privileges in the role.", + "operationId": "listAuthRolesv7RolePrivileges", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all privileges in the role.", + "schema": { + "$ref": "#/definitions/v1RolePrivileges" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + }, + "post": { + "description": "Add a privilege to the role.", + "operationId": "createAuthRolesv7RolePrivilege", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7RolePrivilege", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthIdNtokenPrivilegeItem" + } + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a privilege to the role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + } + }, + "/platform/7/auth/roles/{Role}/privileges/{v7RolesRolePrivilegeId}": { + "delete": { + "description": "Remove a privilege from a role.", + "operationId": "deleteAuthv7RolesRolePrivilege", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Remove a privilege from a role.", + "in": "path", + "name": "v7RolesRolePrivilegeId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/roles/{v7AuthRoleId}": { + "delete": { + "description": "Delete the role.", + "operationId": "deleteAuthv7AuthRole", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Delete the role.", + "in": "path", + "name": "v7AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the role information.", + "operationId": "getAuthv7AuthRole", + "parameters": [ + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve the role information.", + "in": "path", + "name": "v7AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the role information.", + "schema": { + "$ref": "#/definitions/v1AuthRolesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the role.", + "operationId": "updateAuthv7AuthRole", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7AuthRole", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthRoleExtendedExtended" + } + }, + { + "description": "Modify the role.", + "in": "path", + "name": "v7AuthRoleId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/settings/acls": { + "get": { + "description": "Retrieve the ACL policy settings and preset configurations.", + "operationId": "getAuthv7SettingsAcls", + "parameters": [ + { + "description": "If specified the preset configuration values for all applicable ACL policies are returned.", + "enum": [ + "balanced", + "unix", + "windows" + ], + "in": "query", + "name": "preset", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the ACL policy settings and preset configurations.", + "schema": { + "$ref": "#/definitions/v7SettingsAcls" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify cluster ACL policy settings.", + "operationId": "updateAuthv7SettingsAcls", + "parameters": [ + { + "in": "body", + "name": "v7SettingsAcls", + "required": true, + "schema": { + "$ref": "#/definitions/v7SettingsAclsAclPolicySettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/users": { + "delete": { + "description": "Flush the users cache.", + "operationId": "deleteAuthv7AuthUsers", + "parameters": [ + { + "description": "If true, only flush cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "List all users.", + "operationId": "listAuthv7AuthUsers", + "parameters": [ + { + "description": "Filter users by domain.", + "in": "query", + "name": "domain", + "type": "string" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, only return cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Filter users by name prefix.", + "in": "query", + "name": "filter", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Enumerate all users that a group is a member of.", + "in": "query", + "name": "query_member_of", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List all users.", + "schema": { + "$ref": "#/definitions/v7AuthUsers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "post": { + "description": "Create a new user.", + "operationId": "createAuthv7AuthUser", + "parameters": [ + { + "description": "Skip validation checks when creating user.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Optional provider type.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v7AuthUser", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthUser" + } + } + ], + "responses": { + "200": { + "description": "Create a new user.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/auth/users/{v7AuthUserId}": { + "delete": { + "description": "Delete the user.", + "operationId": "deleteAuthv7AuthUser", + "parameters": [ + { + "description": "If true, flush the user from the cache.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Delete the user.", + "in": "path", + "name": "v7AuthUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "get": { + "description": "Retrieve the user information.", + "operationId": "getAuthv7AuthUser", + "parameters": [ + { + "description": "If true, only return cached objects.", + "in": "query", + "name": "cached", + "type": "boolean" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Enumerate all users that a group is a member of.", + "in": "query", + "name": "query_member_of", + "type": "boolean" + }, + { + "description": "Filter users by zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Filter users by provider.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "description": "Retrieve the user information.", + "in": "path", + "name": "v7AuthUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the user information.", + "schema": { + "$ref": "#/definitions/v7AuthUsersExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + }, + "put": { + "description": "Modify the user.", + "operationId": "updateAuthv7AuthUser", + "parameters": [ + { + "description": "Changes to the user ID can result in loss of access to the file system. To mitigate this risk of lost access, the force option is required for user ID changes.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Optional zone.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Optional provider type.", + "in": "query", + "name": "provider", + "type": "string" + }, + { + "in": "body", + "name": "v7AuthUser", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthUserExtended" + } + }, + { + "description": "Modify the user.", + "in": "path", + "name": "v7AuthUserId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/7/certificate/authority": { + "get": { + "description": "Retrieve a list of all configured TLS certificate authorities.", + "operationId": "listCertificatev7CertificateAuthority", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of all configured TLS certificate authorities.", + "schema": { + "$ref": "#/definitions/v7CertificateAuthority" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + }, + "post": { + "description": "Import a TLS certificate authority.", + "operationId": "createCertificatev7CertificateAuthorityItem", + "parameters": [ + { + "in": "body", + "name": "v7CertificateAuthorityItem", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityItem" + } + } + ], + "responses": { + "200": { + "description": "Import a TLS certificate authority.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + } + }, + "/platform/7/certificate/authority/{v7CertificateAuthorityId}": { + "delete": { + "description": "Delete a TLS certificate authority.", + "operationId": "deleteCertificatev7CertificateAuthorityById", + "parameters": [ + { + "description": "Delete a TLS certificate authority.", + "in": "path", + "name": "v7CertificateAuthorityId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + }, + "get": { + "description": "Retrieve a single TLS certificate authority.", + "operationId": "getCertificatev7CertificateAuthorityById", + "parameters": [ + { + "description": "Retrieve a single TLS certificate authority.", + "in": "path", + "name": "v7CertificateAuthorityId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a single TLS certificate authority.", + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + }, + "put": { + "description": "Modify a TLS certificate authority.", + "operationId": "updateCertificatev7CertificateAuthorityById", + "parameters": [ + { + "in": "body", + "name": "v7CertificateAuthorityIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityIdParams" + } + }, + { + "description": "Modify a TLS certificate authority.", + "in": "path", + "name": "v7CertificateAuthorityId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + } + }, + "/platform/7/certificate/settings": { + "get": { + "description": "Retrieve system-wide TLS certificate settings.", + "operationId": "getCertificatev7CertificateSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve system-wide TLS certificate settings.", + "schema": { + "$ref": "#/definitions/v7CertificateSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + }, + "put": { + "description": "Modify system-wide TLS certificate settings.", + "operationId": "updateCertificatev7CertificateSettings", + "parameters": [ + { + "in": "body", + "name": "v7CertificateSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Certificate" + ] + } + }, + "/platform/7/cloud/accounts": { + "get": { + "description": "List all accounts.", + "operationId": "listCloudv7CloudAccounts", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all accounts.", + "schema": { + "$ref": "#/definitions/v7CloudAccounts" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "post": { + "description": "Create a new account.", + "operationId": "createCloudv7CloudAccount", + "parameters": [ + { + "in": "body", + "name": "v7CloudAccount", + "required": true, + "schema": { + "$ref": "#/definitions/v7CloudAccount" + } + } + ], + "responses": { + "200": { + "description": "Create a new account.", + "schema": { + "$ref": "#/definitions/Createv7CloudAccountResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/7/cloud/accounts/{v7CloudAccountId}": { + "delete": { + "description": "Delete cloud account.", + "operationId": "deleteCloudv7CloudAccount", + "parameters": [ + { + "description": "A value of 1 acknowledges that the user is deleting data.", + "in": "query", + "name": "acknowledge_force_delete", + "type": "string" + }, + { + "description": "Delete cloud account.", + "in": "path", + "name": "v7CloudAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "get": { + "description": "Retrieve cloud account information.", + "operationId": "getCloudv7CloudAccount", + "parameters": [ + { + "description": "Retrieve cloud account information.", + "in": "path", + "name": "v7CloudAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve cloud account information.", + "schema": { + "$ref": "#/definitions/v7CloudAccountsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "put": { + "description": "Modify cloud account. All fields are optional, but one or more must be supplied.", + "operationId": "updateCloudv7CloudAccount", + "parameters": [ + { + "in": "body", + "name": "v7CloudAccount", + "required": true, + "schema": { + "$ref": "#/definitions/v7CloudAccountExtendedExtended" + } + }, + { + "description": "Modify cloud account. All fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v7CloudAccountId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/7/cloud/certificates": { + "get": { + "description": "Retrieve a list of all CloudPools client certificates.", + "operationId": "listCloudv7CloudCertificates", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of all CloudPools client certificates.", + "schema": { + "$ref": "#/definitions/v7CloudCertificates" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "post": { + "description": "Import a TLS client certificate.", + "operationId": "createCloudv7CloudCertificate", + "parameters": [ + { + "in": "body", + "name": "v7CloudCertificate", + "required": true, + "schema": { + "$ref": "#/definitions/v4CertificateServerItem" + } + } + ], + "responses": { + "200": { + "description": "Import a TLS client certificate.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/7/cloud/certificates/{v7CloudCertificateId}": { + "delete": { + "description": "Delete a CloudPools TLS client certificate.", + "operationId": "deleteCloudv7CloudCertificate", + "parameters": [ + { + "description": "Delete a CloudPools TLS client certificate.", + "in": "path", + "name": "v7CloudCertificateId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "get": { + "description": "Retrieve a CloudPools TLS client certificate.", + "operationId": "getCloudv7CloudCertificate", + "parameters": [ + { + "description": "Retrieve a CloudPools TLS client certificate.", + "in": "path", + "name": "v7CloudCertificateId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a CloudPools TLS client certificate.", + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "put": { + "description": "Modify a CloudPools TLS client certificate.", + "operationId": "updateCloudv7CloudCertificate", + "parameters": [ + { + "in": "body", + "name": "v7CloudCertificate", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityIdParams" + } + }, + { + "description": "Modify a CloudPools TLS client certificate.", + "in": "path", + "name": "v7CloudCertificateId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/7/cloud/pools": { + "get": { + "description": "List all pools.", + "operationId": "listCloudv7CloudPools", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all pools.", + "schema": { + "$ref": "#/definitions/v7CloudPools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "post": { + "description": "Create a new pool.", + "operationId": "createCloudv7CloudPool", + "parameters": [ + { + "in": "body", + "name": "v7CloudPool", + "required": true, + "schema": { + "$ref": "#/definitions/v7CloudPool" + } + } + ], + "responses": { + "200": { + "description": "Create a new pool.", + "schema": { + "$ref": "#/definitions/Createv7CloudPoolResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/7/cloud/pools/{v7CloudPoolId}": { + "delete": { + "description": "Delete a cloud pool.", + "operationId": "deleteCloudv7CloudPool", + "parameters": [ + { + "description": "A value of 1 acknowledges that the user is deleting data.", + "in": "query", + "name": "acknowledge_force_delete", + "type": "string" + }, + { + "description": "Delete a cloud pool.", + "in": "path", + "name": "v7CloudPoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "get": { + "description": "Retrieve cloud pool information", + "operationId": "getCloudv7CloudPool", + "parameters": [ + { + "description": "Retrieve cloud pool information", + "in": "path", + "name": "v7CloudPoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve cloud pool information", + "schema": { + "$ref": "#/definitions/v7CloudPoolsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + }, + "put": { + "description": "Modify a cloud pool. All fields are optional, but one or more must be supplied.", + "operationId": "updateCloudv7CloudPool", + "parameters": [ + { + "in": "body", + "name": "v7CloudPool", + "required": true, + "schema": { + "$ref": "#/definitions/v7CloudPoolExtendedExtended" + } + }, + { + "description": "Modify a cloud pool. All fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v7CloudPoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cloud" + ] + } + }, + "/platform/7/cluster/internal-networks": { + "get": { + "description": "View internal networks settings.", + "operationId": "getClusterv7ClusterInternalNetworks", + "parameters": [], + "responses": { + "200": { + "description": "View internal networks settings.", + "schema": { + "$ref": "#/definitions/v7ClusterInternalNetworks" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify IP address ranges to be used for internal network configuration.", + "operationId": "updateClusterv7ClusterInternalNetworks", + "parameters": [ + { + "description": "Token returned by earlier PUT call with the same configuration.", + "in": "query", + "maxLength": 2147483646, + "minLength": 0, + "name": "reboot_confirmation_token", + "type": "string" + }, + { + "in": "body", + "name": "v7ClusterInternalNetworks", + "required": true, + "schema": { + "$ref": "#/definitions/v7ClusterInternalNetworksExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/7/cluster/nodes": { + "get": { + "description": "List the nodes on this cluster.", + "operationId": "getClusterv7ClusterNodes", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + } + ], + "responses": { + "200": { + "description": "List the nodes on this cluster.", + "schema": { + "$ref": "#/definitions/v7ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/7/cluster/nodes/{Lnn}/driveconfig": { + "get": { + "description": "View a node's drive subsystem XML configuration file.", + "operationId": "getClusterNodesv7NodeDriveconfig", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "View a node's drive subsystem XML configuration file.", + "schema": { + "$ref": "#/definitions/v7NodeDriveconfig" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + }, + "put": { + "description": "Modify a node's drive subsystem XML configuration file.", + "operationId": "updateClusterNodesv7NodeDriveconfig", + "parameters": [ + { + "in": "body", + "name": "v7NodeDriveconfig", + "required": true, + "schema": { + "$ref": "#/definitions/v7NodeDriveconfigExtended" + } + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/7/cluster/nodes/{Lnn}/drives": { + "get": { + "description": "List the drives on this node.", + "operationId": "getClusterNodesv7NodeDrives", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List the drives on this node.", + "schema": { + "$ref": "#/definitions/v7NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/7/cluster/nodes/{Lnn}/drives/{Driveid}/firmware": { + "get": { + "description": "Retrieve drive firmware information.", + "operationId": "getClusterNodesv7DrivesDriveFirmware", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Driveid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve drive firmware information.", + "schema": { + "$ref": "#/definitions/v3DrivesDriveFirmware" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/7/cluster/nodes/{Lnn}/drives/{v7NodesLnnDriveId}": { + "get": { + "description": "Retrieve drive information.", + "operationId": "getClusterv7NodesLnnDrive", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve drive information.", + "in": "path", + "name": "v7NodesLnnDriveId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve drive information.", + "schema": { + "$ref": "#/definitions/v7NodeDrives" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/7/cluster/nodes/{Lnn}/internal-ip-address": { + "get": { + "description": "View internal ip address with respect to node.", + "operationId": "getClusterNodesv7NodeInternalIpAddress", + "parameters": [ + { + "in": "path", + "name": "Lnn", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "View internal ip address with respect to node.", + "schema": { + "$ref": "#/definitions/v7NodeInternalIpAddress" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "ClusterNodes" + ] + } + }, + "/platform/7/cluster/nodes/{v7ClusterNodeId}": { + "get": { + "description": "Retrieve node information.", + "operationId": "getClusterv7ClusterNode", + "parameters": [ + { + "description": "Request timeout", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "timeout", + "type": "number" + }, + { + "description": "Retrieve node information.", + "in": "path", + "name": "v7ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Retrieve node information.", + "schema": { + "$ref": "#/definitions/v7ClusterNodes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + }, + "put": { + "description": "Modify one or more node settings.", + "operationId": "updateClusterv7ClusterNode", + "parameters": [ + { + "in": "body", + "name": "v7ClusterNode", + "required": true, + "schema": { + "$ref": "#/definitions/v3ClusterNodeExtended" + } + }, + { + "description": "Modify one or more node settings.", + "in": "path", + "name": "v7ClusterNodeId", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/7/cluster/update-lnns": { + "put": { + "description": "Modify the list of current lnn(s) with respective new lnn(s) to be used for configuration.", + "operationId": "updateClusterv7ClusterUpdateLnns", + "parameters": [ + { + "in": "body", + "name": "v7ClusterUpdateLnns", + "required": true, + "schema": { + "$ref": "#/definitions/v7ClusterUpdateLnns" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Cluster" + ] + } + }, + "/platform/7/event/channels": { + "get": { + "description": "List all channels.", + "operationId": "listEventv7EventChannels", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all channels.", + "schema": { + "$ref": "#/definitions/v7EventChannels" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "post": { + "description": "Create a new channel.", + "operationId": "createEventv7EventChannels", + "parameters": [ + { + "in": "body", + "name": "v7EventChannels", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventChannels" + } + } + ], + "responses": { + "200": { + "description": "Create a new channel.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/7/event/channels/{v7EventChannelId}": { + "delete": { + "description": "Delete the channel.", + "operationId": "deleteEventv7EventChannel", + "parameters": [ + { + "description": "Delete the channel.", + "in": "path", + "name": "v7EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "get": { + "description": "Retrieve the channel.", + "operationId": "getEventv7EventChannel", + "parameters": [ + { + "description": "Retrieve the channel.", + "in": "path", + "name": "v7EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the channel.", + "schema": { + "$ref": "#/definitions/v3EventChannelsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + }, + "put": { + "description": "Modify the channel.", + "operationId": "updateEventv7EventChannel", + "parameters": [ + { + "in": "body", + "name": "v7EventChannel", + "required": true, + "schema": { + "$ref": "#/definitions/v12EventChannelExtended" + } + }, + { + "description": "Modify the channel.", + "in": "path", + "name": "v7EventChannelId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/7/event/eventlists": { + "get": { + "description": "List all event occurrences grouped by eventgroup occurrence.", + "operationId": "getEventv7EventEventlists", + "parameters": [ + { + "description": "Return only this event occurrence", + "in": "query", + "name": "event_instance", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Filter by eventgroup id.", + "in": "query", + "items": { + "maximum": 255, + "minimum": 1, + "type": "integer" + }, + "name": "eventgroup_id", + "type": "array" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all event occurrences grouped by eventgroup occurrence.", + "schema": { + "$ref": "#/definitions/v7EventEventlists" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/7/event/eventlists/{v7EventEventlistId}": { + "get": { + "description": "Retrieve the list of events for an eventgroup occurrence.", + "operationId": "getEventv7EventEventlist", + "parameters": [ + { + "description": "Retrieve the list of events for an eventgroup occurrence.", + "in": "path", + "name": "v7EventEventlistId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the list of events for an eventgroup occurrence.", + "schema": { + "$ref": "#/definitions/v7EventEventlistsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/7/filesystem/settings/character-encodings": { + "get": { + "description": "Retrieve current cluster character encoding settings.", + "operationId": "getFilesystemv7SettingsCharacterEncodings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve current cluster character encoding settings.", + "schema": { + "$ref": "#/definitions/v7SettingsCharacterEncodings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + }, + "put": { + "description": "Set current character encoding.", + "operationId": "updateFilesystemv7SettingsCharacterEncodings", + "parameters": [ + { + "in": "body", + "name": "v7SettingsCharacterEncodings", + "required": true, + "schema": { + "$ref": "#/definitions/v7SettingsCharacterEncodingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Filesystem" + ] + } + }, + "/platform/7/id-resolution/domains": { + "get": { + "description": "List domain to path mappings.", + "operationId": "getIdResolutionv7IdResolutionDomains", + "parameters": [ + { + "description": "A comma separated list specifying the domains that will be mapped with a path. Only the domains specified in this list will be mapped.", + "in": "query", + "name": "domains", + "type": "string" + }, + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List domain to path mappings.", + "schema": { + "$ref": "#/definitions/v7IdResolutionDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/id-resolution/domains/{v7IdResolutionDomainId}": { + "get": { + "description": "List domain to path mappings.", + "operationId": "getIdResolutionv7IdResolutionDomain", + "parameters": [ + { + "description": "List domain to path mappings.", + "in": "path", + "name": "v7IdResolutionDomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List domain to path mappings.", + "schema": { + "$ref": "#/definitions/v7IdResolutionDomainsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/id-resolution/lins": { + "get": { + "description": "List lin to path mappings.", + "operationId": "getIdResolutionv7IdResolutionLins", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "A comma separated list specifying the lins that will be mapped with a path. Only the lins specified in this list will be mapped.", + "in": "query", + "name": "lins", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List lin to path mappings.", + "schema": { + "$ref": "#/definitions/v7IdResolutionLins" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/id-resolution/lins/{v7IdResolutionLinId}": { + "get": { + "description": "List lin to path mappings.", + "operationId": "getIdResolutionv7IdResolutionLin", + "parameters": [ + { + "description": "List lin to path mappings.", + "in": "path", + "name": "v7IdResolutionLinId", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "List lin to path mappings.", + "schema": { + "$ref": "#/definitions/v7IdResolutionLinsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/id-resolution/zones": { + "get": { + "description": "List zone id to zone name mappings.", + "operationId": "getIdResolutionv7IdResolutionZones", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "A comma separated list specifying the zone IDs to map with a zone name.", + "in": "query", + "name": "zone_ids", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List zone id to zone name mappings.", + "schema": { + "$ref": "#/definitions/v7IdResolutionZones" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/id-resolution/zones/{Zid}/groups": { + "get": { + "description": "List gid/gsid to groupname mappings.", + "operationId": "getIdResolutionZonesv7ZoneGroups", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "A comma separated list specifying the gsids to map with a groupname.", + "in": "query", + "name": "gsids", + "type": "string" + }, + { + "description": "A comma separated list specifying the gids to map with a groupname.", + "in": "query", + "name": "gids", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Zid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List gid/gsid to groupname mappings.", + "schema": { + "$ref": "#/definitions/v7ZoneGroups" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolutionZones" + ] + } + }, + "/platform/7/id-resolution/zones/{Zid}/groups/{v7ZonesZidGroupId}": { + "get": { + "description": "List a mapping of gid/gsid to groupname.", + "operationId": "getIdResolutionv7ZonesZidGroup", + "parameters": [ + { + "description": "List a mapping of gid/gsid to groupname.", + "in": "path", + "name": "v7ZonesZidGroupId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Zid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List a mapping of gid/gsid to groupname.", + "schema": { + "$ref": "#/definitions/v7ZonesZidGroups" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/id-resolution/zones/{Zid}/users": { + "get": { + "description": "List uid/sid to username mappings.", + "operationId": "getIdResolutionZonesv7ZoneUsers", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "A comma separated list specifying the uids to map with a username.", + "in": "query", + "name": "uids", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "A comma separated list specifying the sids to map with a username.", + "in": "query", + "name": "sids", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Zid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List uid/sid to username mappings.", + "schema": { + "$ref": "#/definitions/v7ZoneUsers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolutionZones" + ] + } + }, + "/platform/7/id-resolution/zones/{Zid}/users/{v7ZonesZidUserId}": { + "get": { + "description": "List a mapping of uid/sid to username.", + "operationId": "getIdResolutionv7ZonesZidUser", + "parameters": [ + { + "description": "List a mapping of uid/sid to username.", + "in": "path", + "name": "v7ZonesZidUserId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Zid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List a mapping of uid/sid to username.", + "schema": { + "$ref": "#/definitions/v7ZonesZidUsers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/id-resolution/zones/{v7IdResolutionZoneId}": { + "get": { + "description": "List zone id to zone name mappings.", + "operationId": "getIdResolutionv7IdResolutionZone", + "parameters": [ + { + "description": "List zone id to zone name mappings.", + "in": "path", + "name": "v7IdResolutionZoneId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List zone id to zone name mappings.", + "schema": { + "$ref": "#/definitions/v7IdResolutionZonesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "IdResolution" + ] + } + }, + "/platform/7/job/job-summary": { + "get": { + "description": "View job engine status.", + "operationId": "getJobv7JobJobSummary", + "parameters": [], + "responses": { + "200": { + "description": "View job engine status.", + "schema": { + "$ref": "#/definitions/v7JobJobSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/7/job/jobs": { + "get": { + "description": "List running and paused jobs.", + "operationId": "listJobv7JobJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, other arguments are ignored, and the query will return all results, unsorted, as quickly as possible.", + "in": "query", + "name": "batch", + "type": "boolean" + }, + { + "description": "Limit the results to jobs in the specified state.", + "enum": [ + "running", + "paused_user", + "paused_system", + "paused_policy", + "paused_priority" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List running and paused jobs.", + "schema": { + "$ref": "#/definitions/v10JobJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "post": { + "description": "Queue a new instance of a job type.", + "operationId": "createJobv7JobJob", + "parameters": [ + { + "in": "body", + "name": "v7JobJob", + "required": true, + "schema": { + "$ref": "#/definitions/v7JobJob" + } + } + ], + "responses": { + "200": { + "description": "Queue a new instance of a job type.", + "schema": { + "$ref": "#/definitions/Createv1JobJobResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/7/job/jobs/{v7JobJobId}": { + "get": { + "description": "View a single job instance.", + "operationId": "getJobv7JobJob", + "parameters": [ + { + "description": "View a single job instance.", + "in": "path", + "name": "v7JobJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single job instance.", + "schema": { + "$ref": "#/definitions/v7JobJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + }, + "put": { + "description": "Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.", + "operationId": "updateJobv7JobJob", + "parameters": [ + { + "in": "body", + "name": "v7JobJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1JobJobExtendedExtended" + } + }, + { + "description": "Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v7JobJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/7/job/reports": { + "get": { + "description": "List job reports.", + "operationId": "getJobv7JobReports", + "parameters": [ + { + "description": "Restrict the query to reports at or after the given time, in seconds since the Epoch.", + "in": "query", + "name": "begin", + "type": "integer" + }, + { + "description": "Restrict the query to reports before the given time, in seconds since the Epoch.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Restrict the query to the given job ID.", + "in": "query", + "name": "job_id", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Restrict the query to the given job type.", + "in": "query", + "name": "job_type", + "type": "string" + }, + { + "description": "Query timeout in milliseconds. The default is 10000 ms.", + "in": "query", + "name": "timeout_ms", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Restrict the query to the given report key.", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "if set, the query will return the last reported phase only.", + "in": "query", + "name": "last_phase_only", + "type": "boolean" + }, + { + "description": "Display more detailed information, including job engine framework statistics.", + "in": "query", + "name": "verbose", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "List job reports.", + "schema": { + "$ref": "#/definitions/v7JobReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Job" + ] + } + }, + "/platform/7/network/groupnets/{Groupnet}/subnets": { + "get": { + "description": "Get a list of subnets.", + "operationId": "listNetworkGroupnetsv7GroupnetSubnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of subnets.", + "schema": { + "$ref": "#/definitions/v12GroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + }, + "post": { + "description": "Create a new subnet.", + "operationId": "createNetworkGroupnetsv7GroupnetSubnet", + "parameters": [ + { + "in": "body", + "name": "v7GroupnetSubnet", + "required": true, + "schema": { + "$ref": "#/definitions/v12GroupnetSubnet" + } + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new subnet.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnets" + ] + } + }, + "/platform/7/network/groupnets/{Groupnet}/subnets/{Subnet}/pools/{Pool}/interfaces": { + "get": { + "description": "Get a list of interfaces.", + "operationId": "getNetworkGroupnetsSubnetsv7PoolsPoolInterfaces", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Get a list of interfaces for the specified lnn.", + "in": "query", + "name": "lnns", + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Subnet", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Pool", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of interfaces.", + "schema": { + "$ref": "#/definitions/v7PoolsPoolInterfaces" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "NetworkGroupnetsSubnets" + ] + } + }, + "/platform/7/network/groupnets/{Groupnet}/subnets/{v7GroupnetsGroupnetSubnetId}": { + "delete": { + "description": "Delete a network subnet.", + "operationId": "deleteNetworkv7GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "Force deleting this subnet even if pools in other subnets rely on this subnet's SC VIP.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a network subnet.", + "in": "path", + "name": "v7GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "get": { + "description": "View a network subnet.", + "operationId": "getNetworkv7GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "View a network subnet.", + "in": "path", + "name": "v7GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a network subnet.", + "schema": { + "$ref": "#/definitions/v7GroupnetsGroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + }, + "put": { + "description": "Modify a network subnet.", + "operationId": "updateNetworkv7GroupnetsGroupnetSubnet", + "parameters": [ + { + "description": "Force modifying this subnet even if it causes an MTU conflict.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v7GroupnetsGroupnetSubnet", + "required": true, + "schema": { + "$ref": "#/definitions/v7GroupnetsGroupnetSubnet" + } + }, + { + "description": "Modify a network subnet.", + "in": "path", + "name": "v7GroupnetsGroupnetSubnetId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Groupnet", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/7/network/interfaces": { + "get": { + "description": "Get a list of interfaces.", + "operationId": "getNetworkv7NetworkInterfaces", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Show interfaces associated with external and/or internal networks. Default is 'external'", + "enum": [ + "all", + "external", + "internal" + ], + "in": "query", + "name": "network", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Get a list of interfaces for the specified lnn.", + "in": "query", + "name": "lnns", + "type": "string" + }, + { + "description": "Filter addresses and owners by pool address allocation method.", + "enum": [ + "dynamic", + "static" + ], + "in": "query", + "name": "alloc_method", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of interfaces.", + "schema": { + "$ref": "#/definitions/v7PoolsPoolInterfaces" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/7/network/subnets": { + "get": { + "description": "Get a list of subnets.", + "operationId": "getNetworkv7NetworkSubnets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If specified, only subnets for this groupnet will be returned.", + "in": "query", + "maxLength": 32, + "minLength": 0, + "name": "groupnet", + "pattern": "(^[0-9a-zA-Z_-]*$|^~DEFAULT$)", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of subnets.", + "schema": { + "$ref": "#/definitions/v12GroupnetSubnets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Network" + ] + } + }, + "/platform/7/performance/datasets": { + "get": { + "description": "List all datasets.", + "operationId": "listPerformancev7PerformanceDatasets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all datasets.", + "schema": { + "$ref": "#/definitions/v7PerformanceDatasets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "post": { + "description": "Create a new dataset.", + "operationId": "createPerformancev7PerformanceDataset", + "parameters": [ + { + "in": "body", + "name": "v7PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v7PerformanceDataset" + } + } + ], + "responses": { + "200": { + "description": "Create a new dataset.", + "schema": { + "$ref": "#/definitions/Createv7PerformanceDatasetResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/7/performance/datasets/{Dataset}/filters": { + "delete": { + "description": "Delete all filters associated with the dataset.", + "operationId": "deletePerformanceDatasetsv7DatasetFilters", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all filters.", + "operationId": "listPerformanceDatasetsv7DatasetFilters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all filters.", + "schema": { + "$ref": "#/definitions/v7DatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new filter.", + "operationId": "createPerformanceDatasetsv7DatasetFilter", + "parameters": [ + { + "in": "body", + "name": "v7DatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v7DatasetFilter" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new filter.", + "schema": { + "$ref": "#/definitions/Createv10DatasetFilterResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/7/performance/datasets/{Dataset}/filters/{v7DatasetsDatasetFilterId}": { + "delete": { + "description": "Delete the filter.", + "operationId": "deletePerformancev7DatasetsDatasetFilter", + "parameters": [ + { + "description": "Delete the filter.", + "in": "path", + "name": "v7DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the filter.", + "operationId": "getPerformancev7DatasetsDatasetFilter", + "parameters": [ + { + "description": "Retrieve the filter.", + "in": "path", + "name": "v7DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the filter.", + "schema": { + "$ref": "#/definitions/v7DatasetsDatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the filter.", + "operationId": "updatePerformancev7DatasetsDatasetFilter", + "parameters": [ + { + "in": "body", + "name": "v7DatasetsDatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetFilter" + } + }, + { + "description": "Modify the filter.", + "in": "path", + "name": "v7DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/7/performance/datasets/{Dataset}/workloads": { + "delete": { + "description": "Delete all workloads associated with the dataset.", + "operationId": "deletePerformanceDatasetsv7DatasetWorkloads", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all workloads.", + "operationId": "listPerformanceDatasetsv7DatasetWorkloads", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all workloads.", + "schema": { + "$ref": "#/definitions/v7DatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new workload.", + "operationId": "createPerformanceDatasetsv7DatasetWorkload", + "parameters": [ + { + "in": "body", + "name": "v7DatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v7DatasetWorkload" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new workload.", + "schema": { + "$ref": "#/definitions/Createv10DatasetWorkloadResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/7/performance/datasets/{Dataset}/workloads/{v7DatasetsDatasetWorkloadId}": { + "delete": { + "description": "Delete the workload.", + "operationId": "deletePerformancev7DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Delete the workload.", + "in": "path", + "name": "v7DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the workload.", + "operationId": "getPerformancev7DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Retrieve the workload.", + "in": "path", + "name": "v7DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the workload.", + "schema": { + "$ref": "#/definitions/v7DatasetsDatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the workload.", + "operationId": "updatePerformancev7DatasetsDatasetWorkload", + "parameters": [ + { + "in": "body", + "name": "v7DatasetsDatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetWorkload" + } + }, + { + "description": "Modify the workload.", + "in": "path", + "name": "v7DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/7/performance/datasets/{v7PerformanceDatasetId}": { + "delete": { + "description": "Delete the performance dataset.", + "operationId": "deletePerformancev7PerformanceDataset", + "parameters": [ + { + "description": "Delete the performance dataset.", + "in": "path", + "name": "v7PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the performance dataset.", + "operationId": "getPerformancev7PerformanceDataset", + "parameters": [ + { + "description": "Retrieve the performance dataset.", + "in": "path", + "name": "v7PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the performance dataset.", + "schema": { + "$ref": "#/definitions/v7PerformanceDatasetsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the name of the performance dataset.", + "operationId": "updatePerformancev7PerformanceDataset", + "parameters": [ + { + "in": "body", + "name": "v7PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceDatasetExtendedExtended" + } + }, + { + "description": "Modify the name of the performance dataset.", + "in": "path", + "name": "v7PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/7/performance/metrics": { + "get": { + "description": "List all metrics.", + "operationId": "getPerformancev7PerformanceMetrics", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all metrics.", + "schema": { + "$ref": "#/definitions/v7PerformanceMetrics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/7/performance/metrics/{v7PerformanceMetricId}": { + "get": { + "description": "View a single performance metric.", + "operationId": "getPerformancev7PerformanceMetric", + "parameters": [ + { + "description": "View a single performance metric.", + "in": "path", + "name": "v7PerformanceMetricId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single performance metric.", + "schema": { + "$ref": "#/definitions/v7PerformanceMetricsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/7/performance/settings": { + "get": { + "description": "List all performance settings.", + "operationId": "getPerformancev7PerformanceSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all performance settings.", + "schema": { + "$ref": "#/definitions/v10PerformanceSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Configure performance settings.", + "operationId": "updatePerformancev7PerformanceSettings", + "parameters": [ + { + "description": "Allow modification of settings outside of recommended limits", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v7PerformanceSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/7/protocols/hdfs/crypto/settings": { + "get": { + "description": "Retrieve HDFS crypto settings.", + "operationId": "getProtocolsv7HdfsCryptoSettings", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve HDFS crypto settings.", + "schema": { + "$ref": "#/definitions/v7HdfsCryptoSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS crypto settings.", + "operationId": "updateProtocolsv7HdfsCryptoSettings", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7HdfsCryptoSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v7HdfsCryptoSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/protocols/nfs/settings/global": { + "get": { + "description": "Retrieve the NFS configuration.", + "operationId": "getProtocolsv7NfsSettingsGlobal", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the NFS configuration.", + "schema": { + "$ref": "#/definitions/v7NfsSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify the default values for NFS exports. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv7NfsSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v7NfsSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v7NfsSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/protocols/smb/settings/global": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv7SmbSettingsGlobal", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v6SmbSettingsGlobal" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv7SmbSettingsGlobal", + "parameters": [ + { + "in": "body", + "name": "v7SmbSettingsGlobal", + "required": true, + "schema": { + "$ref": "#/definitions/v6SmbSettingsGlobalSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/protocols/smb/settings/share": { + "get": { + "description": "List all settings.", + "operationId": "getProtocolsv7SmbSettingsShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all settings.", + "schema": { + "$ref": "#/definitions/v7SmbSettingsShare" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify one or more settings.", + "operationId": "updateProtocolsv7SmbSettingsShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7SmbSettingsShare", + "required": true, + "schema": { + "$ref": "#/definitions/v7SmbSettingsShareSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/protocols/smb/shares": { + "delete": { + "description": "Delete multiple smb shares.", + "operationId": "deleteProtocolsv7SmbShares", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "List all shares.", + "operationId": "listProtocolsv7SmbShares", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 5000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The position of the first item returned for a paginated query within the full result set.", + "in": "query", + "maximum": 2147483646, + "minimum": 0, + "name": "offset", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all shares.", + "schema": { + "$ref": "#/definitions/v7SmbShares" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "post": { + "description": "Create a new share.", + "operationId": "createProtocolsv7SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v7SmbShare" + } + } + ], + "responses": { + "200": { + "description": "Create a new share.", + "schema": { + "$ref": "#/definitions/Createv12SmbShareResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/protocols/smb/shares/{v7SmbShareId}": { + "delete": { + "description": "Delete the share.", + "operationId": "deleteProtocolsv7SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Delete the share.", + "in": "path", + "name": "v7SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "get": { + "description": "Retrieve share.", + "operationId": "getProtocolsv7SmbShare", + "parameters": [ + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "name": "scope", + "type": "string" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve share.", + "in": "path", + "name": "v7SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve share.", + "schema": { + "$ref": "#/definitions/v7SmbSharesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "operationId": "updateProtocolsv7SmbShare", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7SmbShare", + "required": true, + "schema": { + "$ref": "#/definitions/v7SmbShareExtendedExtended" + } + }, + { + "description": "Modify share. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v7SmbShareId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/protocols/ssh/settings": { + "get": { + "description": "ssh settings", + "operationId": "getProtocolsv7SshSettings", + "parameters": [], + "responses": { + "200": { + "description": "ssh settings", + "schema": { + "$ref": "#/definitions/v7SshSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "ssh settings", + "operationId": "updateProtocolsv7SshSettings", + "parameters": [ + { + "in": "body", + "name": "v7SshSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v7SshSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/7/quota/quotas": { + "delete": { + "description": "Delete all or matching quotas.", + "operationId": "deleteQuotav7QuotaQuotas", + "parameters": [ + { + "description": "Only delete quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only delete quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only delete user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Only delete quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only delete quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "operationId": "listQuotav7QuotaQuotas", + "parameters": [ + { + "description": "Only list quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only list quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If used with the path argument, match all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "If used with the path argument, match all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only list user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Set to true to only list quotas which have exceeded one or more of their thresholds.", + "in": "query", + "name": "exceeded", + "type": "boolean" + }, + { + "description": "Only list quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only list quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Use the named report as a source rather than the live quotas. See the /q/quota/reports resource for a list of valid reports.", + "in": "query", + "name": "report_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "schema": { + "$ref": "#/definitions/v7QuotaQuotas" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new quota.", + "operationId": "createQuotav7QuotaQuota", + "parameters": [ + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v7QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v12QuotaQuota" + } + } + ], + "responses": { + "200": { + "description": "Create a new quota.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/7/quota/quotas/{Qid}/notifications": { + "delete": { + "description": "Delete all quota specific rules. The quota will then use the global rules.", + "operationId": "deleteQuotaQuotasv7QuotaNotifications", + "parameters": [ + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + }, + "get": { + "description": "List all rules.", + "operationId": "listQuotaQuotasv7QuotaNotifications", + "parameters": [ + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all rules.", + "schema": { + "$ref": "#/definitions/v7QuotaNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + }, + "post": { + "description": "Create a new notification rule specific to this quota.", + "operationId": "createQuotaQuotasv7QuotaNotification", + "parameters": [ + { + "in": "body", + "name": "v7QuotaNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v7QuotaNotification" + } + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new notification rule specific to this quota.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + }, + "put": { + "description": "This method creates an empty set of rules so that the global rules are not used. The input must be an empty JSON object.", + "operationId": "updateQuotaQuotasv7QuotaNotifications", + "parameters": [ + { + "in": "body", + "name": "v7QuotaNotifications", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "QuotaQuotas" + ] + } + }, + "/platform/7/quota/quotas/{Qid}/notifications/{v7QuotasQidNotificationId}": { + "delete": { + "description": "Delete the notification rule.", + "operationId": "deleteQuotav7QuotasQidNotification", + "parameters": [ + { + "description": "Delete the notification rule.", + "in": "path", + "name": "v7QuotasQidNotificationId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve notification rule information.", + "operationId": "getQuotav7QuotasQidNotification", + "parameters": [ + { + "description": "Retrieve notification rule information.", + "in": "path", + "name": "v7QuotasQidNotificationId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve notification rule information.", + "schema": { + "$ref": "#/definitions/v7QuotasQidNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav7QuotasQidNotification", + "parameters": [ + { + "in": "body", + "name": "v7QuotasQidNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v7QuotasQidNotification" + } + }, + { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v7QuotasQidNotificationId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Qid", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/7/quota/quotas/{v7QuotaQuotaId}": { + "delete": { + "description": "Delete the quota.", + "operationId": "deleteQuotav7QuotaQuota", + "parameters": [ + { + "description": "Delete the quota.", + "in": "path", + "name": "v7QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve quota information.", + "operationId": "getQuotav7QuotaQuota", + "parameters": [ + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve quota information.", + "in": "path", + "name": "v7QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve quota information.", + "schema": { + "$ref": "#/definitions/v7QuotaQuotasExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav7QuotaQuota", + "parameters": [ + { + "in": "body", + "name": "v7QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v12QuotaQuotaExtendedExtended" + } + }, + { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v7QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/7/quota/settings/notifications": { + "delete": { + "description": "Delete all rules.", + "operationId": "deleteQuotav7SettingsNotifications", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all rules.", + "operationId": "listQuotav7SettingsNotifications", + "parameters": [], + "responses": { + "200": { + "description": "List all rules.", + "schema": { + "$ref": "#/definitions/v7SettingsNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new global notification rule.", + "operationId": "createQuotav7SettingsNotification", + "parameters": [ + { + "in": "body", + "name": "v7SettingsNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v7QuotaNotification" + } + } + ], + "responses": { + "200": { + "description": "Create a new global notification rule.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/7/quota/settings/notifications/{v7SettingsNotificationId}": { + "delete": { + "description": "Delete the notification rule.", + "operationId": "deleteQuotav7SettingsNotification", + "parameters": [ + { + "description": "Delete the notification rule.", + "in": "path", + "name": "v7SettingsNotificationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve notification rule information.", + "operationId": "getQuotav7SettingsNotification", + "parameters": [ + { + "description": "Retrieve notification rule information.", + "in": "path", + "name": "v7SettingsNotificationId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve notification rule information.", + "schema": { + "$ref": "#/definitions/v7QuotasQidNotifications" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav7SettingsNotification", + "parameters": [ + { + "in": "body", + "name": "v7SettingsNotification", + "required": true, + "schema": { + "$ref": "#/definitions/v7QuotasQidNotification" + } + }, + { + "description": "Modify notification rule. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v7SettingsNotificationId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/7/sync/certificates/peer": { + "get": { + "description": "Retrieve a list of all trusted SyncIQ peer TLS certificates.", + "operationId": "listSyncv7CertificatesPeer", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of all trusted SyncIQ peer TLS certificates.", + "schema": { + "$ref": "#/definitions/v7CertificatesPeer" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Import a trusted SyncIQ TLS certificate.", + "operationId": "createSyncv7CertificatesPeerItem", + "parameters": [ + { + "in": "body", + "name": "v7CertificatesPeerItem", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityItem" + } + } + ], + "responses": { + "200": { + "description": "Import a trusted SyncIQ TLS certificate.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/certificates/peer/{v7CertificatesPeerId}": { + "delete": { + "description": "Delete a trusted SyncIQ TLS certificate.", + "operationId": "deleteSyncv7CertificatesPeerById", + "parameters": [ + { + "description": "Delete a trusted SyncIQ TLS certificate.", + "in": "path", + "name": "v7CertificatesPeerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "Retrieve a single trusted SyncIQ TLS certificate.", + "operationId": "getSyncv7CertificatesPeerById", + "parameters": [ + { + "description": "Retrieve a single trusted SyncIQ TLS certificate.", + "in": "path", + "name": "v7CertificatesPeerId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a single trusted SyncIQ TLS certificate.", + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a trusted SyncIQ TLS certificate.", + "operationId": "updateSyncv7CertificatesPeerById", + "parameters": [ + { + "in": "body", + "name": "v7CertificatesPeerIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityIdParams" + } + }, + { + "description": "Modify a trusted SyncIQ TLS certificate.", + "in": "path", + "name": "v7CertificatesPeerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/certificates/server": { + "get": { + "description": "Retrieve a list of all SyncIQ TLS server certificates.", + "operationId": "listSyncv7CertificatesServer", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a list of all SyncIQ TLS server certificates.", + "schema": { + "$ref": "#/definitions/v7CertificatesServer" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Import a SyncIQ TLS server certificate.", + "operationId": "createSyncv7CertificatesServerItem", + "parameters": [ + { + "in": "body", + "name": "v7CertificatesServerItem", + "required": true, + "schema": { + "$ref": "#/definitions/v4CertificateServerItem" + } + } + ], + "responses": { + "200": { + "description": "Import a SyncIQ TLS server certificate.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/certificates/server/{v7CertificatesServerId}": { + "delete": { + "description": "Delete a SyncIQ TLS server certificate.", + "operationId": "deleteSyncv7CertificatesServerById", + "parameters": [ + { + "description": "Delete a SyncIQ TLS server certificate.", + "in": "path", + "name": "v7CertificatesServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "Retrieve a SyncIQ TLS server certificate.", + "operationId": "getSyncv7CertificatesServerById", + "parameters": [ + { + "description": "Retrieve a SyncIQ TLS server certificate.", + "in": "path", + "name": "v7CertificatesServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve a SyncIQ TLS server certificate.", + "schema": { + "$ref": "#/definitions/v4CertificateServerExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a SyncIQ TLS server certificate.", + "operationId": "updateSyncv7CertificatesServerById", + "parameters": [ + { + "in": "body", + "name": "v7CertificatesServerIdParams", + "required": true, + "schema": { + "$ref": "#/definitions/v7CertificateAuthorityIdParams" + } + }, + { + "description": "Modify a SyncIQ TLS server certificate.", + "in": "path", + "name": "v7CertificatesServerId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/history/network": { + "get": { + "description": "List network operations performance data.", + "operationId": "getSyncv7HistoryNetwork", + "parameters": [ + { + "description": "Receive network history for all currently running SyncIQ jobs.", + "in": "query", + "name": "running_jobs", + "type": "boolean" + }, + { + "description": "End timestamp for time-series report.", + "in": "query", + "name": "end", + "type": "integer" + }, + { + "description": "Begin timestamp for time-series report.", + "in": "query", + "name": "start", + "type": "integer" + }, + { + "description": "Receive network history for only the given policy.", + "in": "query", + "name": "policy_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List network operations performance data.", + "schema": { + "$ref": "#/definitions/v7HistoryNetwork" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/jobs": { + "delete": { + "description": "Cancel all SyncIQ jobs.", + "operationId": "deleteSyncv7SyncJobs", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "Get a list of SyncIQ jobs.", + "operationId": "listSyncv7SyncJobs", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The state of the job.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ jobs.", + "schema": { + "$ref": "#/definitions/v7SyncJobs" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Start a SyncIQ job.", + "operationId": "createSyncv7SyncJob", + "parameters": [ + { + "in": "body", + "name": "v7SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v15SyncJob" + } + } + ], + "responses": { + "200": { + "description": "Start a SyncIQ job.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/jobs/{v7SyncJobId}": { + "get": { + "description": "View a single SyncIQ job.", + "operationId": "getSyncv7SyncJob", + "parameters": [ + { + "description": "View a single SyncIQ job.", + "in": "path", + "name": "v7SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ job.", + "schema": { + "$ref": "#/definitions/v7SyncJobsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "operationId": "updateSyncv7SyncJob", + "parameters": [ + { + "in": "body", + "name": "v7SyncJob", + "required": true, + "schema": { + "$ref": "#/definitions/v1SyncJobExtendedExtended" + } + }, + { + "description": "Perform an action (pause, cancel, etc...) on a single job.", + "in": "path", + "name": "v7SyncJobId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/policies": { + "delete": { + "description": "Delete all SyncIQ policies.", + "operationId": "deleteSyncv7SyncPolicies", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "List all SyncIQ policies.", + "operationId": "listSyncv7SyncPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return a summary rather than entire objects.", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ policies.", + "schema": { + "$ref": "#/definitions/v7SyncPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Create a SyncIQ policy.", + "operationId": "createSyncv7SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v7SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v7SyncPolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a SyncIQ policy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/policies/{v7SyncPolicyId}": { + "delete": { + "description": "Delete a single SyncIQ policy.", + "operationId": "deleteSyncv7SyncPolicy", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a single SyncIQ policy.", + "in": "path", + "name": "v7SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ policy.", + "operationId": "getSyncv7SyncPolicy", + "parameters": [ + { + "description": "View a single SyncIQ policy.", + "in": "path", + "name": "v7SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ policy.", + "schema": { + "$ref": "#/definitions/v7SyncPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a single SyncIQ policy.", + "operationId": "updateSyncv7SyncPolicy", + "parameters": [ + { + "in": "body", + "name": "v7SyncPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v7SyncPolicyExtendedExtended" + } + }, + { + "description": "Modify a single SyncIQ policy.", + "in": "path", + "name": "v7SyncPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/reports": { + "get": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv7SyncReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "Return a summary rather than entire objects", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v7SyncReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ subreports for a report.", + "operationId": "getSyncReportsv7ReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ subreports for a report.", + "schema": { + "$ref": "#/definitions/v7ReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncReports" + ] + } + }, + "/platform/7/sync/reports/{Rid}/subreports/{v7ReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ subreport.", + "operationId": "getSyncv7ReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ subreport.", + "in": "path", + "name": "v7ReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ subreport.", + "schema": { + "$ref": "#/definitions/v7ReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/reports/{v7SyncReportId}": { + "get": { + "description": "View a single SyncIQ report.", + "operationId": "getSyncv7SyncReport", + "parameters": [ + { + "description": "View a single SyncIQ report.", + "in": "path", + "name": "v7SyncReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ report.", + "schema": { + "$ref": "#/definitions/v7SyncReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/service/policies": { + "delete": { + "description": "Delete all SyncIQ service replication policies.", + "operationId": "deleteSyncv7ServicePolicies", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "List all SyncIQ service replication policies.", + "operationId": "listSyncv7ServicePolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return a summary rather than entire objects.", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified as \"effective\" or not specified, all fields are returned. If specified as \"user\", only fields with non-default values are shown. If specified as \"default\", the original values are returned.", + "enum": [ + "user", + "default", + "effective" + ], + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "scope", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ service replication policies.", + "schema": { + "$ref": "#/definitions/v7ServicePolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "post": { + "description": "Create a SyncIQ service replication policy.", + "operationId": "createSyncv7ServicePolicy", + "parameters": [ + { + "in": "body", + "name": "v7ServicePolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v7ServicePolicy" + } + } + ], + "responses": { + "200": { + "description": "Create a SyncIQ service replication policy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/service/policies/{Policy}/reset": { + "post": { + "description": "Reset a SyncIQ service replication policy incremental state and force a full sync/copy.", + "operationId": "createSyncServicev7PoliciesPolicyResetItem", + "parameters": [ + { + "in": "body", + "name": "v7PoliciesPolicyResetItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Policy", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Reset a SyncIQ service replication policy incremental state and force a full sync/copy.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncService" + ] + } + }, + "/platform/7/sync/service/policies/{v7ServicePolicyId}": { + "delete": { + "description": "Delete a single SyncIQ service replication policy.", + "operationId": "deleteSyncv7ServicePolicy", + "parameters": [ + { + "description": "Skip deleting the policy association on the target.", + "in": "query", + "name": "local_only", + "type": "boolean" + }, + { + "description": "Ignore any running jobs when preparing to delete a policy.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Delete a single SyncIQ service replication policy.", + "in": "path", + "name": "v7ServicePolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ service replication policy.", + "operationId": "getSyncv7ServicePolicy", + "parameters": [ + { + "description": "View a single SyncIQ service replication policy.", + "in": "path", + "name": "v7ServicePolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ service replication policy.", + "schema": { + "$ref": "#/definitions/v7ServicePoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify a single SyncIQ service replication policy.", + "operationId": "updateSyncv7ServicePolicy", + "parameters": [ + { + "in": "body", + "name": "v7ServicePolicy", + "required": true, + "schema": { + "$ref": "#/definitions/v7ServicePolicyExtendedExtended" + } + }, + { + "description": "Modify a single SyncIQ service replication policy.", + "in": "path", + "name": "v7ServicePolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/service/target/policies": { + "get": { + "description": "List all SyncIQ target service replication policies.", + "operationId": "getSyncv7ServiceTargetPolicies", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Filter the returned policies to include only those with this target path.", + "in": "query", + "name": "target_path", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all SyncIQ target service replication policies.", + "schema": { + "$ref": "#/definitions/v7ServiceTargetPolicies" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/service/target/policies/{Policy}/cancel": { + "post": { + "description": "Cancel the most recent SyncIQ job for this service replication policy from the target side.", + "operationId": "createSyncServiceTargetv7PoliciesPolicyCancelItem", + "parameters": [ + { + "in": "body", + "name": "v7PoliciesPolicyCancelItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + }, + { + "in": "path", + "name": "Policy", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Cancel the most recent SyncIQ job for this service replication policy from the target side.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncServiceTarget" + ] + } + }, + "/platform/7/sync/service/target/policies/{v7ServiceTargetPolicyId}": { + "delete": { + "description": "Break the target association with this cluster for this policy.", + "operationId": "deleteSyncv7ServiceTargetPolicy", + "parameters": [ + { + "description": "Ignore any running jobs when preparing to delete the policy target association.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "description": "Break the target association with this cluster for this policy.", + "in": "path", + "name": "v7ServiceTargetPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "get": { + "description": "View a single SyncIQ target service replication policy.", + "operationId": "getSyncv7ServiceTargetPolicy", + "parameters": [ + { + "description": "View a single SyncIQ target service replication policy.", + "in": "path", + "name": "v7ServiceTargetPolicyId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target service replication policy.", + "schema": { + "$ref": "#/definitions/v7ServiceTargetPoliciesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/settings": { + "get": { + "description": "Retrieve the global SyncIQ settings.", + "operationId": "getSyncv7SyncSettings", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve the global SyncIQ settings.", + "schema": { + "$ref": "#/definitions/v7SyncSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + }, + "put": { + "description": "Modify the global SyncIQ settings. All input fields are optional, but one or more must be supplied.", + "operationId": "updateSyncv7SyncSettings", + "parameters": [ + { + "in": "body", + "name": "v7SyncSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v7SyncSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/target/reports": { + "get": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "operationId": "getSyncv7TargetReports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those with this policy name.", + "in": "query", + "name": "policy_name", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 1. ", + "in": "query", + "name": "reports_per_policy", + "type": "integer" + }, + { + "description": "Return a summary rather than entire objects.", + "in": "query", + "name": "summary", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target reports. By default 1 report is returned per policy, unless otherwise specified by 'reports_per_policy'.", + "schema": { + "$ref": "#/definitions/v7TargetReports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/target/reports/{Rid}/subreports": { + "get": { + "description": "Get a list of SyncIQ target subreports for a report.", + "operationId": "getSyncTargetv7ReportsReportSubreports", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.", + "in": "query", + "name": "newer_than", + "type": "integer" + }, + { + "description": "Filter the returned reports to include only those whose jobs are in this state.", + "enum": [ + "scheduled", + "running", + "paused", + "finished", + "failed", + "canceled", + "needs_attention", + "skipped", + "pending", + "unknown" + ], + "in": "query", + "name": "state", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a list of SyncIQ target subreports for a report.", + "schema": { + "$ref": "#/definitions/v7ReportsReportSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SyncTarget" + ] + } + }, + "/platform/7/sync/target/reports/{Rid}/subreports/{v7TargetReportsRidSubreportId}": { + "get": { + "description": "View a single SyncIQ target subreport.", + "operationId": "getSyncv7TargetReportsRidSubreport", + "parameters": [ + { + "description": "View a single SyncIQ target subreport.", + "in": "path", + "name": "v7TargetReportsRidSubreportId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Rid", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target subreport.", + "schema": { + "$ref": "#/definitions/v7TargetReportsRidSubreports" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/sync/target/reports/{v7TargetReportId}": { + "get": { + "description": "View a single SyncIQ target report.", + "operationId": "getSyncv7TargetReport", + "parameters": [ + { + "description": "View a single SyncIQ target report.", + "in": "path", + "name": "v7TargetReportId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single SyncIQ target report.", + "schema": { + "$ref": "#/definitions/v7TargetReportsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Sync" + ] + } + }, + "/platform/7/upgrade/cluster": { + "get": { + "description": "Cluster wide upgrade status info.", + "operationId": "getUpgradev7UpgradeCluster", + "parameters": [], + "responses": { + "200": { + "description": "Cluster wide upgrade status info.", + "schema": { + "$ref": "#/definitions/v7UpgradeCluster" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/7/upgrade/cluster/patch/patches": { + "get": { + "description": "List all patches.", + "operationId": "listUpgradev7ClusterPatchPatches", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Path location of patch file.", + "in": "query", + "maxLength": 4096, + "minLength": 0, + "name": "location", + "type": "string" + }, + { + "description": "View patches on the local node only.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all patches.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatches" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "post": { + "description": "Install a patch.", + "operationId": "createUpgradev7ClusterPatchPatch", + "parameters": [ + { + "description": "Bypass version checks. Defaults to false.", + "in": "query", + "name": "skip_version_check", + "type": "boolean" + }, + { + "description": "Bypass conflict checks. Defaults to false.", + "in": "query", + "name": "skip_conflict_check", + "type": "boolean" + }, + { + "description": "Bypass restricted checks. Defaults to false.", + "in": "query", + "name": "skip_restricted_check", + "type": "boolean" + }, + { + "description": "Install the patch on all nodes at once. Defaults to false.", + "in": "query", + "name": "simultaneous", + "type": "boolean" + }, + { + "description": "Install the patch on one node at a time. Defaults to true.", + "in": "query", + "name": "rolling", + "type": "boolean" + }, + { + "description": "Bypass dependency checks. Defaults to false.", + "in": "query", + "name": "skip_dependency_check", + "type": "boolean" + }, + { + "in": "body", + "name": "v7ClusterPatchPatch", + "required": true, + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatch" + } + } + ], + "responses": { + "200": { + "description": "Install a patch.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/7/upgrade/cluster/patch/patches/{v7ClusterPatchPatchId}": { + "delete": { + "description": "Uninstall a patch.", + "operationId": "deleteUpgradev7ClusterPatchPatch", + "parameters": [ + { + "description": "Bypass version checks. Defaults to false.", + "in": "query", + "name": "skip_version_check", + "type": "boolean" + }, + { + "description": "Bypass conflict checks. Defaults to false.", + "in": "query", + "name": "skip_conflict_check", + "type": "boolean" + }, + { + "description": "Bypass restricted checks. Defaults to false.", + "in": "query", + "name": "skip_restricted_check", + "type": "boolean" + }, + { + "description": "Uninstall the patch on all nodes at once. Defaults to false.", + "in": "query", + "name": "simultaneous", + "type": "boolean" + }, + { + "description": "Install the patch on one node at a time. Defaults to true.", + "in": "query", + "name": "rolling", + "type": "boolean" + }, + { + "description": "Bypass dependency checks. Defaults to false.", + "in": "query", + "name": "skip_dependency_check", + "type": "boolean" + }, + { + "description": "Uninstall a patch.", + "in": "path", + "name": "v7ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "get": { + "description": "View a single patch.", + "operationId": "getUpgradev7ClusterPatchPatch", + "parameters": [ + { + "description": "View patch information on local node only.", + "in": "query", + "name": "local", + "type": "boolean" + }, + { + "description": "Path location of patch file.", + "in": "query", + "maxLength": 4096, + "minLength": 0, + "name": "location", + "type": "string" + }, + { + "description": "View a single patch.", + "in": "path", + "name": "v7ClusterPatchPatchId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single patch.", + "schema": { + "$ref": "#/definitions/v11ClusterPatchPatchesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/7/upgrade/cluster/pause": { + "post": { + "description": "Pause a running upgrade process.", + "operationId": "createUpgradev7ClusterPauseItem", + "parameters": [ + { + "in": "body", + "name": "v7ClusterPauseItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Pause a running upgrade process.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/7/upgrade/cluster/resume": { + "post": { + "description": "Resume a paused upgrade process.", + "operationId": "createUpgradev7ClusterResumeItem", + "parameters": [ + { + "in": "body", + "name": "v7ClusterResumeItem", + "required": true, + "schema": { + "$ref": "#/definitions/Empty" + } + } + ], + "responses": { + "200": { + "description": "Resume a paused upgrade process.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/7/upgrade/cluster/upgrade": { + "post": { + "description": "The settings necessary to start an upgrade.", + "operationId": "createUpgradev7ClusterUpgradeItem", + "parameters": [ + { + "in": "body", + "name": "v7ClusterUpgradeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v7ClusterUpgradeItem" + } + } + ], + "responses": { + "200": { + "description": "The settings necessary to start an upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "put": { + "description": "Add nodes to a running upgrade.", + "operationId": "updateUpgradev7ClusterUpgrade", + "parameters": [ + { + "in": "body", + "name": "v7ClusterUpgrade", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterUpgrade" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/7/worm/domains": { + "get": { + "description": "List all WORM domains.", + "operationId": "listWormv7WormDomains", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all WORM domains.", + "schema": { + "$ref": "#/definitions/v7WormDomains" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + }, + "post": { + "description": "Create a WORM domain.", + "operationId": "createWormv7WormDomain", + "parameters": [ + { + "in": "body", + "name": "v7WormDomain", + "required": true, + "schema": { + "$ref": "#/definitions/v7WormDomain" + } + } + ], + "responses": { + "200": { + "description": "Create a WORM domain.", + "schema": { + "$ref": "#/definitions/Createv7WormDomainResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + } + }, + "/platform/7/worm/domains/{v7WormDomainId}": { + "get": { + "description": "View a single WORM domain.", + "operationId": "getWormv7WormDomain", + "parameters": [ + { + "description": "View a single WORM domain.", + "in": "path", + "name": "v7WormDomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single WORM domain.", + "schema": { + "$ref": "#/definitions/v7WormDomainsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + }, + "put": { + "description": "Modify a single WORM domain.", + "operationId": "updateWormv7WormDomain", + "parameters": [ + { + "in": "body", + "name": "v7WormDomain", + "required": true, + "schema": { + "$ref": "#/definitions/v7WormDomainExtended" + } + }, + { + "description": "Modify a single WORM domain.", + "in": "path", + "name": "v7WormDomainId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Worm" + ] + } + }, + "/platform/8/auth/roles/{Role}/members": { + "get": { + "description": "List all the members of the role.", + "operationId": "listAuthRolesv8RoleMembers", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "Resolve names of personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the members of the role.", + "schema": { + "$ref": "#/definitions/v8RoleMembers" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + }, + "post": { + "description": "Add a member to the role.", + "operationId": "createAuthRolesv8RoleMember", + "parameters": [ + { + "description": "Specifies which access zone to use.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v8RoleMember", + "required": true, + "schema": { + "$ref": "#/definitions/v1AuthAccessAccessItemFileGroup" + } + }, + { + "in": "path", + "name": "Role", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Add a member to the role.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "AuthRoles" + ] + } + }, + "/platform/8/fsa/index": { + "get": { + "description": "Retrieve all the FSA index table names available on an PowerScale cluster.", + "operationId": "getFsav8FsaIndex", + "parameters": [], + "responses": { + "200": { + "description": "Retrieve all the FSA index table names available on an PowerScale cluster.", + "schema": { + "$ref": "#/definitions/v8FsaIndex" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/8/fsa/index/{Name}/lins": { + "get": { + "description": "Get index entries from the given index table.", + "operationId": "getFsaIndexv8NameLins", + "parameters": [ + { + "description": "Resolve the path for an index entry. This query argument is invalid if an initial index job is in progress or incomplete or if an incremental index job is in progress or incomplete.", + "in": "query", + "name": "path", + "required": false, + "type": "boolean" + }, + { + "description": "LIN of file or directory to lookup. Accepts multiple query arguments.", + "in": "query", + "items": { + "maximum": 2147483646, + "minimum": 0, + "type": "integer" + }, + "name": "lin", + "required": false, + "type": "array" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 100000, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get index entries from the given index table.", + "schema": { + "$ref": "#/definitions/v8NameLins" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FsaIndex" + ] + } + }, + "/platform/8/fsa/index/{Name}/lins/{v8IndexNameLinId}": { + "get": { + "description": "Get a single index entry from the index table.", + "operationId": "getFsav8IndexNameLin", + "parameters": [ + { + "description": "Resolve the path for an index entry. This query argument is invalid if an initial index job is in progress or incomplete or if an incremental index job is in progress or incomplete.", + "in": "query", + "name": "path", + "required": false, + "type": "boolean" + }, + { + "description": "Get a single index entry from the index table.", + "in": "path", + "name": "v8IndexNameLinId", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a single index entry from the index table.", + "schema": { + "$ref": "#/definitions/v8IndexNameLins" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/8/protocols/ssh/settings": { + "get": { + "description": "ssh settings", + "operationId": "getProtocolsv8SshSettings", + "parameters": [], + "responses": { + "200": { + "description": "ssh settings", + "schema": { + "$ref": "#/definitions/v8SshSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "ssh settings", + "operationId": "updateProtocolsv8SshSettings", + "parameters": [ + { + "in": "body", + "name": "v8SshSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v8SshSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/8/quota/quotas": { + "delete": { + "description": "Delete all or matching quotas.", + "operationId": "deleteQuotav8QuotaQuotas", + "parameters": [ + { + "description": "Only delete quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only delete quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If used with the path argument, delete all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only delete user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Only delete quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only delete quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "operationId": "listQuotav8QuotaQuotas", + "parameters": [ + { + "description": "Only list quotas with this enforcement (non-accounting).", + "in": "query", + "name": "enforced", + "type": "boolean" + }, + { + "description": "Only list quotas with this setting for include_snapshots.", + "in": "query", + "name": "include_snapshots", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "description": "If used with the path argument, match all quotas at that path or any descendent sub-directory.", + "in": "query", + "name": "recurse_path_children", + "type": "boolean" + }, + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "If used with the path argument, match all quotas at that path or any parent directory.", + "in": "query", + "name": "recurse_path_parents", + "type": "boolean" + }, + { + "description": "Only list user or group quotas matching this persona (must be used with the corresponding type argument). Format is :, where PERSONA_TYPE is one of USER, GROUP, SID, ID, or GID.", + "in": "query", + "name": "persona", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Set to true to only list quotas which have exceeded one or more of their thresholds.", + "in": "query", + "name": "exceeded", + "type": "boolean" + }, + { + "description": "Only list quotas matching this path (see also recurse_path_*).", + "in": "query", + "name": "path", + "type": "string" + }, + { + "description": "Only list quotas matching this type.", + "enum": [ + "directory", + "user", + "group", + "default-directory", + "default-user", + "default-group" + ], + "in": "query", + "name": "type", + "type": "string" + }, + { + "description": "Use the named report as a source rather than the live quotas. See the /q/quota/reports resource for a list of valid reports.", + "in": "query", + "name": "report_id", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all or matching quotas. Can also be used to retrieve quota state from existing reports. For any query argument not supplied, the default behavior is return all.", + "schema": { + "$ref": "#/definitions/v8QuotaQuotas" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "post": { + "description": "Create a new quota.", + "operationId": "createQuotav8QuotaQuota", + "parameters": [ + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v8QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v12QuotaQuota" + } + } + ], + "responses": { + "200": { + "description": "Create a new quota.", + "schema": { + "$ref": "#/definitions/CreateResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/8/quota/quotas/{v8QuotaQuotaId}": { + "delete": { + "description": "Delete the quota.", + "operationId": "deleteQuotav8QuotaQuota", + "parameters": [ + { + "description": "Delete the quota.", + "in": "path", + "name": "v8QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "get": { + "description": "Retrieve quota information.", + "operationId": "getQuotav8QuotaQuota", + "parameters": [ + { + "description": "If true, resolve group and user names in personas.", + "in": "query", + "name": "resolve_names", + "type": "boolean" + }, + { + "description": "Optional named zone to use for user and group resolution.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "zone", + "type": "string" + }, + { + "description": "Retrieve quota information.", + "in": "path", + "name": "v8QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve quota information.", + "schema": { + "$ref": "#/definitions/v8QuotaQuotasExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + }, + "put": { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "operationId": "updateQuotav8QuotaQuota", + "parameters": [ + { + "in": "body", + "name": "v8QuotaQuota", + "required": true, + "schema": { + "$ref": "#/definitions/v12QuotaQuotaExtendedExtended" + } + }, + { + "description": "Modify quota. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v8QuotaQuotaId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Quota" + ] + } + }, + "/platform/8/snapshot/changelists/{Changelist}/entries": { + "get": { + "description": "Get entries from a changelist.", + "operationId": "getSnapshotChangelistsv8ChangelistEntries", + "parameters": [ + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2048, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Changelist", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get entries from a changelist.", + "schema": { + "$ref": "#/definitions/v8ChangelistEntries" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "SnapshotChangelists" + ] + } + }, + "/platform/8/snapshot/changelists/{Changelist}/entries/{v8ChangelistsChangelistEntryId}": { + "get": { + "description": "Get a single entry from the changelist.", + "operationId": "getSnapshotv8ChangelistsChangelistEntry", + "parameters": [ + { + "description": "Get a single entry from the changelist.", + "in": "path", + "name": "v8ChangelistsChangelistEntryId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Changelist", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Get a single entry from the changelist.", + "schema": { + "$ref": "#/definitions/v8ChangelistsChangelistEntries" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Snapshot" + ] + } + }, + "/platform/9/auth/providers/summary": { + "get": { + "description": "Retrieve the summary information.", + "operationId": "getAuthv9ProvidersSummary", + "parameters": [ + { + "description": "Filter providers by groupnet.", + "in": "query", + "name": "groupnet", + "type": "string" + }, + { + "description": "Filter providers by zone.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the summary information.", + "schema": { + "$ref": "#/definitions/v11ProvidersSummary" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Auth" + ] + } + }, + "/platform/9/event/eventgroup-definitions": { + "get": { + "description": "List all eventgroup definitions.", + "operationId": "getEventv9EventEventgroupDefinitions", + "parameters": [ + { + "description": "Return eventgroups in the specified category", + "in": "query", + "name": "category", + "type": "integer" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all eventgroup definitions.", + "schema": { + "$ref": "#/definitions/v9EventEventgroupDefinitions" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/9/event/eventgroup-definitions/{v9EventEventgroupDefinitionId}": { + "get": { + "description": "Retrieve the eventgroup definition.", + "operationId": "getEventv9EventEventgroupDefinition", + "parameters": [ + { + "description": "Retrieve the eventgroup definition.", + "in": "path", + "name": "v9EventEventgroupDefinitionId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the eventgroup definition.", + "schema": { + "$ref": "#/definitions/v9EventEventgroupDefinitionsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Event" + ] + } + }, + "/platform/9/fsa/results/{Id}/dir_pools_usage": { + "get": { + "description": " View pool usage information of a directory, classified by storage pools in response \"usage_data\". The storage pool type can be specified by query parameter \"storage_pool_type\". The directory is \"path\" query parameter. The response \"dir_usage\" is total disk usage of directory, over all pools at a given storage pool level. When path cannot be found within result, status code 404 and error message will be returned.", + "operationId": "getFsaResultsv9ResultDirPoolsUsage", + "parameters": [ + { + "description": " Directory absolute path to report usage information. Path should be UTF8 percent encoded, should be within \"/ifs\". Defaults to \"/ifs\".", + "in": "query", + "maxLength": 4096, + "minLength": 4, + "name": "path", + "pattern": "^/ifs$|^/ifs/", + "type": "string" + }, + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "The type of the storage pool.", + "enum": [ + "node_pool" + ], + "in": "query", + "name": "storage_pool_type", + "type": "string" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": " View pool usage information of a directory, classified by storage pools in response \"usage_data\". The storage pool type can be specified by query parameter \"storage_pool_type\". The directory is \"path\" query parameter. The response \"dir_usage\" is total disk usage of directory, over all pools at a given storage pool level. When path cannot be found within result, status code 404 and error message will be returned.", + "schema": { + "$ref": "#/definitions/v9ResultDirPoolsUsage" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "FsaResults" + ] + } + }, + "/platform/9/fsa/results/{Id}/dir_pools_usage/{v9ResultsIdDirPoolsUsageLin}": { + "get": { + "description": " View pool usage information of a directory, classified by storage pools in response \"usage_data\". The storage pool type can be specified by query parameter \"storage_pool_type\". The directory is LIN token of URI. The response \"dir_usage\" is total disk usage of directory, over all pools at a given storage pool level. When LIN cannot be found within result, status code 404 and error message will be returned.", + "operationId": "getFsav9ResultsIdDirPoolsUsageLin", + "parameters": [ + { + "description": "Result set identifier for comparison of database results.", + "in": "query", + "name": "comp_report", + "type": "integer" + }, + { + "description": "The type of the storage pool.", + "enum": [ + "node_pool" + ], + "in": "query", + "name": "storage_pool_type", + "type": "string" + }, + { + "description": " View pool usage information of a directory, classified by storage pools in response \"usage_data\". The storage pool type can be specified by query parameter \"storage_pool_type\". The directory is LIN token of URI. The response \"dir_usage\" is total disk usage of directory, over all pools at a given storage pool level. When LIN cannot be found within result, status code 404 and error message will be returned.", + "in": "path", + "name": "v9ResultsIdDirPoolsUsageLin", + "required": true, + "type": "integer" + }, + { + "in": "path", + "name": "Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": " View pool usage information of a directory, classified by storage pools in response \"usage_data\". The storage pool type can be specified by query parameter \"storage_pool_type\". The directory is LIN token of URI. The response \"dir_usage\" is total disk usage of directory, over all pools at a given storage pool level. When LIN cannot be found within result, status code 404 and error message will be returned.", + "schema": { + "$ref": "#/definitions/v9ResultDirPoolsUsage" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Fsa" + ] + } + }, + "/platform/9/performance/datasets": { + "get": { + "description": "List all datasets.", + "operationId": "listPerformancev9PerformanceDatasets", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all datasets.", + "schema": { + "$ref": "#/definitions/v10PerformanceDatasets" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "post": { + "description": "Create a new dataset.", + "operationId": "createPerformancev9PerformanceDataset", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v9PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceDataset" + } + } + ], + "responses": { + "200": { + "description": "Create a new dataset.", + "schema": { + "$ref": "#/definitions/Createv10PerformanceDatasetResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/9/performance/datasets/{Dataset}/filters": { + "delete": { + "description": "Delete all filters associated with the dataset.", + "operationId": "deletePerformanceDatasetsv9DatasetFilters", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all filters.", + "operationId": "listPerformanceDatasetsv9DatasetFilters", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all filters.", + "schema": { + "$ref": "#/definitions/v9DatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new filter.", + "operationId": "createPerformanceDatasetsv9DatasetFilter", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v9DatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v9DatasetFilter" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new filter.", + "schema": { + "$ref": "#/definitions/Createv10DatasetFilterResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/9/performance/datasets/{Dataset}/filters/{v9DatasetsDatasetFilterId}": { + "delete": { + "description": "Delete the filter.", + "operationId": "deletePerformancev9DatasetsDatasetFilter", + "parameters": [ + { + "description": "Delete the filter.", + "in": "path", + "name": "v9DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the filter.", + "operationId": "getPerformancev9DatasetsDatasetFilter", + "parameters": [ + { + "description": "Retrieve the filter.", + "in": "path", + "name": "v9DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the filter.", + "schema": { + "$ref": "#/definitions/v9DatasetsDatasetFilters" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the filter.", + "operationId": "updatePerformancev9DatasetsDatasetFilter", + "parameters": [ + { + "in": "body", + "name": "v9DatasetsDatasetFilter", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetFilter" + } + }, + { + "description": "Modify the filter.", + "in": "path", + "name": "v9DatasetsDatasetFilterId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/9/performance/datasets/{Dataset}/workloads": { + "delete": { + "description": "Delete all workloads associated with the dataset.", + "operationId": "deletePerformanceDatasetsv9DatasetWorkloads", + "parameters": [ + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "get": { + "description": "List all workloads.", + "operationId": "listPerformanceDatasetsv9DatasetWorkloads", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "Return no more than this many results at once (see resume).", + "in": "query", + "maximum": 2147483646, + "minimum": 1, + "name": "limit", + "type": "integer" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + }, + { + "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).", + "in": "query", + "maxLength": 8192, + "minLength": 0, + "name": "resume", + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all workloads.", + "schema": { + "$ref": "#/definitions/v9DatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + }, + "post": { + "description": "Create a new workload.", + "operationId": "createPerformanceDatasetsv9DatasetWorkload", + "parameters": [ + { + "description": "For use by support only.", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v9DatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v9DatasetWorkload" + } + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Create a new workload.", + "schema": { + "$ref": "#/definitions/Createv10DatasetWorkloadResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "PerformanceDatasets" + ] + } + }, + "/platform/9/performance/datasets/{Dataset}/workloads/{v9DatasetsDatasetWorkloadId}": { + "delete": { + "description": "Delete the workload.", + "operationId": "deletePerformancev9DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Delete the workload.", + "in": "path", + "name": "v9DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the workload.", + "operationId": "getPerformancev9DatasetsDatasetWorkload", + "parameters": [ + { + "description": "Retrieve the workload.", + "in": "path", + "name": "v9DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the workload.", + "schema": { + "$ref": "#/definitions/v9DatasetsDatasetWorkloads" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the workload.", + "operationId": "updatePerformancev9DatasetsDatasetWorkload", + "parameters": [ + { + "in": "body", + "name": "v9DatasetsDatasetWorkload", + "required": true, + "schema": { + "$ref": "#/definitions/v10DatasetsDatasetWorkload" + } + }, + { + "description": "Modify the workload.", + "in": "path", + "name": "v9DatasetsDatasetWorkloadId", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "Dataset", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/9/performance/datasets/{v9PerformanceDatasetId}": { + "delete": { + "description": "Delete the performance dataset.", + "operationId": "deletePerformancev9PerformanceDataset", + "parameters": [ + { + "description": "Delete the performance dataset.", + "in": "path", + "name": "v9PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "get": { + "description": "Retrieve the performance dataset.", + "operationId": "getPerformancev9PerformanceDataset", + "parameters": [ + { + "description": "Retrieve the performance dataset.", + "in": "path", + "name": "v9PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve the performance dataset.", + "schema": { + "$ref": "#/definitions/v10PerformanceDatasetsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Modify the name of the performance dataset.", + "operationId": "updatePerformancev9PerformanceDataset", + "parameters": [ + { + "in": "body", + "name": "v9PerformanceDataset", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceDatasetExtendedExtended" + } + }, + { + "description": "Modify the name of the performance dataset.", + "in": "path", + "name": "v9PerformanceDatasetId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/9/performance/metrics": { + "get": { + "description": "List all metrics.", + "operationId": "getPerformancev9PerformanceMetrics", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all metrics.", + "schema": { + "$ref": "#/definitions/v10PerformanceMetrics" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/9/performance/metrics/{v9PerformanceMetricId}": { + "get": { + "description": "View a single performance metric.", + "operationId": "getPerformancev9PerformanceMetric", + "parameters": [ + { + "description": "View a single performance metric.", + "in": "path", + "name": "v9PerformanceMetricId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "View a single performance metric.", + "schema": { + "$ref": "#/definitions/v10PerformanceMetricsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/9/performance/settings": { + "get": { + "description": "List all performance settings.", + "operationId": "getPerformancev9PerformanceSettings", + "parameters": [], + "responses": { + "200": { + "description": "List all performance settings.", + "schema": { + "$ref": "#/definitions/v10PerformanceSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + }, + "put": { + "description": "Configure performance settings.", + "operationId": "updatePerformancev9PerformanceSettings", + "parameters": [ + { + "description": "Allow modification of settings outside of recommended limits", + "in": "query", + "name": "force", + "type": "boolean" + }, + { + "in": "body", + "name": "v9PerformanceSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v10PerformanceSettingsExtended" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Performance" + ] + } + }, + "/platform/9/protocols/hdfs/settings": { + "get": { + "description": "Retrieve HDFS properties.", + "operationId": "getProtocolsv9HdfsSettings", + "parameters": [ + { + "description": "Access zone which contains HDFS settings.", + "in": "query", + "name": "zone", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve HDFS properties.", + "schema": { + "$ref": "#/definitions/v9HdfsSettings" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + }, + "put": { + "description": "Modify HDFS properties.", + "operationId": "updateProtocolsv9HdfsSettings", + "parameters": [ + { + "description": "Access zone which contains HDFS settings.", + "in": "query", + "name": "zone", + "type": "string" + }, + { + "in": "body", + "name": "v9HdfsSettings", + "required": true, + "schema": { + "$ref": "#/definitions/v9HdfsSettingsSettings" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Protocols" + ] + } + }, + "/platform/9/statistics/summary/workload": { + "get": { + "description": "Description for Statistics9 v9Summary Workload", + "operationId": "getStatisticsv9SummaryWorkload", + "parameters": [ + { + "description": "A comma separated list. Only report statistics for groups specified by Group Security IDs, if configured. ", + "in": "query", + "name": "group_sids", + "type": "string" + }, + { + "description": "Do not resolve addresses and usernames to their human readable form(s). Default is false. ", + "in": "query", + "name": "numeric", + "type": "boolean" + }, + { + "description": "A comma separated list. Only report statistics for exports specified by id, if configured. ", + "in": "query", + "name": "export_ids", + "type": "string" + }, + { + "description": "Continue to report if some nodes do not respond.", + "in": "query", + "name": "degraded", + "type": "boolean" + }, + { + "description": "A comma separated list. Only report statistics for remote clients specified by resolved names, if configured. ", + "in": "query", + "name": "remote_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for shares specified by name, if configured. ", + "in": "query", + "name": "share_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for paths specified by name, if configured. ", + "in": "query", + "name": "paths", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by resolved names, if configured. ", + "in": "query", + "name": "usernames", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for remote clients specified by IP addresses, if configured. ", + "in": "query", + "name": "remote_addresses", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for job(s) specified by type, if configured. ", + "in": "query", + "items": { + "type": "string" + }, + "name": "job_types", + "type": "array" + }, + { + "description": "A comma separated list. Only report statistics for users in zone specified by id, if configured. ", + "in": "query", + "name": "zone_ids", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for groups specified by resolved names, if configured. ", + "in": "query", + "name": "groupnames", + "type": "string" + }, + { + "description": "A comma separated list. Specify node(s) for which statistics should be reported. Default is all. Zero (0) should be passed in as the sole argument to indicate local.", + "in": "query", + "name": "nodes", + "type": "string" + }, + { + "description": "Sort data by the specified comma-separated field(s). ( node | workload_id | system_name | user_id | user_sid | username | group_id | group_sid | groupname | domain_id | path | zone_id | zone_name | export_id | local_addr | local_name | remote_addr | remote_name | protocol | share_name | job_type | cpu | bytes_in | bytes_out | ops | reads | writes | l2 | l3 | latency_read | latency_write | latency_other | error). Prepend 'asc:' or 'desc:' to a field to change the sort direction. ", + "in": "query", + "name": "sort", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for domains specified by id, if configured. ", + "in": "query", + "name": "domain_ids", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users in zone specified by name, if configured. ", + "in": "query", + "name": "zone_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for local hosts specified by resolved names, if configured. ", + "in": "query", + "name": "local_names", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by numeric UIDs, if configured. ", + "in": "query", + "name": "user_ids", + "type": "string" + }, + { + "description": "A comma separated list specifying what should be unique. (node | system_name | user_id | user_sid | username | zone_id | zone_name | local_addr | local_name | remote_addr | remote_name | group_id | group_sid | groupname | domain_id | path | export_id | protocol | share_name | job_type). Aggregation is performed over all the fields not specified in the list.", + "in": "query", + "name": "totalby", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for local hosts specified by IP addresses, if configured. ", + "in": "query", + "name": "local_addresses", + "type": "string" + }, + { + "description": "Report workload performance metrics for specified dataset. Default is 'System'.", + "in": "query", + "name": "dataset", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for users specified by Security IDs, if configured. ", + "in": "query", + "name": "user_sids", + "type": "string" + }, + { + "description": "A comma separated list. Default is all. (smb1, smb2, nfs3 and nfs4 only at this time.)", + "in": "query", + "name": "protocols", + "type": "string" + }, + { + "description": "A comma separated list. Only report statistics for groups specified by numeric GIDs, if configured. ", + "in": "query", + "name": "group_ids", + "type": "string" + }, + { + "description": "Timeout remote commands after NUM seconds, where NUM is the integer passed to the argument.", + "in": "query", + "name": "timeout", + "type": "integer" + }, + { + "description": "A comma separated list. Only report statistics for systems specified by resolved names, if configured. ", + "in": "query", + "name": "system_names", + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/v10SummaryWorkload" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Statistics" + ] + } + }, + "/platform/9/storagepool/nodepools": { + "delete": { + "description": "Delete node pool.", + "operationId": "deleteStoragepoolv9StoragepoolNodepools", + "parameters": [], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "get": { + "description": "List all node pools.", + "operationId": "listStoragepoolv9StoragepoolNodepools", + "parameters": [], + "responses": { + "200": { + "description": "List all node pools.", + "schema": { + "$ref": "#/definitions/v9StoragepoolNodepools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "post": { + "description": "Create a new node pool.", + "operationId": "createStoragepoolv9StoragepoolNodepool", + "parameters": [ + { + "in": "body", + "name": "v9StoragepoolNodepool", + "required": true, + "schema": { + "$ref": "#/definitions/v9StoragepoolNodepool" + } + } + ], + "responses": { + "200": { + "description": "Create a new node pool.", + "schema": { + "$ref": "#/definitions/Createv1StoragepoolNodepoolResponse" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/9/storagepool/nodepools/{v9StoragepoolNodepoolId}": { + "delete": { + "description": "Delete node pool.", + "operationId": "deleteStoragepoolv9StoragepoolNodepool", + "parameters": [ + { + "description": "Delete node pool.", + "in": "path", + "name": "v9StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "get": { + "description": "Retrieve node pool information.", + "operationId": "getStoragepoolv9StoragepoolNodepool", + "parameters": [ + { + "description": "Retrieve node pool information.", + "in": "path", + "name": "v9StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve node pool information.", + "schema": { + "$ref": "#/definitions/v9StoragepoolNodepoolsExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + }, + "put": { + "description": "Modify node pool. All input fields are optional, but one or more must be supplied.", + "operationId": "updateStoragepoolv9StoragepoolNodepool", + "parameters": [ + { + "in": "body", + "name": "v9StoragepoolNodepool", + "required": true, + "schema": { + "$ref": "#/definitions/v9StoragepoolNodepoolExtendedExtended" + } + }, + { + "description": "Modify node pool. All input fields are optional, but one or more must be supplied.", + "in": "path", + "name": "v9StoragepoolNodepoolId", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/9/storagepool/nodetypes": { + "get": { + "description": "List all node types.", + "operationId": "getStoragepoolv9StoragepoolNodetypes", + "parameters": [], + "responses": { + "200": { + "description": "List all node types.", + "schema": { + "$ref": "#/definitions/v9StoragepoolNodetypes" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/9/storagepool/nodetypes/{v9StoragepoolNodetypeId}": { + "get": { + "description": "Retrieve node type information.", + "operationId": "getStoragepoolv9StoragepoolNodetype", + "parameters": [ + { + "description": "Retrieve node type information.", + "in": "path", + "name": "v9StoragepoolNodetypeId", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Retrieve node type information.", + "schema": { + "$ref": "#/definitions/v9StoragepoolNodetypesExtended" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/9/storagepool/storagepools": { + "get": { + "description": "List all storage pools.", + "operationId": "getStoragepoolv9StoragepoolStoragepools", + "parameters": [ + { + "description": "The field that will be used for sorting.", + "in": "query", + "maxLength": 255, + "minLength": 0, + "name": "sort", + "type": "string" + }, + { + "description": "If true, node pools contained within tiers will be filtered out of results.", + "in": "query", + "name": "toplevels", + "type": "string" + }, + { + "description": "The direction of the sort.", + "enum": [ + "ASC", + "DESC" + ], + "in": "query", + "minLength": 0, + "name": "dir", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all storage pools.", + "schema": { + "$ref": "#/definitions/v9StoragepoolStoragepools" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Storagepool" + ] + } + }, + "/platform/9/upgrade/cluster/unblock": { + "put": { + "description": "Unblock parallel upgrade.", + "operationId": "updateUpgradev9ClusterUnblock", + "parameters": [ + { + "in": "body", + "name": "v9ClusterUnblock", + "required": true, + "schema": { + "$ref": "#/definitions/v9ClusterUnblock" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + }, + "/platform/9/upgrade/cluster/upgrade": { + "post": { + "description": "The settings necessary to start an upgrade.", + "operationId": "createUpgradev9ClusterUpgradeItem", + "parameters": [ + { + "in": "body", + "name": "v9ClusterUpgradeItem", + "required": true, + "schema": { + "$ref": "#/definitions/v9ClusterUpgradeItem" + } + } + ], + "responses": { + "200": { + "description": "The settings necessary to start an upgrade.", + "schema": { + "$ref": "#/definitions/Empty" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + }, + "put": { + "description": "Add nodes to a running upgrade.", + "operationId": "updateUpgradev9ClusterUpgrade", + "parameters": [ + { + "in": "body", + "name": "v9ClusterUpgrade", + "required": true, + "schema": { + "$ref": "#/definitions/v12ClusterUpgrade" + } + } + ], + "responses": { + "204": { + "description": "Success." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "tags": [ + "Upgrade" + ] + } + } + }, + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "security": [ + { + "basicAuth": [] + } + ], + "securityDefinitions": { + "basicAuth": { + "type": "basic" + } + }, + "swagger": "2.0", + "tags": [ + { + "description": "Tag for Namespace", + "name": "Namespace" + }, + { + "description": "Tag for Antivirus", + "name": "Antivirus" + }, + { + "description": "Tag for Api", + "name": "Api" + }, + { + "description": "Tag for Audit", + "name": "Audit" + }, + { + "description": "Tag for Auth", + "name": "Auth" + }, + { + "description": "Tag for AuthGroups", + "name": "AuthGroups" + }, + { + "description": "Tag for AuthProviders", + "name": "AuthProviders" + }, + { + "description": "Tag for AuthRoles", + "name": "AuthRoles" + }, + { + "description": "Tag for AuthUsers", + "name": "AuthUsers" + }, + { + "description": "Tag for Avscan", + "name": "Avscan" + }, + { + "description": "Tag for AvscanNodes", + "name": "AvscanNodes" + }, + { + "description": "Tag for Catalog", + "name": "Catalog" + }, + { + "description": "Tag for Certificate", + "name": "Certificate" + }, + { + "description": "Tag for Cloud", + "name": "Cloud" + }, + { + "description": "Tag for ClusterMode", + "name": "ClusterMode" + }, + { + "description": "Tag for Cluster", + "name": "Cluster" + }, + { + "description": "Tag for ClusterNodes", + "name": "ClusterNodes" + }, + { + "description": "Tag for Config", + "name": "Config" + }, + { + "description": "Tag for Datamover", + "name": "Datamover" + }, + { + "description": "Tag for Debug", + "name": "Debug" + }, + { + "description": "Tag for Dedupe", + "name": "Dedupe" + }, + { + "description": "Tag for Event", + "name": "Event" + }, + { + "description": "Tag for FileFilter", + "name": "FileFilter" + }, + { + "description": "Tag for Filepool", + "name": "Filepool" + }, + { + "description": "Tag for Filesystem", + "name": "Filesystem" + }, + { + "description": "Tag for Fsa", + "name": "Fsa" + }, + { + "description": "Tag for FsaIndex", + "name": "FsaIndex" + }, + { + "description": "Tag for FsaResults", + "name": "FsaResults" + }, + { + "description": "Tag for GroupnetsSummary", + "name": "GroupnetsSummary" + }, + { + "description": "Tag for Hardening", + "name": "Hardening" + }, + { + "description": "Tag for Hardware", + "name": "Hardware" + }, + { + "description": "Tag for Healthcheck", + "name": "Healthcheck" + }, + { + "description": "Tag for IdResolution", + "name": "IdResolution" + }, + { + "description": "Tag for IdResolutionZones", + "name": "IdResolutionZones" + }, + { + "description": "Tag for Ipmi", + "name": "Ipmi" + }, + { + "description": "Tag for Job", + "name": "Job" + }, + { + "description": "Tag for Keymanager", + "name": "Keymanager" + }, + { + "description": "Tag for Lfn", + "name": "Lfn" + }, + { + "description": "Tag for License", + "name": "License" + }, + { + "description": "Tag for Network", + "name": "Network" + }, + { + "description": "Tag for NetworkGroupnets", + "name": "NetworkGroupnets" + }, + { + "description": "Tag for NetworkGroupnetsSubnets", + "name": "NetworkGroupnetsSubnets" + }, + { + "description": "Tag for Papi", + "name": "Papi" + }, + { + "description": "Tag for Performance", + "name": "Performance" + }, + { + "description": "Tag for PerformanceDatasets", + "name": "PerformanceDatasets" + }, + { + "description": "Tag for Protocols", + "name": "Protocols" + }, + { + "description": "Tag for ProtocolsHdfs", + "name": "ProtocolsHdfs" + }, + { + "description": "Tag for Quota", + "name": "Quota" + }, + { + "description": "Tag for QuotaQuotas", + "name": "QuotaQuotas" + }, + { + "description": "Tag for QuotaReports", + "name": "QuotaReports" + }, + { + "description": "Tag for Security", + "name": "Security" + }, + { + "description": "Tag for Snapshot", + "name": "Snapshot" + }, + { + "description": "Tag for SnapshotChangelists", + "name": "SnapshotChangelists" + }, + { + "description": "Tag for SnapshotSnapshots", + "name": "SnapshotSnapshots" + }, + { + "description": "Tag for Statistics", + "name": "Statistics" + }, + { + "description": "Tag for Storagepool", + "name": "Storagepool" + }, + { + "description": "Tag for StoragepoolNodetypes", + "name": "StoragepoolNodetypes" + }, + { + "description": "Tag for Sync", + "name": "Sync" + }, + { + "description": "Tag for SyncPolicies", + "name": "SyncPolicies" + }, + { + "description": "Tag for SyncReports", + "name": "SyncReports" + }, + { + "description": "Tag for SyncService", + "name": "SyncService" + }, + { + "description": "Tag for SyncServiceTarget", + "name": "SyncServiceTarget" + }, + { + "description": "Tag for SyncTarget", + "name": "SyncTarget" + }, + { + "description": "Tag for Upgrade", + "name": "Upgrade" + }, + { + "description": "Tag for UpgradeCluster", + "name": "UpgradeCluster" + }, + { + "description": "Tag for Worm", + "name": "Worm" + }, + { + "description": "Tag for Zones", + "name": "Zones" + }, + { + "description": "Tag for ZonesSummary", + "name": "ZonesSummary" + } + ] +} \ No newline at end of file diff --git a/goClientZip/powerscale-go-client.zip b/goClientZip/powerscale-go-client.zip index ce1d2e7d..56918252 100644 Binary files a/goClientZip/powerscale-go-client.zip and b/goClientZip/powerscale-go-client.zip differ diff --git a/powerscale/constants/constants.go b/powerscale/constants/constants.go index f5446e10..c4eaf934 100644 --- a/powerscale/constants/constants.go +++ b/powerscale/constants/constants.go @@ -20,4 +20,13 @@ package constants const ( // ReadAccessZoneErrorMsg specifies error details occurred while reading Access Zones. ReadAccessZoneErrorMsg = "Could not read access zones " + + // CreateAccessZoneErrorMsg specifies error details occurred while creating an Access Zones. + CreateAccessZoneErrorMsg = "Could not create access zones " + + // UpdateAccessZoneErrorMsg specifies error details occurred while updating an Access Zones. + UpdateAccessZoneErrorMsg = "Could not update access zones " + + // DeleteAccessZoneErrorMsg specifies error details occurred while deleting an Access Zones. + DeleteAccessZoneErrorMsg = "Could not delete access zones " ) diff --git a/powerscale/helper/access_zone_helper.go b/powerscale/helper/access_zone_helper.go index e06577a1..0e4fb484 100644 --- a/powerscale/helper/access_zone_helper.go +++ b/powerscale/helper/access_zone_helper.go @@ -19,13 +19,17 @@ package helper import ( "context" - "dell/powerscale-go-client" + powerscale "dell/powerscale-go-client" + "fmt" + "strings" "terraform-provider-powerscale/client" + "terraform-provider-powerscale/powerscale/constants" "terraform-provider-powerscale/powerscale/models" "github.com/hashicorp/terraform-plugin-framework/attr" "github.com/hashicorp/terraform-plugin-framework/diag" "github.com/hashicorp/terraform-plugin-framework/types" + "github.com/hashicorp/terraform-plugin-framework/types/basetypes" ) // AccessZoneDetailMapper Does the mapping from response to model @@ -42,6 +46,20 @@ func AccessZoneDetailMapper(ctx context.Context, az *powerscale.V3ZoneExtended) return model, nil } +// AccessZoneResouceDetailMapper detail mapper for access zone resource +func AccessZoneResouceDetailMapper(ctx context.Context, az *powerscale.V3ZoneExtended) (models.AccessZoneResourceModel, error) { + model := models.AccessZoneResourceModel{} + err := CopyFields(ctx, az, &model) + model.IfsRestricted, _ = GetAuthAccessKeyObjects(az.IfsRestricted) + // These need to be done manually because of the linter + model.ZoneID = types.Int64Value(int64(*az.ZoneId)) + model.ID = types.StringValue(*az.Id) + if err != nil { + return model, err + } + return model, nil +} + // GetAuthAccessKeyObjects returns auth hours key objects. func GetAuthAccessKeyObjects(accessResponse []powerscale.V1AuthAccessAccessItemFileGroup) (types.List, diag.Diagnostics) { var accessKeyObjects []attr.Value @@ -66,3 +84,54 @@ func GetAllAccessZones(ctx context.Context, client *client.Client) (*powerscale. result, _, err := client.PscaleOpenAPIClient.ZonesApi.ListZonesv3Zones(ctx).Execute() return result, err } + +// CreateAccessZones Creates an Access Zone +func CreateAccessZones(ctx context.Context, client *client.Client, authProv []string, plan *models.AccessZoneResourceModel) error { + forceOverlap := true + createPath := false + createParam := client.PscaleOpenAPIClient.ZonesApi.CreateZonesv3Zone(ctx) + createParam = createParam.V3Zone(powerscale.V3Zone{ + AuthProviders: authProv, + CreatePath: &createPath, + Groupnet: plan.Groupnet.ValueStringPointer(), + Name: plan.Name.ValueString(), + Path: plan.Path.ValueStringPointer(), + ForceOverlap: &forceOverlap, + }) + + _, _, err := createParam.Execute() + return err +} + +// GetSpecificZone returns a specific zone or an error +func GetSpecificZone(ctx context.Context, matchZone string, zoneList []powerscale.V3ZoneExtended) (models.AccessZoneResourceModel, error) { + for _, vze := range zoneList { + if *vze.Name == matchZone { + zone := vze + state, err := AccessZoneResouceDetailMapper(ctx, &zone) + if err != nil { + errStr := constants.ReadAccessZoneErrorMsg + "with error: " + message := GetErrorString(err, errStr) + return models.AccessZoneResourceModel{}, fmt.Errorf("error finding new access zone after create : %s", message) + + } + return state, nil + } + } + + return models.AccessZoneResourceModel{}, fmt.Errorf("error finding new access zone after create, Unable to create successfully") +} + +// ExtractCustomAuthForInput extracts the custom auth provider from actual auth provider for input +func ExtractCustomAuthForInput(ctx context.Context, authProv basetypes.ListValue, mainAuth string) (basetypes.ListValue, diag.Diagnostics) { + var filteredAuths []attr.Value + for _, v := range authProv.Elements() { + name := strings.Split(v.String(), ":")[1] + name = strings.Split(name, "\"")[0] + if name != mainAuth { + stringVal := types.StringValue(name) + filteredAuths = append(filteredAuths, stringVal) + } + } + return types.ListValue(types.StringType, filteredAuths) +} diff --git a/powerscale/helper/cluster_helper.go b/powerscale/helper/cluster_helper.go new file mode 100644 index 00000000..2599cccd --- /dev/null +++ b/powerscale/helper/cluster_helper.go @@ -0,0 +1,1221 @@ +package helper + +import ( + "context" + powerscale "dell/powerscale-go-client" + "terraform-provider-powerscale/client" + + "github.com/hashicorp/terraform-plugin-framework/datasource/schema" + "github.com/hashicorp/terraform-plugin-framework/types" +) + +// GetClusterConfigSchema Get cluster config schema +func GetClusterConfigSchema() schema.Attribute { + config := schema.SingleNestedAttribute{ + MarkdownDescription: "The configuration information of cluster.", + Description: "The configuration information of cluster.", + Computed: true, + Attributes: map[string]schema.Attribute{ + "description": schema.StringAttribute{ + Description: "Customer configurable description.", + MarkdownDescription: "Customer configurable description.", + Computed: true, + }, + "devices": schema.ListNestedAttribute{ + Description: "device", + MarkdownDescription: "device", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "devid": schema.Int64Attribute{ + Description: "Device ID.", + MarkdownDescription: "Device ID.", + Computed: true, + }, + "guid": schema.StringAttribute{ + Description: "Device GUID.", + MarkdownDescription: "Device GUID.", + Computed: true, + }, + "is_up": schema.BoolAttribute{ + Description: "If true, this node is online and communicating with the local node and every other node with the is_up property normally", + MarkdownDescription: "If true, this node is online and communicating with the local node and every other node with the is_up property normally", + Computed: true, + }, + "lnn": schema.Int64Attribute{ + Description: "Device logical node number.", + MarkdownDescription: "Device logical node number.", + Computed: true, + }, + }, + }, + }, + "guid": schema.StringAttribute{ + Description: "Cluster GUID.", + MarkdownDescription: "Cluster GUID.", + Computed: true, + }, + + "join_mode": schema.StringAttribute{ + Description: "Node join mode: 'manual' or 'secure'.", + MarkdownDescription: "Node join mode: 'manual' or 'secure'.", + Computed: true, + }, + "local_devid": schema.Int64Attribute{ + Description: "Device ID of the queried node.", + MarkdownDescription: "Device ID of the queried node.", + Computed: true, + }, + "local_lnn": schema.Int64Attribute{ + Description: "Device logical node number of the queried node.", + MarkdownDescription: "Device logical node number of the queried node.", + Computed: true, + }, + "local_serial": schema.StringAttribute{ + Description: "Device serial number of the queried node.", + MarkdownDescription: "Device serial number of the queried node.", + Computed: true, + }, + "name": schema.StringAttribute{ + Description: "Cluster name.", + MarkdownDescription: "Cluster name.", + Computed: true, + }, + "onefs_version": schema.SingleNestedAttribute{ + Description: "version", + MarkdownDescription: "version", + Computed: true, + Attributes: map[string]schema.Attribute{ + "build": schema.StringAttribute{ + Description: "OneFS build string.", + MarkdownDescription: "OneFS build string.", + Computed: true, + }, + "release": schema.StringAttribute{ + Description: "Kernel release number.", + MarkdownDescription: "Kernel release number.", + Computed: true, + }, + "revision": schema.StringAttribute{ + Description: "OneFS build number.", + MarkdownDescription: "OneFS build number.", + Computed: true, + }, + "type": schema.StringAttribute{ + Description: "Kernel release type.", + MarkdownDescription: "Kernel release type.", + Computed: true, + }, + "version": schema.StringAttribute{ + Description: "Kernel full version information.", + MarkdownDescription: "Kernel full version information.", + Computed: true, + }, + }, + }, + "timezone": schema.SingleNestedAttribute{ + Description: "version", + MarkdownDescription: "version", + Computed: true, + Attributes: map[string]schema.Attribute{ + "abbreviation": schema.StringAttribute{ + Description: "Timezone abbreviation.", + MarkdownDescription: "Timezone abbreviation.", + Computed: true, + }, + "custom": schema.StringAttribute{ + Description: "Customer timezone information.", + MarkdownDescription: "Customer timezone information.", + Computed: true, + }, + "name": schema.StringAttribute{ + Description: "Timezone full name.", + MarkdownDescription: "Timezone full name.", + Computed: true, + }, + "path": schema.StringAttribute{ + Description: "Timezone hierarchical name.", + MarkdownDescription: "Timezone hierarchical name.", + Computed: true, + }, + }, + }, + }, + } + return config +} + +// GetClusterIdentitySchema Get cluster identity schema +func GetClusterIdentitySchema() schema.Attribute { + identity := schema.SingleNestedAttribute{ + MarkdownDescription: "Unprivileged cluster information for display when logging in.", + Description: "Unprivileged cluster information for display when logging in.", + Computed: true, + Attributes: map[string]schema.Attribute{ + "description": schema.StringAttribute{ + Description: "A description of the cluster.", + MarkdownDescription: "A description of the cluster.", + Computed: true, + }, + "logon": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "motd": schema.StringAttribute{ + Description: "The message of the day.", + MarkdownDescription: "The message of the day.", + Computed: true, + }, + "motd_header": schema.StringAttribute{ + Description: "The header to the message of the day.", + MarkdownDescription: "The header to the message of the day.", + Computed: true, + }, + }, + }, + "name": schema.StringAttribute{ + Description: "The name of the cluster.", + MarkdownDescription: "The name of the cluster.", + Computed: true, + }, + }, + } + return identity +} + +// GetClusterNodeSchema get cluster node schema +func GetClusterNodeSchema() schema.Attribute { + attribute := schema.SingleNestedAttribute{ + MarkdownDescription: "IsiClusterNodes struct for IsiClusterNodes", + Description: "IsiClusterNodes struct for IsiClusterNodes", + Computed: true, + Attributes: map[string]schema.Attribute{ + "errors": schema.ListNestedAttribute{ + Description: "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + MarkdownDescription: "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "code": schema.StringAttribute{ + Description: "The error code.", + MarkdownDescription: "The error code.", + Computed: true, + }, + "field": schema.StringAttribute{ + Description: "The field with the error if applicable.", + MarkdownDescription: "The field with the error if applicable.", + Computed: true, + }, + "id": schema.Int64Attribute{ + Description: "Node ID (Device Number) of a node.", + MarkdownDescription: "Node ID (Device Number) of a node.", + Computed: true, + }, + "lnn": schema.Int64Attribute{ + Description: "Logical Node Number (LNN) of a node.", + MarkdownDescription: "Logical Node Number (LNN) of a node.", + Computed: true, + }, + "message": schema.StringAttribute{ + Description: "The error message.", + MarkdownDescription: "The error message.", + Computed: true, + }, + "status": schema.Int64Attribute{ + Description: "HTTP Status code returned by this node.", + MarkdownDescription: "HTTP Status code returned by this node.", + Computed: true, + }, + }, + }, + }, + "nodes": schema.ListNestedAttribute{ + Description: "The responses from the individual nodes involved in this request.", + MarkdownDescription: "The responses from the individual nodes involved in this request.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "drives": schema.ListNestedAttribute{ + Description: "List of the drives in this node.", + MarkdownDescription: "List of the drives in this node.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "baynum": schema.Int64Attribute{ + Description: "Numerical representation of this drive's bay.", + MarkdownDescription: "Numerical representation of this drive's bay.", + Computed: true, + }, + "blocks": schema.Int64Attribute{ + Description: "Number of blocks on this drive.", + MarkdownDescription: "Number of blocks on this drive.", + Computed: true, + }, + "chassis": schema.Int64Attribute{ + Description: "The chassis number which contains this drive.", + MarkdownDescription: "The chassis number which contains this drive.", + Computed: true, + }, + "devname": schema.StringAttribute{ + Description: "This drive's device name.", + MarkdownDescription: "This drive's device name.", + Computed: true, + }, + "firmware": schema.SingleNestedAttribute{ + Description: "Drive firmware information", + MarkdownDescription: "Drive firmware information", + Computed: true, + Attributes: map[string]schema.Attribute{ + "current_firmware": schema.StringAttribute{ + Description: "This drive's current firmware revision", + MarkdownDescription: "This drive's current firmware revision", + Computed: true, + }, + "desired_firmware": schema.StringAttribute{ + Description: "This drive's desired firmware revision.", + MarkdownDescription: "This drive's desired firmware revision.", + Computed: true, + }, + }, + }, + "handle": schema.Int64Attribute{ + Description: "Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1", + MarkdownDescription: "Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1", + Computed: true, + }, + "interface_type": schema.StringAttribute{ + Description: "String representation of this drive's interface type.", + MarkdownDescription: "String representation of this drive's interface type.", + Computed: true, + }, + "lnum": schema.Int64Attribute{ + Description: "This drive's logical drive number in IFS.", + MarkdownDescription: "This drive's logical drive number in IFS.", + Computed: true, + }, + "locnstr": schema.StringAttribute{ + Description: "String representation of this drive's physical location.", + MarkdownDescription: "String representation of this drive's physical location.", + Computed: true, + }, + "logical_block_length": schema.Int64Attribute{ + Description: "Size of a logical block on this drive.", + MarkdownDescription: "Size of a logical block on this drive.", + Computed: true, + }, + "media_type": schema.StringAttribute{ + Description: "String representation of this drive's media type.", + MarkdownDescription: "String representation of this drive's media type.", + Computed: true, + }, + "model": schema.StringAttribute{ + Description: "This drive's manufacturer and model.", + MarkdownDescription: "This drive's manufacturer and model.", + Computed: true, + }, + "physical_block_length": schema.Int64Attribute{ + Description: "Size of a physical block on this drive.", + MarkdownDescription: "Size of a physical block on this drive.", + Computed: true, + }, + "present": schema.BoolAttribute{ + Description: "Indicates whether this drive is physically present in the node.", + MarkdownDescription: "Indicates whether this drive is physically present in the node.", + Computed: true, + }, + "purpose": schema.StringAttribute{ + Description: "This drive's purpose in the DRV state machine.", + MarkdownDescription: "This drive's purpose in the DRV state machine.", + Computed: true, + }, + "purpose_description": schema.StringAttribute{ + Description: "Description of this drive's purpose.", + MarkdownDescription: "Description of this drive's purpose.", + Computed: true, + }, + "serial": schema.StringAttribute{ + Description: "Serial number for this drive.", + MarkdownDescription: "Serial number for this drive.", + Computed: true, + }, + "ui_state": schema.StringAttribute{ + Description: "This drive's state as presented to the UI.", + MarkdownDescription: "This drive's state as presented to the UI.", + Computed: true, + }, + "wwn": schema.StringAttribute{ + Description: "The drive's 'worldwide name' from its NAA identifiers.", + MarkdownDescription: "The drive's 'worldwide name' from its NAA identifiers.", + Computed: true, + }, + "x_loc": schema.Int64Attribute{ + Description: "This drive's x-axis grid location.", + MarkdownDescription: "This drive's x-axis grid location.", + Computed: true, + }, + "y_loc": schema.Int64Attribute{ + Description: "This drive's y-axis grid location.", + MarkdownDescription: "This drive's y-axis grid location.", + Computed: true, + }, + }, + }, + }, + "error": schema.StringAttribute{ + Description: "Error message, if the HTTP status returned from this node was not 200.", + MarkdownDescription: "Error message, if the HTTP status returned from this node was not 200.", + Computed: true, + }, + "hardware": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "chassis": schema.StringAttribute{ + Description: "Name of this node's chassis.", + MarkdownDescription: "Name of this node's chassis.", + Computed: true, + }, + "chassis_code": schema.StringAttribute{ + Description: "Chassis code of this node (1U, 2U, etc.).", + MarkdownDescription: "Chassis code of this node (1U, 2U, etc.).", + Computed: true, + }, + "chassis_count": schema.StringAttribute{ + Description: "Number of chassis making up this node.", + MarkdownDescription: "Number of chassis making up this node.", + Computed: true, + }, + "class": schema.StringAttribute{ + Description: "Class of this node (storage, accelerator, etc.).", + MarkdownDescription: "Class of this node (storage, accelerator, etc.).", + Computed: true, + }, + "configuration_id": schema.StringAttribute{ + Description: "Node configuration ID.", + MarkdownDescription: "Node configuration ID.", + Computed: true, + }, + "cpu": schema.StringAttribute{ + Description: "Manufacturer and model of this node's CPU.", + MarkdownDescription: "Manufacturer and model of this node's CPU.", + Computed: true, + }, + "disk_controller": schema.StringAttribute{ + Description: "Manufacturer and model of this node's disk controller.", + MarkdownDescription: "Manufacturer and model of this node's disk controller.", + Computed: true, + }, + "disk_expander": schema.StringAttribute{ + Description: "Manufacturer and model of this node's disk expander.", + MarkdownDescription: "Manufacturer and model of this node's disk expander.", + Computed: true, + }, + "family_code": schema.StringAttribute{ + Description: "Family code of this node (X, S, NL, etc.).", + MarkdownDescription: "Family code of this node (X, S, NL, etc.).", + Computed: true, + }, + "flash_drive": schema.StringAttribute{ + Description: "Manufacturer, model, and device id of this node's flash drive.", + MarkdownDescription: "Manufacturer, model, and device id of this node's flash drive.", + Computed: true, + }, + "generation_code": schema.StringAttribute{ + Description: "Generation code of this node.", + MarkdownDescription: "Generation code of this node.", + Computed: true, + }, + "hwgen": schema.StringAttribute{ + Description: "PowerScale hardware generation name.", + MarkdownDescription: "PowerScale hardware generation name.", + Computed: true, + }, + "imb_version": schema.StringAttribute{ + Description: "Version of this node's PowerScale Management Board.", + MarkdownDescription: "Version of this node's PowerScale Management Board.", + Computed: true, + }, + "infiniband": schema.StringAttribute{ + Description: "Infiniband card type.", + MarkdownDescription: "Infiniband card type.", + Computed: true, + }, + "lcd_version": schema.StringAttribute{ + Description: "Version of the LCD panel.", + MarkdownDescription: "Version of the LCD panel.", + Computed: true, + }, + "motherboard": schema.StringAttribute{ + Description: "Manufacturer and model of this node's motherboard.", + MarkdownDescription: "Manufacturer and model of this node's motherboard.", + Computed: true, + }, + "net_interfaces": schema.StringAttribute{ + Description: "Description of all this node's network interfaces.", + MarkdownDescription: "Description of all this node's network interfaces.", + Computed: true, + }, + "nvram": schema.StringAttribute{ + Description: "Manufacturer and model of this node's NVRAM board.", + MarkdownDescription: "Manufacturer and model of this node's NVRAM board.", + Computed: true, + }, + "powersupplies": schema.ListAttribute{ + Description: "Description strings for each power supply on this node.", + MarkdownDescription: "Description strings for each power supply on this node.", + Computed: true, + ElementType: types.StringType, + }, + "processor": schema.StringAttribute{ + Description: "Number of processors and cores on this node.", + MarkdownDescription: "Number of processors and cores on this node.", + Computed: true, + }, + "product": schema.StringAttribute{ + Description: "PowerScale product name.", + MarkdownDescription: "PowerScale product name.", + Computed: true, + }, + "ram": schema.Int64Attribute{ + Description: "Size of RAM in bytes.", + MarkdownDescription: "Size of RAM in bytes.", + Computed: true, + }, + "serial_number": schema.StringAttribute{ + Description: "Serial number of this node.", + MarkdownDescription: "Serial number of this node.", + Computed: true, + }, + "series": schema.StringAttribute{ + Description: "Series of this node (X, I, NL, etc.).", + MarkdownDescription: "Series of this node (X, I, NL, etc.).", + Computed: true, + }, + "storage_class": schema.StringAttribute{ + Description: "Storage class of this node (storage or diskless).", + MarkdownDescription: "Storage class of this node (storage or diskless).", + Computed: true, + }, + }, + }, + "id": schema.Int64Attribute{ + Description: "Node ID (Device Number) of a node.", + MarkdownDescription: "Node ID (Device Number) of a node.", + Computed: true, + }, + "lnn": schema.Int64Attribute{ + Description: "Logical Node Number (LNN) of a node.", + MarkdownDescription: "Logical Node Number (LNN) of a node.", + Computed: true, + }, + "partitions": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "count": schema.Int64Attribute{ + Description: "Count of how many partitions are included.", + MarkdownDescription: "Count of how many partitions are included.", + Computed: true, + }, + "partitions": schema.ListNestedAttribute{ + Description: "Partition information.", + MarkdownDescription: "Partition information.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "block_size": schema.Int64Attribute{ + Description: "The block size used for the reported partition information.", + MarkdownDescription: "The block size used for the reported partition information.", + Computed: true, + }, + "capacity": schema.Int64Attribute{ + Description: "Total blocks on this file system partition.", + MarkdownDescription: "Total blocks on this file system partition.", + Computed: true, + }, + "component_devices": schema.StringAttribute{ + Description: "Comma separated list of devices used for this file system partition.", + MarkdownDescription: "Comma separated list of devices used for this file system partition.", + Computed: true, + }, + "mount_point": schema.StringAttribute{ + Description: "Directory on which this partition is mounted.", + MarkdownDescription: "Directory on which this partition is mounted.", + Computed: true, + }, + "percent_used": schema.StringAttribute{ + Description: "Used blocks on this file system partition, expressed as a percentage.", + MarkdownDescription: "Used blocks on this file system partition, expressed as a percentage.", + Computed: true, + }, + "statfs": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "f_bavail": schema.Int64Attribute{ + Description: "Free blocks available to non-superuser on this partition.", + MarkdownDescription: "Free blocks available to non-superuser on this partition.", + Computed: true, + }, + "f_bfree": schema.Int64Attribute{ + Description: "Free blocks on this partition.", + MarkdownDescription: "Free blocks on this partition.", + Computed: true, + }, + "f_blocks": schema.Int64Attribute{ + Description: "Total data blocks on this partition.", + MarkdownDescription: "Total data blocks on this partition.", + Computed: true, + }, + "f_bsize": schema.Int64Attribute{ + Description: "Filesystem fragment size; block size in OneFS.", + MarkdownDescription: "Filesystem fragment size; block size in OneFS.", + Computed: true, + }, + "f_ffree": schema.Int64Attribute{ + Description: "Free file nodes avail to non-superuser.", + MarkdownDescription: "Free file nodes avail to non-superuser.", + Computed: true, + }, + "f_files": schema.Int64Attribute{ + Description: "Total file nodes in filesystem.", + MarkdownDescription: "Total file nodes in filesystem.", + Computed: true, + }, + "f_flags": schema.Int64Attribute{ + Description: "Mount exported flags.", + MarkdownDescription: "Mount exported flags.", + Computed: true, + }, + "f_fstypename": schema.StringAttribute{ + Description: "File system type name.", + MarkdownDescription: "File system type name.", + Computed: true, + }, + "f_iosize": schema.Int64Attribute{ + Description: "Optimal transfer block size.", + MarkdownDescription: "Optimal transfer block size.", + Computed: true, + }, + "f_mntfromname": schema.StringAttribute{ + Description: "Names of devices this partition is mounted from.", + MarkdownDescription: "Names of devices this partition is mounted from.", + Computed: true, + }, + "f_mntonname": schema.StringAttribute{ + Description: "Directory this partition is mounted to.", + MarkdownDescription: "Directory this partition is mounted to.", + Computed: true, + }, + "f_namemax": schema.Int64Attribute{ + Description: "Maximum filename length.", + MarkdownDescription: "Maximum filename length.", + Computed: true, + }, + "f_owner": schema.Int64Attribute{ + Description: "UID of user that mounted the filesystem.", + MarkdownDescription: "UID of user that mounted the filesystem.", + Computed: true, + }, + "f_type": schema.Int64Attribute{ + Description: "Type of filesystem.", + MarkdownDescription: "Type of filesystem.", + Computed: true, + }, + "f_version": schema.Int64Attribute{ + Description: "statfs() structure version number.", + MarkdownDescription: "statfs() structure version number.", + Computed: true, + }, + }, + }, + "used": schema.Int64Attribute{ + Description: "Used blocks on this file system partition.", + MarkdownDescription: "Used blocks on this file system partition.", + Computed: true, + }, + }, + }, + }, + }, + }, + "sensors": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "sensors": schema.ListNestedAttribute{ + Description: "This node's sensor information.", + MarkdownDescription: "This node's sensor information.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "count": schema.Int64Attribute{ + Description: "The count of values in this sensor group.", + MarkdownDescription: "The count of values in this sensor group.", + Computed: true, + }, + "name": schema.StringAttribute{ + Description: "The name of this sensor group.", + MarkdownDescription: "The name of this sensor group.", + Computed: true, + }, + "values": schema.ListNestedAttribute{ + Description: "The list of specific sensor value info in this sensor group.", + MarkdownDescription: "The list of specific sensor value info in this sensor group.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "desc": schema.StringAttribute{ + Description: "The descriptive name of this sensor.", + MarkdownDescription: "The descriptive name of this sensor.", + Computed: true, + }, + "name": schema.StringAttribute{ + Description: "The identifier name of this sensor.", + MarkdownDescription: "The identifier name of this sensor.", + Computed: true, + }, + "units": schema.StringAttribute{ + Description: "The units of this sensor.", + MarkdownDescription: "The units of this sensor.", + Computed: true, + }, + "value": schema.StringAttribute{ + Description: "The value of this sensor.", + MarkdownDescription: "The value of this sensor.", + Computed: true, + }, + }, + }, + }, + }, + }, + }, + }, + }, + "state": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "readonly": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "allowed": schema.BoolAttribute{ + Description: "The current read-only mode allowed status for the node.", + MarkdownDescription: "The current read-only mode allowed status for the node.", + Computed: true, + }, + "enabled": schema.BoolAttribute{ + Description: "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared.", + MarkdownDescription: "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared.", + Computed: true, + }, + "mode": schema.BoolAttribute{ + Description: "The current read-only mode status for the node.", + MarkdownDescription: "The current read-only mode status for the node.", + Computed: true, + }, + "status": schema.StringAttribute{ + Description: "The current read-only mode status description for the node.", + MarkdownDescription: "The current read-only mode status description for the node.", + Computed: true, + }, + "valid": schema.BoolAttribute{ + Description: "The read-only state values are valid (False = Error).", + MarkdownDescription: "The read-only state values are valid (False = Error).", + Computed: true, + }, + "value": schema.Int64Attribute{ + Description: "The current read-only value (enumerated bitfield) for the node.", + MarkdownDescription: "The current read-only value (enumerated bitfield) for the node.", + Computed: true, + }, + }, + }, + "servicelight": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "enabled": schema.BoolAttribute{ + Description: "The node service light state (True = on).", + MarkdownDescription: "The node service light state (True = on).", + Computed: true, + }, + }, + }, + "smartfail": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "smartfailed": schema.BoolAttribute{ + Description: "This node is smartfailed (soft_devs).", + MarkdownDescription: "This node is smartfailed (soft_devs).", + Computed: true, + }, + }, + }, + }, + }, + "status": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "batterystatus": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "last_test_time1": schema.StringAttribute{ + Description: "The last battery test time for battery 1.", + MarkdownDescription: "The last battery test time for battery 1.", + Computed: true, + }, + "last_test_time2": schema.StringAttribute{ + Description: "The last battery test time for battery 2.", + MarkdownDescription: "The last battery test time for battery 2.", + Computed: true, + }, + "next_test_time1": schema.StringAttribute{ + Description: "The next checkup for battery 1.", + MarkdownDescription: "The next checkup for battery 1.", + Computed: true, + }, + "next_test_time2": schema.StringAttribute{ + Description: "The next checkup for battery 2.", + MarkdownDescription: "The next checkup for battery 2.", + Computed: true, + }, + "present": schema.BoolAttribute{ + Description: "Node has battery status.", + MarkdownDescription: "Node has battery status.", + Computed: true, + }, + "result1": schema.StringAttribute{ + Description: "The result of the last battery test for battery 1.", + MarkdownDescription: "The result of the last battery test for battery 1.", + Computed: true, + }, + "result2": schema.StringAttribute{ + Description: "The result of the last battery test for battery 2.", + MarkdownDescription: "The result of the last battery test for battery 2.", + Computed: true, + }, + "status1": schema.StringAttribute{ + Description: "The status of battery 1.", + MarkdownDescription: "The status of battery 1.", + Computed: true, + }, + "status2": schema.StringAttribute{ + Description: "The status of battery 2.", + MarkdownDescription: "The status of battery 2.", + Computed: true, + }, + "supported": schema.BoolAttribute{ + Description: "Node supports battery status.", + MarkdownDescription: "Node supports battery status.", + Computed: true, + }, + }, + }, + "capacity": schema.ListNestedAttribute{ + Description: "Storage capacity of this node.", + MarkdownDescription: "Storage capacity of this node.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "bytes": schema.Int64Attribute{ + Description: "Total device storage bytes.", + MarkdownDescription: "Total device storage bytes.", + Computed: true, + }, + "count": schema.Int64Attribute{ + Description: "Total device count.", + MarkdownDescription: "Total device count.", + Computed: true, + }, + "type": schema.StringAttribute{ + Description: "Device type.", + MarkdownDescription: "Device type.", + Computed: true, + }, + }, + }, + }, + "cpu": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "model": schema.StringAttribute{ + Description: "Manufacturer model description of this CPU.", + MarkdownDescription: "Manufacturer model description of this CPU.", + Computed: true, + }, + "overtemp": schema.StringAttribute{ + Description: "CPU overtemp state.", + MarkdownDescription: "CPU overtemp state.", + Computed: true, + }, + "proc": schema.StringAttribute{ + Description: "Type of processor and core of this CPU.", + MarkdownDescription: "Type of processor and core of this CPU.", + Computed: true, + }, + "speed_limit": schema.StringAttribute{ + Description: "CPU throttling (expressed as a percentage).", + MarkdownDescription: "CPU throttling (expressed as a percentage).", + Computed: true, + }, + }, + }, + "nvram": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "batteries": schema.ListNestedAttribute{ + Description: "This node's NVRAM battery status information.", + MarkdownDescription: "This node's NVRAM battery status information.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "color": schema.StringAttribute{ + Description: "The current status color of the NVRAM battery.", + MarkdownDescription: "The current status color of the NVRAM battery.", + Computed: true, + }, + "id": schema.Int64Attribute{ + Description: "Identifying index for the NVRAM battery.", + MarkdownDescription: "Identifying index for the NVRAM battery.", + Computed: true, + }, + "status": schema.StringAttribute{ + Description: "The current status message of the NVRAM battery.", + MarkdownDescription: "The current status message of the NVRAM battery.", + Computed: true, + }, + "voltage": schema.StringAttribute{ + Description: "The current voltage of the NVRAM battery.", + MarkdownDescription: "The current voltage of the NVRAM battery.", + Computed: true, + }, + }, + }, + }, + "battery_count": schema.Int64Attribute{ + Description: "This node's NVRAM battery count. On failure: -1, otherwise 1 or 2.", + MarkdownDescription: "This node's NVRAM battery count. On failure: -1, otherwise 1 or 2.", + Computed: true, + }, + "charge_status": schema.StringAttribute{ + Description: "This node's NVRAM battery charge status, as a color.", + MarkdownDescription: "This node's NVRAM battery charge status, as a color.", + Computed: true, + }, + "charge_status_number": schema.Int64Attribute{ + Description: "This node's NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3.", + MarkdownDescription: "This node's NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3.", + Computed: true, + }, + "device": schema.StringAttribute{ + Description: "This node's NVRAM device name with path.", + MarkdownDescription: "This node's NVRAM device name with path.", + Computed: true, + }, + "present": schema.BoolAttribute{ + Description: "This node has NVRAM.", + MarkdownDescription: "This node has NVRAM.", + Computed: true, + }, + "present_flash": schema.BoolAttribute{ + Description: "This node has NVRAM with flash storage.", + MarkdownDescription: "This node has NVRAM with flash storage.", + Computed: true, + }, + "present_size": schema.Int64Attribute{ + Description: "The size of the NVRAM, in bytes.", + MarkdownDescription: "The size of the NVRAM, in bytes.", + Computed: true, + }, + "present_type": schema.StringAttribute{ + Description: "This node's NVRAM type.", + MarkdownDescription: "This node's NVRAM type.", + Computed: true, + }, + "ship_mode": schema.Int64Attribute{ + Description: "This node's current ship mode state for NVRAM batteries. If not supported or on failure: -1. Disabled: 0. Enabled: 1.", + MarkdownDescription: "This node's current ship mode state for NVRAM batteries. If not supported or on failure: -1. Disabled: 0. Enabled: 1.", + Computed: true, + }, + "supported": schema.BoolAttribute{ + Description: "This node supports NVRAM.", + MarkdownDescription: "This node supports NVRAM.", + Computed: true, + }, + "supported_flash": schema.BoolAttribute{ + Description: "This node supports NVRAM with flash storage.", + MarkdownDescription: "This node supports NVRAM with flash storage.", + Computed: true, + }, + "supported_size": schema.Int64Attribute{ + Description: "The maximum size of the NVRAM, in bytes.", + MarkdownDescription: "The maximum size of the NVRAM, in bytes.", + Computed: true, + }, + "supported_type": schema.StringAttribute{ + Description: "This node's supported NVRAM type.", + MarkdownDescription: "This node's supported NVRAM type.", + Computed: true, + }, + }, + }, + "powersupplies": schema.SingleNestedAttribute{ + Description: " //", + MarkdownDescription: " //", + Computed: true, + Attributes: map[string]schema.Attribute{ + "count": schema.Int64Attribute{ + Description: "Count of how many power supplies are supported.", + MarkdownDescription: "Count of how many power supplies are supported.", + Computed: true, + }, + "failures": schema.Int64Attribute{ + Description: "Count of how many power supplies have failed.", + MarkdownDescription: "Count of how many power supplies have failed.", + Computed: true, + }, + "has_cff": schema.BoolAttribute{ + Description: "Does this node have a CFF power supply.", + MarkdownDescription: "Does this node have a CFF power supply.", + Computed: true, + }, + "status": schema.StringAttribute{ + Description: "A descriptive status string for this node's power supplies.", + MarkdownDescription: "A descriptive status string for this node's power supplies.", + Computed: true, + }, + "supplies": schema.ListNestedAttribute{ + Description: "List of this node's power supplies.", + MarkdownDescription: "List of this node's power supplies.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "chassis": schema.Int64Attribute{ + Description: "Which node chassis is this power supply in.", + MarkdownDescription: "Which node chassis is this power supply in.", + Computed: true, + }, + "firmware": schema.StringAttribute{ + Description: "The current firmware revision of this power supply.", + MarkdownDescription: "The current firmware revision of this power supply.", + Computed: true, + }, + "good": schema.StringAttribute{ + Description: "Is this power supply in a failure state.", + MarkdownDescription: "Is this power supply in a failure state.", + Computed: true, + }, + "id": schema.Int64Attribute{ + Description: "Identifying index for this power supply.", + MarkdownDescription: "Identifying index for this power supply.", + Computed: true, + }, + "name": schema.StringAttribute{ + Description: "Complete identifying string for this power supply.", + MarkdownDescription: "Complete identifying string for this power supply.", + Computed: true, + }, + "status": schema.StringAttribute{ + Description: "A descriptive status string for this power supply.", + MarkdownDescription: "A descriptive status string for this power supply.", + Computed: true, + }, + "type": schema.StringAttribute{ + Description: "The type of this power supply.", + MarkdownDescription: "The type of this power supply.", + Computed: true, + }, + }, + }, + }, + "supports_cff": schema.BoolAttribute{ + Description: "Does this node support CFF power supplies.", + MarkdownDescription: "Does this node support CFF power supplies.", + Computed: true, + }, + }, + }, + "release": schema.StringAttribute{ + Description: "OneFS release.", + MarkdownDescription: "OneFS release.", + Computed: true, + }, + "uptime": schema.Int64Attribute{ + Description: "Seconds this node has been online.", + MarkdownDescription: "Seconds this node has been online.", + Computed: true, + }, + "version": schema.StringAttribute{ + Description: "OneFS version.", + MarkdownDescription: "OneFS version.", + Computed: true, + }, + }, + }, + }, + }, + }, + "total": schema.Int64Attribute{ + Description: "The total number of nodes responding.", + MarkdownDescription: "The total number of nodes responding.", + Computed: true, + }, + }, + } + return attribute +} + +// GetClusterInternalNetworksSchema get cluster internal network schema +func GetClusterInternalNetworksSchema() schema.Attribute { + networks := schema.SingleNestedAttribute{ + // This description is used by the documentation generator and the language server. + MarkdownDescription: "V7ClusterInternalNetworks Configuration fields for internal networks.", + Description: "V7ClusterInternalNetworks Configuration fields for internal networks.", + Computed: true, + Attributes: map[string]schema.Attribute{ + "failover_ip_addresses": schema.ListNestedAttribute{ + Description: "Array of IP address ranges to be used to configure the internal failover network of the OneFS cluster.", + MarkdownDescription: "Array of IP address ranges to be used to configure the internal failover network of the OneFS cluster.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "high": schema.StringAttribute{ + Description: "IPv4 address in the format: xxx.xxx.xxx.xxx", + MarkdownDescription: "IPv4 address in the format: xxx.xxx.xxx.xxx", + Computed: true, + }, + "low": schema.StringAttribute{ + Description: "IPv4 address in the format: xxx.xxx.xxx.xxx", + MarkdownDescription: "IPv4 address in the format: xxx.xxx.xxx.xxx", + Computed: true, + }, + }, + }, + }, + "failover_status": schema.StringAttribute{ + Description: "Status of failover network.", + MarkdownDescription: "Status of failover network.", + Computed: true, + }, + "int_a_fabric": schema.StringAttribute{ + Description: "Network fabric used for the primary network int-a.", + MarkdownDescription: "Network fabric used for the primary network int-a.", + Computed: true, + }, + "int_a_ip_addresses": schema.ListNestedAttribute{ + Description: "Array of IP address ranges to be used to configure the internal int-a network of the OneFS cluster.", + MarkdownDescription: "Array of IP address ranges to be used to configure the internal int-a network of the OneFS cluster.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "high": schema.StringAttribute{ + Description: "IPv4 address in the format: xxx.xxx.xxx.xxx", + MarkdownDescription: "IPv4 address in the format: xxx.xxx.xxx.xxx", + Computed: true, + }, + "low": schema.StringAttribute{ + Description: "IPv4 address in the format: xxx.xxx.xxx.xxx", + MarkdownDescription: "IPv4 address in the format: xxx.xxx.xxx.xxx", + Computed: true, + }, + }, + }, + }, + "int_a_mtu": schema.Int64Attribute{ + Description: "Maximum Transfer Unit (MTU) of the primary network int-a.", + MarkdownDescription: "Maximum Transfer Unit (MTU) of the primary network int-a.", + Computed: true, + }, + "int_a_prefix_length": schema.Int64Attribute{ + Description: "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + MarkdownDescription: "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + Computed: true, + }, + "int_a_status": schema.StringAttribute{ + Description: "Status of the primary network int-a.", + MarkdownDescription: "Status of the primary network int-a.", + Computed: true, + }, + "int_b_fabric": schema.StringAttribute{ + Description: "Network fabric used for the failover network.", + MarkdownDescription: "Network fabric used for the failover network.", + Computed: true, + }, + "int_b_ip_addresses": schema.ListNestedAttribute{ + Description: "Array of IP address ranges to be used to configure the internal int-b network of the OneFS cluster.", + MarkdownDescription: "Array of IP address ranges to be used to configure the internal int-b network of the OneFS cluster.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "high": schema.StringAttribute{ + Description: "IPv4 address in the format: xxx.xxx.xxx.xxx", + MarkdownDescription: "IPv4 address in the format: xxx.xxx.xxx.xxx", + Computed: true, + }, + "low": schema.StringAttribute{ + Description: "IPv4 address in the format: xxx.xxx.xxx.xxx", + MarkdownDescription: "IPv4 address in the format: xxx.xxx.xxx.xxx", + Computed: true, + }, + }, + }, + }, + "int_b_mtu": schema.Int64Attribute{ + Description: "Maximum Transfer Unit (MTU) of the failover network int-b.", + MarkdownDescription: "Maximum Transfer Unit (MTU) of the failover network int-b.", + Computed: true, + }, + "int_b_prefix_length": schema.Int64Attribute{ + Description: "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + MarkdownDescription: "Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask.", + Computed: true, + }, + }, + } + return networks +} + +// GetClusterConfig retrieve the cluster information +func GetClusterConfig(ctx context.Context, client *client.Client) (*powerscale.V3ClusterConfig, error) { + config, _, err := client.PscaleOpenAPIClient.ClusterApi.GetClusterv3ClusterConfig(ctx).Execute() + return config, err +} + +// GetClusterIdentity retrieve the login information +func GetClusterIdentity(ctx context.Context, client *client.Client) (*powerscale.V1ClusterIdentity, error) { + identity, _, err := client.PscaleOpenAPIClient.ClusterApi.GetClusterv3ClusterIdentity(ctx).Execute() + return identity, err +} + +// GetClusterNodes list the nodes on this cluster +func GetClusterNodes(ctx context.Context, client *client.Client) (*powerscale.V3ClusterNodes, error) { + nodes, _, err := client.PscaleOpenAPIClient.ClusterApi.GetClusterv3ClusterNodes(ctx).Execute() + return nodes, err +} + +// GetClusterInternalNetworks list internal networks settings +func GetClusterInternalNetworks(ctx context.Context, client *client.Client) (*powerscale.V7ClusterInternalNetworks, error) { + networks, _, err := client.PscaleOpenAPIClient.ClusterApi.GetClusterv7ClusterInternalNetworks(ctx).Execute() + return networks, err +} diff --git a/powerscale/helper/helper.go b/powerscale/helper/helper.go index b5bed4db..0413e762 100644 --- a/powerscale/helper/helper.go +++ b/powerscale/helper/helper.go @@ -19,7 +19,7 @@ package helper import ( "context" - "dell/powerscale-go-client" + powerscale "dell/powerscale-go-client" "encoding/json" "fmt" "math/big" @@ -98,9 +98,53 @@ func CopyFields(ctx context.Context, source, destination interface{}) error { case reflect.Bool: destinationFieldValue = types.BoolValue(sourceField.Bool()) case reflect.Array, reflect.Slice: - destinationFieldValue = copySliceToTargetField(ctx, sourceField.Interface()) + if destinationField.Type().Kind() == reflect.Slice { + arr := reflect.ValueOf(sourceField.Interface()) + slice := reflect.MakeSlice(destinationField.Type(), arr.Len(), arr.Cap()) + for index := 0; index < arr.Len(); index++ { + value := arr.Index(index) + v := slice.Index(index) + switch v.Kind() { + case reflect.Ptr: + newDes := reflect.New(v.Type().Elem()).Interface() + err := CopyFields(ctx, value.Interface(), newDes) + if err != nil { + return err + } + slice.Index(index).Set(reflect.ValueOf(newDes)) + case reflect.Struct: + newDes := reflect.New(v.Type()).Interface() + err := CopyFields(ctx, value.Interface(), newDes) + if err != nil { + return err + } + slice.Index(index).Set(reflect.ValueOf(newDes).Elem()) + } + } + destinationField.Set(slice) + } else { + destinationFieldValue = copySliceToTargetField(ctx, sourceField.Interface()) + } case reflect.Struct: // placeholder for improvement, need to consider both go struct and types.Object + switch destinationField.Kind() { + case reflect.Ptr: + newDes := reflect.New(destinationField.Type().Elem()).Interface() + err := CopyFields(ctx, sourceField.Interface(), newDes) + if err != nil { + return err + } + destinationField.Set(reflect.ValueOf(newDes)) + case reflect.Struct: + newDes := reflect.New(destinationField.Type()).Interface() + err := CopyFields(ctx, sourceField.Interface(), newDes) + if err != nil { + return err + } + destinationField.Set(reflect.ValueOf(newDes).Elem()) + } + continue + default: tflog.Error(ctx, "unsupported source field type", map[string]interface{}{ "sourceField": sourceField, diff --git a/powerscale/models/access_zone.go b/powerscale/models/access_zone.go index 2dc8a0bb..60ff4698 100644 --- a/powerscale/models/access_zone.go +++ b/powerscale/models/access_zone.go @@ -82,3 +82,44 @@ type V1AuthAccessAccessItemFileGroup struct { type AccessZoneFilterType struct { Names []types.String `tfsdk:"names"` } + +// AccessZoneResourceModel describes the resource data model. +type AccessZoneResourceModel struct { + ID types.String `tfsdk:"id"` + // Specifies an alternate system provider. + AlternateSystemProvider types.String `tfsdk:"alternate_system_provider"` + // An Optional user modifiable list to add new custome auth providers + CustomAuthProviders types.List `tfsdk:"custom_auth_providers"` + // Specifies the list of authentication providers available on this access zone. + AuthProviders types.List `tfsdk:"auth_providers"` + // Specifies amount of time in seconds to cache a user/group. + CacheEntryExpiry types.Int64 `tfsdk:"cache_entry_expiry"` + // Determines if a path is created when a path does not exist. + CreatePath types.Bool `tfsdk:"create_path"` + // Groupnet identifier + Groupnet types.String `tfsdk:"groupnet"` + // Specifies the permissions set on automatically created user home directories. + HomeDirectoryUmask types.Int64 `tfsdk:"home_directory_umask"` + // Specifies a list of users and groups that have read and write access to /ifs. + IfsRestricted types.List `tfsdk:"ifs_restricted"` + // Maps untrusted domains to this NetBIOS domain during authentication. + MapUntrusted types.String `tfsdk:"map_untrusted"` + // Specifies the access zone name. + Name types.String `tfsdk:"name"` + // Specifies number of seconds the negative cache entry is valid. + NegativeCacheEntryExpiry types.Int64 `tfsdk:"negative_cache_entry_expiry"` + // Specifies the NetBIOS name. + NetbiosName types.String `tfsdk:"netbios_name"` + // Specifies the access zone base directory path. + Path types.String `tfsdk:"path"` + // Specifies the skeleton directory that is used for user home directories. + SkeletonDirectory types.String `tfsdk:"skeleton_directory"` + // True if the access zone is built-in. + System types.Bool `tfsdk:"system"` + // Specifies the system provider for the access zone. + SystemProvider types.String `tfsdk:"system_provider"` + // Specifies the current ID mapping rules. + UserMappingRules types.List `tfsdk:"user_mapping_rules"` + // Specifies the access zone ID on the system. + ZoneID types.Int64 `tfsdk:"zone_id"` +} diff --git a/powerscale/models/cluster.go b/powerscale/models/cluster.go new file mode 100644 index 00000000..0d6865e9 --- /dev/null +++ b/powerscale/models/cluster.go @@ -0,0 +1,544 @@ +package models + +import "github.com/hashicorp/terraform-plugin-framework/types" + +// ClusterDataSource returns the overall cluster details +type ClusterDataSource struct { + ID types.String `tfsdk:"id"` + Config *ClusterConfig `tfsdk:"config"` + Identity *ClusterIdentity `tfsdk:"identity"` + Nodes *ClusterNodes `tfsdk:"nodes"` + InternalNetworks *ClusterInternalNetworks `tfsdk:"internal_networks"` +} + +// ClusterConfig returns the configuration information of cluster. +type ClusterConfig struct { + Description types.String `tfsdk:"description"` + Devices []*ClusterConfigDevice `tfsdk:"devices"` + GUID types.String `tfsdk:"guid"` + JoinMode types.String `tfsdk:"join_mode"` + LocalDevID types.Int64 `tfsdk:"local_devid"` + LocalLnn types.Int64 `tfsdk:"local_lnn"` + LocalSerial types.String `tfsdk:"local_serial"` + Name types.String `tfsdk:"name"` + OnefsVersion *ClusterConfigOnefsVersion `tfsdk:"onefs_version"` + Timezone *ClusterConfigTimezone `tfsdk:"timezone"` +} + +// ClusterConfigOnefsVersion struct for ClusterConfigOnefsVersion +type ClusterConfigOnefsVersion struct { + // OneFS build string. + Build types.String `tfsdk:"build"` + // Kernel release number. + Release types.String `tfsdk:"release"` + // OneFS build number. + Revision types.String `tfsdk:"revision"` + // Kernel release type. + Type types.String `tfsdk:"type"` + // Kernel full version information. + Version types.String `tfsdk:"version"` +} + +// ClusterConfigTimezone The cluster timezone settings. +type ClusterConfigTimezone struct { + // Timezone abbreviation. + Abbreviation types.String `tfsdk:"abbreviation"` + // Customer timezone information. + Custom types.String `tfsdk:"custom"` + // Timezone full name. + Name types.String `tfsdk:"name"` + // Timezone hierarchical name. + Path types.String `tfsdk:"path"` +} + +// ClusterConfigDevice refers to device information of a cluster +type ClusterConfigDevice struct { + // Device ID. + DevID types.Int64 `tfsdk:"devid"` + // Device GUID. + GUID types.String `tfsdk:"guid"` + // If true, this node is online and communicating with the local node and every other node with the is_up property normally. + // If false, this node is not currently communicating with the local node or other nodes with the is_up property. + // It may be shut down, rebooting, disconnected from the backend network, or connected only to other nodes. + IsUp types.Bool `tfsdk:"is_up"` + // Device logical node number. + Lnn types.Int64 `tfsdk:"lnn"` +} + +// ClusterIdentity Unprivileged cluster information for display when logging in. +type ClusterIdentity struct { + // A description of the cluster. + Description types.String `tfsdk:"description"` + // Logon information + Logon ClusterIdentityLogon `tfsdk:"logon"` + // The name of the cluster. + Name types.String `tfsdk:"name"` +} + +// ClusterIdentityLogon The information displayed when a user logs in to the cluster. +type ClusterIdentityLogon struct { + // The message of the day. + Motd types.String `tfsdk:"motd"` + // The header to the message of the day. + MotdHeader types.String `tfsdk:"motd_header"` +} + +// ClusterNodes struct for ClusterNodes +type ClusterNodes struct { + // A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors. + Errors []NodeStatusError `tfsdk:"errors"` + // The responses from the individual nodes involved in this request. + Nodes []ClusterNode `tfsdk:"nodes"` + // The total number of nodes responding. + Total types.Int64 `tfsdk:"total"` +} + +// NodeStatusError An object describing a single error. +type NodeStatusError struct { + // The error code. + Code types.String `tfsdk:"code"` + // The field with the error if applicable. + Field types.String `tfsdk:"field"` + // Node ID (Device Number) of a node. + ID types.Int64 `tfsdk:"id"` + // Logical Node Number (LNN) of a node. + Lnn types.Int64 `tfsdk:"lnn"` + // The error message. + Message types.String `tfsdk:"message"` + // HTTP Status code returned by this node. + Status types.Int64 `tfsdk:"status"` +} + +// ClusterNode Node information. +type ClusterNode struct { + // List of the drives in this node. + Drives []ClusterNodeDrive `tfsdk:"drives"` + // Error message, if the HTTP status returned from this node was not 200. + Error types.String `tfsdk:"error"` + // Cluster node hardware + Hardware *ClusterNodeHardware `tfsdk:"hardware"` + // Node ID (Device Number) of a node. + ID types.Int64 `tfsdk:"id"` + // Logical Node Number (LNN) of a node. + Lnn types.Int64 `tfsdk:"lnn"` + // + Partitions *ClusterNodePartitions `tfsdk:"partitions"` + // + Sensors *ClusterNodeSensors `tfsdk:"sensors"` + // + State *ClusterNodeState `tfsdk:"state"` + // + Status *ClusterNodeStatus `tfsdk:"status"` +} + +// ClusterNodeDrive Drive information. +type ClusterNodeDrive struct { + // Numerical representation of this drive's bay. + Baynum types.Int64 `tfsdk:"baynum"` + // Number of blocks on this drive. + Blocks types.Int64 `tfsdk:"blocks"` + // The chassis number which contains this drive. + Chassis types.Int64 `tfsdk:"chassis"` + // This drive's device name. + Devname types.String `tfsdk:"devname"` + // Drive firmware information + Firmware *ClusterNodeDriveFirmware `tfsdk:"firmware"` + // Drive_d's handle representation for this driveIf we fail to retrieve the handle for this drive from drive_d: -1 + Handle types.Int64 `tfsdk:"handle"` + // String representation of this drive's interface type. + InterfaceType types.String `tfsdk:"interface_type"` + // This drive's logical drive number in IFS. + Lnum types.Int64 `tfsdk:"lnum"` + // String representation of this drive's physical location. + Locnstr types.String `tfsdk:"locnstr"` + // Size of a logical block on this drive. + LogicalBlockLength types.Int64 `tfsdk:"logical_block_length"` + // String representation of this drive's media type. + MediaType types.String `tfsdk:"media_type"` + // This drive's manufacturer and model. + Model types.String `tfsdk:"model"` + // Size of a physical block on this drive. + PhysicalBlockLength types.Int64 `tfsdk:"physical_block_length"` + // Indicates whether this drive is physically present in the node. + Present types.Bool `tfsdk:"present"` + // This drive's purpose in the DRV state machine. + Purpose types.String `tfsdk:"purpose"` + // Description of this drive's purpose. + PurposeDescription types.String `tfsdk:"purpose_description"` + // Serial number for this drive. + Serial types.String `tfsdk:"serial"` + // This drive's state as presented to the UI. + UIState types.String `tfsdk:"ui_state"` + // The drive's 'worldwide name' from its NAA identifiers. + Wwn types.String `tfsdk:"wwn"` + // This drive's x-axis grid location. + XLoc types.Int64 `tfsdk:"x_loc"` + // This drive's y-axis grid location. + YLoc types.Int64 `tfsdk:"y_loc"` +} + +// ClusterNodeDriveFirmware Drive firmware information. +type ClusterNodeDriveFirmware struct { + // This drive's current firmware revision + CurrentFirmware types.String `tfsdk:"current_firmware"` + // This drive's desired firmware revision. + DesiredFirmware types.String `tfsdk:"desired_firmware"` +} + +// ClusterNodeHardware Node hardware identifying information (static). +type ClusterNodeHardware struct { + // Name of this node's chassis. + Chassis types.String `tfsdk:"chassis"` + // Chassis code of this node (1U, 2U, etc.). + ChassisCode types.String `tfsdk:"chassis_code"` + // Number of chassis making up this node. + ChassisCount types.String `tfsdk:"chassis_count"` + // Class of this node (storage, accelerator, etc.). + Class types.String `tfsdk:"class"` + // Node configuration ID. + ConfigurationID types.String `tfsdk:"configuration_id"` + // Manufacturer and model of this node's CPU. + CPU types.String `tfsdk:"cpu"` + // Manufacturer and model of this node's disk controller. + DiskController types.String `tfsdk:"disk_controller"` + // Manufacturer and model of this node's disk expander. + DiskExpander types.String `tfsdk:"disk_expander"` + // Family code of this node (X, S, NL, etc.). + FamilyCode types.String `tfsdk:"family_code"` + // Manufacturer, model, and device id of this node's flash drive. + FlashDrive types.String `tfsdk:"flash_drive"` + // Generation code of this node. + GenerationCode types.String `tfsdk:"generation_code"` + // PowerScale hardware generation name. + Hwgen types.String `tfsdk:"hwgen"` + // Version of this node's PowerScale Management Board. + ImbVersion types.String `tfsdk:"imb_version"` + // Infiniband card type. + Infiniband types.String `tfsdk:"infiniband"` + // Version of the LCD panel. + LcdVersion types.String `tfsdk:"lcd_version"` + // Manufacturer and model of this node's motherboard. + Motherboard types.String `tfsdk:"motherboard"` + // Description of all this node's network interfaces. + NetInterfaces types.String `tfsdk:"net_interfaces"` + // Manufacturer and model of this node's NVRAM board. + Nvram types.String `tfsdk:"nvram"` + // Description strings for each power supply on this node. + Powersupplies types.List `tfsdk:"powersupplies"` + // Number of processors and cores on this node. + Processor types.String `tfsdk:"processor"` + // PowerScale product name. + Product types.String `tfsdk:"product"` + // Size of RAM in bytes. + RAM types.Int64 `tfsdk:"ram"` + // Serial number of this node. + SerialNumber types.String `tfsdk:"serial_number"` + // Series of this node (X, I, NL, etc.). + Series types.String `tfsdk:"series"` + // Storage class of this node (storage or diskless). + StorageClass types.String `tfsdk:"storage_class"` +} + +// ClusterNodePartitions Node partition information. +type ClusterNodePartitions struct { + // Count of how many partitions are included. + Count types.Int64 `tfsdk:"count"` + // Partition information. + Partitions []ClusterNodePartition `tfsdk:"partitions"` +} + +// ClusterNodePartition Node partition information. +type ClusterNodePartition struct { + // The block size used for the reported partition information. + BlockSize types.Int64 `tfsdk:"block_size"` + // Total blocks on this file system partition. + Capacity types.Int64 `tfsdk:"capacity"` + // Comma separated list of devices used for this file system partition. + ComponentDevices types.String `tfsdk:"component_devices"` + // Directory on which this partition is mounted. + MountPoint types.String `tfsdk:"mount_point"` + // Used blocks on this file system partition, expressed as a percentage. + PercentUsed types.String `tfsdk:"percent_used"` + // + Statfs *ClusterNodePartitionStatfs `tfsdk:"statfs"` + // Used blocks on this file system partition. + Used types.Int64 `tfsdk:"used"` +} + +// ClusterNodePartitionStatfs System partition details as provided by statfs(2). +type ClusterNodePartitionStatfs struct { + // Free blocks available to non-superuser on this partition. + FBavail types.Int64 `tfsdk:"f_bavail"` + // Free blocks on this partition. + FBfree types.Int64 `tfsdk:"f_bfree"` + // Total data blocks on this partition. + FBlocks types.Int64 `tfsdk:"f_blocks"` + // Filesystem fragment size; block size in OneFS. + FBsize types.Int64 `tfsdk:"f_bsize"` + // Free file nodes avail to non-superuser. + FFfree types.Int64 `tfsdk:"f_ffree"` + // Total file nodes in filesystem. + FFiles types.Int64 `tfsdk:"f_files"` + // Mount exported flags. + FFlags types.Int64 `tfsdk:"f_flags"` + // File system type name. + FFstypename types.String `tfsdk:"f_fstypename"` + // Optimal transfer block size. + FIosize types.Int64 `tfsdk:"f_iosize"` + // Names of devices this partition is mounted from. + FMntfromname types.String `tfsdk:"f_mntfromname"` + // Directory this partition is mounted to. + FMntonname types.String `tfsdk:"f_mntonname"` + // Maximum filename length. + FNamemax types.Int64 `tfsdk:"f_namemax"` + // UID of user that mounted the filesystem. + FOwner types.Int64 `tfsdk:"f_owner"` + // Type of filesystem. + FType types.Int64 `tfsdk:"f_type"` + // statfs() structure version number. + FVersion types.Int64 `tfsdk:"f_version"` +} + +// ClusterNodeSensors Node sensor information (hardware reported). +type ClusterNodeSensors struct { + // This node's sensor information. + Sensors []ClusterNodeSensor `tfsdk:"sensors"` +} + +// ClusterNodeSensor Node sensor information. +type ClusterNodeSensor struct { + // The count of values in this sensor group. + Count types.Int64 `tfsdk:"count"` + // The name of this sensor group. + Name types.String `tfsdk:"name"` + // The list of specific sensor value info in this sensor group. + Values []ClusterNodeSensorValue `tfsdk:"values"` +} + +// ClusterNodeSensorValue Specific sensor value info. +type ClusterNodeSensorValue struct { + // The descriptive name of this sensor. + Desc types.String `tfsdk:"desc"` + // The identifier name of this sensor. + Name types.String `tfsdk:"name"` + // The units of this sensor. + Units types.String `tfsdk:"units"` + // The value of this sensor. + Value types.String `tfsdk:"value"` +} + +// ClusterNodeState Node state information (reported and modifiable). +type ClusterNodeState struct { + // + Readonly ClusterNodeStateReadonly `tfsdk:"readonly"` + // + Servicelight ClusterNodeStateServicelight `tfsdk:"servicelight"` + // + Smartfail ClusterNodeStateSmartfail `tfsdk:"smartfail"` +} + +// ClusterNodeStateReadonly Node readonly state. +type ClusterNodeStateReadonly struct { + // The current read-only mode allowed status for the node. + Allowed types.Bool `tfsdk:"allowed"` + // The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared. + Enabled types.Bool `tfsdk:"enabled"` + // The current read-only mode status for the node. + Mode types.Bool `tfsdk:"mode"` + // The current read-only mode status description for the node. + Status types.String `tfsdk:"status"` + // The read-only state values are valid (False = Error). + Valid types.Bool `tfsdk:"valid"` + // The current read-only value (enumerated bitfield) for the node. + Value types.Int64 `tfsdk:"value"` +} + +// ClusterNodeStateServicelight Node service light state. +type ClusterNodeStateServicelight struct { + // The node service light state (True = on). + Enabled types.Bool `tfsdk:"enabled"` +} + +// ClusterNodeStatus Node status information (hardware reported). +type ClusterNodeStatus struct { + // + Batterystatus *ClusterNodeStatusBatterystatus `tfsdk:"batterystatus"` + // Storage capacity of this node. + Capacity []IsiClusterNodeStatusCapacityItem `tfsdk:"capacity"` + // + CPU *ClusterNodeStatusCPU `tfsdk:"cpu"` + // + Nvram *ClusterNodeStatusNvram `tfsdk:"nvram"` + // + Powersupplies *ClusterNodeStatusPowersupplies `tfsdk:"powersupplies"` + // OneFS release. + Release types.String `tfsdk:"release"` + // Seconds this node has been online. + Uptime types.Int64 `tfsdk:"uptime"` + // OneFS version. + Version types.String `tfsdk:"version"` +} + +// ClusterNodeStateSmartfail Node smartfail state. +type ClusterNodeStateSmartfail struct { + // This node is smartfailed (soft_devs). + Smartfailed types.Bool `tfsdk:"smartfailed"` +} + +// ClusterNodeStatusBatterystatus Battery status information. +type ClusterNodeStatusBatterystatus struct { + // The last battery test time for battery 1. + LastTestTime1 types.String `tfsdk:"last_test_time1"` + // The last battery test time for battery 2. + LastTestTime2 types.String `tfsdk:"last_test_time2"` + // The next checkup for battery 1. + NextTestTime1 types.String `tfsdk:"next_test_time1"` + // The next checkup for battery 2. + NextTestTime2 types.String `tfsdk:"next_test_time2"` + // Node has battery status. + Present types.Bool `tfsdk:"present"` + // The result of the last battery test for battery 1. + Result1 types.String `tfsdk:"result1"` + // The result of the last battery test for battery 2. + Result2 types.String `tfsdk:"result2"` + // The status of battery 1. + Status1 types.String `tfsdk:"status1"` + // The status of battery 2. + Status2 types.String `tfsdk:"status2"` + // Node supports battery status. + Supported types.Bool `tfsdk:"supported"` +} + +// IsiClusterNodeStatusCapacityItem Node capacity information. +type IsiClusterNodeStatusCapacityItem struct { + // Total device storage bytes. + Bytes types.Int64 `tfsdk:"bytes"` + // Total device count. + Count types.Int64 `tfsdk:"count"` + // Device type. + Type types.String `tfsdk:"type"` +} + +// ClusterNodeStatusCPU CPU status information for this node. +type ClusterNodeStatusCPU struct { + // Manufacturer model description of this CPU. + Model types.String `tfsdk:"model"` + // CPU overtemp state. + Overtemp types.String `tfsdk:"overtemp"` + // Type of processor and core of this CPU. + Proc types.String `tfsdk:"proc"` + // CPU throttling (expressed as a percentage). + SpeedLimit types.String `tfsdk:"speed_limit"` +} + +// ClusterNodeStatusNvram Node NVRAM information. +type ClusterNodeStatusNvram struct { + // This node's NVRAM battery status information. + Batteries []IsiClusterNodeStatusNvramBattery `tfsdk:"batteries"` + // This node's NVRAM battery count. On failure: -1, otherwise 1 or 2. + BatteryCount types.Int64 `tfsdk:"battery_count"` + // This node's NVRAM battery charge status, as a color. + ChargeStatus types.String `tfsdk:"charge_status"` + // This node's NVRAM battery charge status, as a number. Error or not supported: -1. BR_BLACK: 0. BR_GREEN: 1. BR_YELLOW: 2. BR_RED: 3. + ChargeStatusNumber types.Int64 `tfsdk:"charge_status_number"` + // This node's NVRAM device name with path. + Device types.String `tfsdk:"device"` + // This node has NVRAM. + Present types.Bool `tfsdk:"present"` + // This node has NVRAM with flash storage. + PresentFlash types.Bool `tfsdk:"present_flash"` + // The size of the NVRAM, in bytes. + PresentSize types.Int64 `tfsdk:"present_size"` + // This node's NVRAM type. + PresentType types.String `tfsdk:"present_type"` + // This node's current ship mode state for NVRAM batteries. If not supported or on failure: -1. Disabled: 0. Enabled: 1. + ShipMode types.Int64 `tfsdk:"ship_mode"` + // This node supports NVRAM. + Supported types.Bool `tfsdk:"supported"` + // This node supports NVRAM with flash storage. + SupportedFlash types.Bool `tfsdk:"supported_flash"` + // The maximum size of the NVRAM, in bytes. + SupportedSize types.Int64 `tfsdk:"supported_size"` + // This node's supported NVRAM type. + SupportedType types.String `tfsdk:"supported_type"` +} + +// ClusterNodeStatusPowersupplies Information about this node's power supplies. +type ClusterNodeStatusPowersupplies struct { + // Count of how many power supplies are supported. + Count types.Int64 `tfsdk:"count"` + // Count of how many power supplies have failed. + Failures types.Int64 `tfsdk:"failures"` + // Does this node have a CFF power supply. + HasCff types.Bool `tfsdk:"has_cff"` + // A descriptive status string for this node's power supplies. + Status types.String `tfsdk:"status"` + // List of this node's power supplies. + Supplies []IsiClusterNodeStatusPowersuppliesSupply `tfsdk:"supplies"` + // Does this node support CFF power supplies. + SupportsCff types.Bool `tfsdk:"supports_cff"` +} + +// IsiClusterNodeStatusNvramBattery NVRAM battery status information. +type IsiClusterNodeStatusNvramBattery struct { + // The current status color of the NVRAM battery. + Color types.String `tfsdk:"color"` + // Identifying index for the NVRAM battery. + ID types.Int64 `tfsdk:"id"` + // The current status message of the NVRAM battery. + Status types.String `tfsdk:"status"` + // The current voltage of the NVRAM battery. + Voltage types.String `tfsdk:"voltage"` +} + +// IsiClusterNodeStatusPowersuppliesSupply Power supply information. +type IsiClusterNodeStatusPowersuppliesSupply struct { + // Which node chassis is this power supply in. + Chassis types.Int64 `tfsdk:"chassis"` + // The current firmware revision of this power supply. + Firmware types.String `tfsdk:"firmware"` + // Is this power supply in a failure state. + Good types.String `tfsdk:"good"` + // Identifying index for this power supply. + ID types.Int64 `tfsdk:"id"` + // Complete identifying string for this power supply. + Name types.String `tfsdk:"name"` + // A descriptive status string for this power supply. + Status types.String `tfsdk:"status"` + // The type of this power supply. + Type types.String `tfsdk:"type"` +} + +// ClusterInternalNetworks Configuration fields for internal networks. +type ClusterInternalNetworks struct { + // Array of IP address ranges to be used to configure the internal failover network of the OneFS cluster. + FailoverIPAddresses []ClusterInternalNetworksFailoverIPAddresse `tfsdk:"failover_ip_addresses"` + // Status of failover network. + FailoverStatus types.String `tfsdk:"failover_status"` + // Network fabric used for the primary network int-a. + IntAFabric types.String `tfsdk:"int_a_fabric"` + // Array of IP address ranges to be used to configure the internal int-a network of the OneFS cluster. + IntAIpAddresses []ClusterInternalNetworksFailoverIPAddresse `tfsdk:"int_a_ip_addresses"` + // Maximum Transfer Unit (MTU) of the primary network int-a. + IntAMtu types.Int64 `tfsdk:"int_a_mtu"` + // Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask. + IntAPrefixLength types.Int64 `tfsdk:"int_a_prefix_length"` + // Status of the primary network int-a. + IntAStatus types.String `tfsdk:"int_a_status"` + // Network fabric used for the failover network. + IntBFabric types.String `tfsdk:"int_b_fabric"` + // Array of IP address ranges to be used to configure the internal int-b network of the OneFS cluster. + IntBIpAddresses []ClusterInternalNetworksFailoverIPAddresse `tfsdk:"int_b_ip_addresses"` + // Maximum Transfer Unit (MTU) of the failover network int-b. + IntBMtu types.Int64 `tfsdk:"int_b_mtu"` + // Prefixlen specifies the length of network bits used in an IP address. This field is the right-hand part of the CIDR notation representing the subnet mask. + IntBPrefixLength types.Int64 `tfsdk:"int_b_prefix_length"` +} + +// ClusterInternalNetworksFailoverIPAddresse Specifies range of IP addresses where 'low' is starting address and 'high' is the end address.' Both 'low' and 'high' addresses are inclusive to the range. +type ClusterInternalNetworksFailoverIPAddresse struct { + // IPv4 address in the format: xxx.xxx.xxx.xxx + High types.String `tfsdk:"high"` + // IPv4 address in the format: xxx.xxx.xxx.xxx + Low types.String `tfsdk:"low"` +} diff --git a/powerscale/provider/access_zone_datasource_test.go b/powerscale/provider/access_zone_datasource_test.go index 38ac9a3f..cb5318fd 100644 --- a/powerscale/provider/access_zone_datasource_test.go +++ b/powerscale/provider/access_zone_datasource_test.go @@ -25,7 +25,6 @@ import ( . "github.com/bytedance/mockey" "github.com/hashicorp/terraform-plugin-testing/helper/resource" - "github.com/hashicorp/terraform-plugin-testing/terraform" ) func TestAccAccessZoneDataSource(t *testing.T) { @@ -108,12 +107,6 @@ func TestAccAccessZoneDataSourceGetErr(t *testing.T) { ExpectError: regexp.MustCompile(`.*mock error*.`), }, }, - CheckDestroy: func(_ *terraform.State) error { - if FunctionMocker != nil { - FunctionMocker.UnPatch() - } - return nil - }, }) } diff --git a/powerscale/provider/access_zone_resource.go b/powerscale/provider/access_zone_resource.go new file mode 100644 index 00000000..7fc15cf8 --- /dev/null +++ b/powerscale/provider/access_zone_resource.go @@ -0,0 +1,419 @@ +/* +Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. + +Licensed under the Mozilla Public License Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package provider + +import ( + "context" + powerscale "dell/powerscale-go-client" + "fmt" + "terraform-provider-powerscale/client" + "terraform-provider-powerscale/powerscale/constants" + "terraform-provider-powerscale/powerscale/helper" + "terraform-provider-powerscale/powerscale/models" + + "github.com/hashicorp/terraform-plugin-framework/resource" + "github.com/hashicorp/terraform-plugin-framework/resource/schema" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/listdefault" + "github.com/hashicorp/terraform-plugin-framework/types" + "github.com/hashicorp/terraform-plugin-framework/types/basetypes" + "github.com/hashicorp/terraform-plugin-log/tflog" +) + +// Ensure provider defined types fully satisfy framework interfaces. +var _ resource.Resource = &AccessZoneResource{} +var _ resource.ResourceWithImportState = &AccessZoneResource{} + +// NewAccessZoneResource creates a new resource. +func NewAccessZoneResource() resource.Resource { + return &AccessZoneResource{} +} + +// AccessZoneResource defines the resource implementation. +type AccessZoneResource struct { + client *client.Client +} + +// Metadata describes the resource arguments. +func (r *AccessZoneResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) { + resp.TypeName = req.ProviderTypeName + "_accesszone" +} + +// Schema describes the resource arguments. +func (r *AccessZoneResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) { + resp.Schema = schema.Schema{ + // This description is used by the documentation generator and the language server. + MarkdownDescription: "Access Zone resource", + + Attributes: map[string]schema.Attribute{ + "alternate_system_provider": schema.StringAttribute{ + Description: "Specifies an alternate system provider.", + MarkdownDescription: "Specifies an alternate system provider.", + Computed: true, + }, + "custom_auth_providers": schema.ListAttribute{ + Description: "An optional parameter which adds new auth_providers to the access zone", + MarkdownDescription: "An optional parameter which adds new auth_providers to the access zone", + Optional: true, + Computed: true, + ElementType: types.StringType, + Default: listdefault.StaticValue(basetypes.NewListNull(types.StringType)), + }, + "auth_providers": schema.ListAttribute{ + Description: "Specifies the list of authentication providers available on this access zone.", + MarkdownDescription: "Specifies the list of authentication providers available on this access zone.", + Computed: true, + ElementType: types.StringType, + }, + "cache_entry_expiry": schema.Int64Attribute{ + Description: "Specifies amount of time in seconds to cache a user/group.", + MarkdownDescription: "Specifies amount of time in seconds to cache a user/group.", + Computed: true, + }, + "create_path": schema.BoolAttribute{ + Description: "Determines if a path is created when a path does not exist.", + MarkdownDescription: "Determines if a path is created when a path does not exist.", + Computed: true, + }, + "groupnet": schema.StringAttribute{ + Description: "Groupnet identifier", + MarkdownDescription: "Groupnet identifier", + Required: true, + }, + "home_directory_umask": schema.Int64Attribute{ + Description: "Specifies the permissions set on automatically created user home directories.", + MarkdownDescription: "Specifies the permissions set on automatically created user home directories.", + Computed: true, + }, + "id": schema.StringAttribute{ + Description: "Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method", + MarkdownDescription: "Specifies the system-assigned ID for the access zone. This value is returned when an access zone is created through the POST method", + Computed: true, + }, + "ifs_restricted": schema.ListNestedAttribute{ + Description: "Specifies a list of users and groups that have read and write access to /ifs.", + MarkdownDescription: "Specifies a list of users and groups that have read and write access to /ifs.", + Computed: true, + NestedObject: schema.NestedAttributeObject{ + Attributes: map[string]schema.Attribute{ + "id": schema.StringAttribute{ + Description: "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", + MarkdownDescription: "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", + Computed: true, + }, + "name": schema.StringAttribute{ + Description: "Specifies the persona name, which must be combined with a type.", + MarkdownDescription: "Specifies the persona name, which must be combined with a type.", + Computed: true, + }, + "type": schema.StringAttribute{ + Description: "Specifies the type of persona, which must be combined with a name.", + MarkdownDescription: "Specifies the type of persona, which must be combined with a name.", + Computed: true, + }, + }, + }, + }, + "map_untrusted": schema.StringAttribute{ + Description: "Maps untrusted domains to this NetBIOS domain during authentication.", + MarkdownDescription: "Maps untrusted domains to this NetBIOS domain during authentication.", + Computed: true, + }, + "name": schema.StringAttribute{ + Description: "Specifies the access zone name.", + MarkdownDescription: "Specifies the access zone name.", + Required: true, + }, + "negative_cache_entry_expiry": schema.Int64Attribute{ + Description: "Specifies number of seconds the negative cache entry is valid.", + MarkdownDescription: "Specifies number of seconds the negative cache entry is valid.", + Computed: true, + }, + "netbios_name": schema.StringAttribute{ + Description: "Specifies the NetBIOS name.", + MarkdownDescription: "Specifies the NetBIOS name.", + Computed: true, + }, + "path": schema.StringAttribute{ + Description: "Specifies the access zone base directory path.", + MarkdownDescription: "Specifies the access zone base directory path.", + Required: true, + }, + "skeleton_directory": schema.StringAttribute{ + Description: "Specifies the skeleton directory that is used for user home directories.", + MarkdownDescription: "Specifies the skeleton directory that is used for user home directories.", + Computed: true, + }, + "system": schema.BoolAttribute{ + Description: "True if the access zone is built-in.", + MarkdownDescription: "True if the access zone is built-in.", + Computed: true, + }, + "system_provider": schema.StringAttribute{ + Description: "Specifies the system provider for the access zone.", + MarkdownDescription: "Specifies the system provider for the access zone.", + Computed: true, + }, + "user_mapping_rules": schema.ListAttribute{ + Description: "Specifies the current ID mapping rules.", + MarkdownDescription: "Specifies the current ID mapping rules.", + Computed: true, + ElementType: types.StringType, + }, + "zone_id": schema.Int64Attribute{ + Description: "Specifies the access zone ID on the system.", + MarkdownDescription: "Specifies the access zone ID on the system.", + Computed: true, + }, + }, + } +} + +// Configure configures the resource. +func (r *AccessZoneResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) { + // Prevent panic if the provider has not been configured. + if req.ProviderData == nil { + return + } + + pscaleClient, ok := req.ProviderData.(*client.Client) + + if !ok { + resp.Diagnostics.AddError( + "Unexpected Data Source Configure Type", + fmt.Sprintf("Expected *http.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData), + ) + + return + } + + r.client = pscaleClient +} + +// Create allocates the resource. +func (r *AccessZoneResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) { + tflog.Info(ctx, "creating access zone") + var plan *models.AccessZoneResourceModel + var authProv []string + // Read Terraform plan data into the model + resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...) + + if resp.Diagnostics.HasError() { + + return + } + + resp.Diagnostics.Append(plan.CustomAuthProviders.ElementsAs(ctx, &authProv, false)...) + if resp.Diagnostics.HasError() { + return + } + for i, v := range authProv { + authProv[i] = "lsa-file-provider:" + v + } + + err := helper.CreateAccessZones(ctx, r.client, authProv, plan) + if err != nil { + errStr := constants.CreateAccessZoneErrorMsg + "with error: " + message := helper.GetErrorString(err, errStr) + resp.Diagnostics.AddError( + "Error creating access zone", + message, + ) + return + } + + zoneParam, err := helper.GetAllAccessZones(ctx, r.client) + if err != nil { + errStr := constants.ReadAccessZoneErrorMsg + "with error: " + message := helper.GetErrorString(err, errStr) + resp.Diagnostics.AddError( + "Error reading access zone", + message, + ) + return + } + + state, err := helper.GetSpecificZone(ctx, plan.Name.ValueString(), zoneParam.Zones) + + if err != nil { + resp.Diagnostics.AddError("Error reading access zone", err.Error()) + return + } + state.CustomAuthProviders = plan.CustomAuthProviders + resp.Diagnostics.Append(resp.State.Set(ctx, &state)...) +} + +// Read reads the resource state. +func (r *AccessZoneResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { + tflog.Info(ctx, "reading access zone") + var plan *models.AccessZoneResourceModel + + // Read Terraform prior state plan into the model + resp.Diagnostics.Append(req.State.Get(ctx, &plan)...) + + if resp.Diagnostics.HasError() { + return + } + + result, err := helper.GetAllAccessZones(ctx, r.client) + if err != nil { + errStr := constants.ReadAccessZoneErrorMsg + "with error: " + message := helper.GetErrorString(err, errStr) + resp.Diagnostics.AddError( + "Error reading access zone", + message, + ) + return + } + + state, err := helper.GetSpecificZone(ctx, plan.Name.ValueString(), result.Zones) + + if err != nil { + resp.Diagnostics.AddError("Error reading access zone", err.Error()) + return + } + + state.CustomAuthProviders = plan.CustomAuthProviders + // Save updated plan into Terraform state + resp.Diagnostics.Append(resp.State.Set(ctx, &state)...) +} + +// Update updates the resource state Path, Name, AuthProviders +func (r *AccessZoneResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { + tflog.Info(ctx, "updating access zone") + var plan *models.AccessZoneResourceModel + var state *models.AccessZoneResourceModel + + // Read Terraform plan data into the model + resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...) + + if resp.Diagnostics.HasError() { + return + } + + // Read the state + resp.Diagnostics.Append(req.State.Get(ctx, &state)...) + + if resp.Diagnostics.HasError() { + + return + } + // Populate the Edit Parameters + editValues := powerscale.V3ZoneExtendedExtended{} + if state.Path != plan.Path { + editValues.Path = plan.Path.ValueStringPointer() + } + if state.Name != plan.Name { + editValues.Name = plan.Name.ValueStringPointer() + } + if len(state.CustomAuthProviders.Elements()) != len(plan.CustomAuthProviders.Elements()) { + resp.Diagnostics.Append(plan.CustomAuthProviders.ElementsAs(ctx, &editValues.AuthProviders, false)...) + if resp.Diagnostics.HasError() { + return + } + for i, v := range editValues.AuthProviders { + editValues.AuthProviders[i] = "lsa-file-provider:" + v + } + } + editParam := r.client.PscaleOpenAPIClient.ZonesApi.UpdateZonesv3Zone(ctx, state.ID.ValueString()) + editParam = editParam.V3Zone(editValues) + + _, err := editParam.Execute() + if err != nil { + errStr := constants.UpdateAccessZoneErrorMsg + "with error: " + message := helper.GetErrorString(err, errStr) + resp.Diagnostics.AddError( + "Error editing access zone", + message, + ) + return + } + + result, err := helper.GetAllAccessZones(ctx, r.client) + if err != nil { + errStr := constants.ReadAccessZoneErrorMsg + "with error: " + message := helper.GetErrorString(err, errStr) + resp.Diagnostics.AddError( + "Error reading access zone", + message, + ) + return + } + + finalState, err := helper.GetSpecificZone(ctx, plan.Name.ValueString(), result.Zones) + finalState.CustomAuthProviders = plan.CustomAuthProviders + if err != nil { + resp.Diagnostics.AddError("Error reading access zone", err.Error()) + return + } + // Save updated data into Terraform state + resp.Diagnostics.Append(resp.State.Set(ctx, &finalState)...) +} + +// Delete deletes the resource. +func (r *AccessZoneResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { + tflog.Info(ctx, "deleting access zone") + var data *models.AccessZoneResourceModel + + // Read Terraform prior state data into the model + resp.Diagnostics.Append(req.State.Get(ctx, &data)...) + + if resp.Diagnostics.HasError() { + return + } + deleteParam := r.client.PscaleOpenAPIClient.ZonesApi.DeleteZonesv3Zone(ctx, data.ID.ValueString()) + _, err := deleteParam.Execute() + if err != nil { + errStr := constants.DeleteAccessZoneErrorMsg + "with error: " + message := helper.GetErrorString(err, errStr) + resp.Diagnostics.AddError( + "Error getting the list of access zones", + message, + ) + } +} + +// ImportState imports the resource state. +func (r *AccessZoneResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) { + tflog.Info(ctx, "importing access zone") + id := req.ID + result, err := helper.GetAllAccessZones(ctx, r.client) + if err != nil { + errStr := constants.ReadAccessZoneErrorMsg + "with error: " + message := helper.GetErrorString(err, errStr) + resp.Diagnostics.AddError( + "Error reading access zone", + message, + ) + return + } + state, err := helper.GetSpecificZone(ctx, id, result.Zones) + if err != nil { + resp.Diagnostics.AddError("Error reading access zone", err.Error()) + return + } + customAuthProviders, diags := helper.ExtractCustomAuthForInput(ctx, state.AuthProviders, state.Name.ValueString()) + + if diags.HasError() { + resp.Diagnostics.AddError("Unable to import access zone", "failed to extract custom providers") + } + state.CustomAuthProviders = customAuthProviders + resp.Diagnostics.Append(resp.State.Set(ctx, &state)...) + if resp.Diagnostics.HasError() { + return + } +} diff --git a/powerscale/provider/access_zone_resource_test.go b/powerscale/provider/access_zone_resource_test.go new file mode 100644 index 00000000..8bb11e70 --- /dev/null +++ b/powerscale/provider/access_zone_resource_test.go @@ -0,0 +1,259 @@ +/* +Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. + +Licensed under the Mozilla Public License Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package provider + +import ( + "fmt" + "regexp" + "terraform-provider-powerscale/powerscale/helper" + "testing" + + . "github.com/bytedance/mockey" + "github.com/hashicorp/terraform-plugin-testing/helper/resource" +) + +var mocker *Mocker +var createMocker *Mocker + +func TestAccAccessZoneA(t *testing.T) { + var accessZoneResourceName = "powerscale_accesszone.zone" + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Create and Read testing + { + Config: ProviderConfig + AccessZoneResourceConfig, + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr(accessZoneResourceName, "name", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "id", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "groupnet", "groupnet0"), + resource.TestCheckResourceAttr(accessZoneResourceName, "path", "/ifs"), + resource.TestCheckResourceAttr(accessZoneResourceName, "auth_providers.#", "2"), + ), + }, + // ImportState testing + { + ResourceName: accessZoneResourceName, + ImportState: true, + ImportStateVerify: true, + }, + // Update name, path and auth providers, then Read testing + { + Config: ProviderConfig + AccessZoneUpdateResourceConfig, + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr(accessZoneResourceName, "name", "tfaccTestAccessZone4"), + resource.TestCheckResourceAttr(accessZoneResourceName, "id", "tfaccTestAccessZone4"), + resource.TestCheckResourceAttr(accessZoneResourceName, "groupnet", "groupnet0"), + resource.TestCheckResourceAttr(accessZoneResourceName, "path", "/ifs/home"), + resource.TestCheckResourceAttr(accessZoneResourceName, "auth_providers.#", "1"), + ), + }, + // Update to error state + { + Config: ProviderConfig + AccessZoneUpdateResourceConfigError, + ExpectError: regexp.MustCompile(".*Error editing access zone*."), + }, + // Delete testing automatically occurs in TestCase + }, + }) +} + +func TestAccAccessZoneError(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Create and Read testing + { + Config: ProviderConfig + AccessZoneErrorResourceConfig, + ExpectError: regexp.MustCompile(".*Error creating access zone*."), + }, + }, + }) +} + +func TestAccAccessZoneResourceAfterCreateGetErr(t *testing.T) { + var accessZoneResourceName = "powerscale_accesszone.zone" + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Create and Read testing + { + Config: ProviderConfig + AccessZoneResourceConfig, + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr(accessZoneResourceName, "name", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "id", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "groupnet", "groupnet0"), + resource.TestCheckResourceAttr(accessZoneResourceName, "path", "/ifs"), + resource.TestCheckResourceAttr(accessZoneResourceName, "auth_providers.#", "2"), + ), + }, + { + PreConfig: func() { + mocker = Mock(helper.GetAllAccessZones).Return(nil, fmt.Errorf("access zone read mock error")).Build() + }, + Config: ProviderConfig + AccessZoneResourceConfig, + ExpectError: regexp.MustCompile(`.*access zone read mock error*.`), + }, + }, + }) +} + +func TestAccAccessZoneResourceGetErr(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Create and Read testing + { + PreConfig: func() { + if mocker != nil { + mocker.UnPatch() + } + createMocker = Mock(helper.CreateAccessZones).Return(nil).Build() + mocker = Mock(helper.GetAllAccessZones).Return(nil, fmt.Errorf("access zone read mock error")).Build() + }, + Config: ProviderConfig + AccessZoneResourceConfig, + ExpectError: regexp.MustCompile(`.*access zone read mock error*.`), + }, + }, + }) +} + +func TestAccAccessZoneResourceGetImportErr(t *testing.T) { + var accessZoneResourceName = "powerscale_accesszone.zone" + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + { + PreConfig: func() { + if mocker != nil { + mocker.UnPatch() + } + if createMocker != nil { + createMocker.UnPatch() + } + }, + Config: ProviderConfig + AccessZoneResourceConfig, + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr(accessZoneResourceName, "name", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "id", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "groupnet", "groupnet0"), + resource.TestCheckResourceAttr(accessZoneResourceName, "path", "/ifs"), + resource.TestCheckResourceAttr(accessZoneResourceName, "auth_providers.#", "2"), + ), + }, + { + PreConfig: func() { + mocker = Mock(helper.GetAllAccessZones).Return(nil, fmt.Errorf("access zone read mock error")).Build() + }, + ResourceName: accessZoneResourceName, + ImportState: true, + ImportStateVerify: true, + ExpectError: regexp.MustCompile(`.*access zone read mock error*.`), + }, + }, + }) +} + +func TestAccAccessZoneResourceGetImportSpecificErr(t *testing.T) { + var accessZoneResourceName = "powerscale_accesszone.zone" + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + { + PreConfig: func() { + if mocker != nil { + mocker.UnPatch() + } + if createMocker != nil { + createMocker.UnPatch() + } + }, + Config: ProviderConfig + AccessZoneResourceConfig, + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr(accessZoneResourceName, "name", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "id", "tfaccTestAccessZone3"), + resource.TestCheckResourceAttr(accessZoneResourceName, "groupnet", "groupnet0"), + resource.TestCheckResourceAttr(accessZoneResourceName, "path", "/ifs"), + resource.TestCheckResourceAttr(accessZoneResourceName, "auth_providers.#", "2"), + ), + }, + { + PreConfig: func() { + mocker = Mock(helper.GetSpecificZone).Return(nil, fmt.Errorf("access zone read specific mock error")).Build() + }, + ResourceName: accessZoneResourceName, + ImportState: true, + ImportStateVerify: true, + ExpectError: regexp.MustCompile(`.*access zone read specific mock error*.`), + }, + }, + }) +} + +var AccessZoneResourceConfig = ` +resource "powerscale_accesszone" "zone" { + # Required fields + name = "tfaccTestAccessZone3" + groupnet = "groupnet0" + path = "/ifs" + + # Optional to apply Auth Providers + custom_auth_providers = ["System"] + } +` + +var AccessZoneUpdateResourceConfig = ` +resource "powerscale_accesszone" "zone" { + # Required fields + name = "tfaccTestAccessZone4" + groupnet = "groupnet0" + path = "/ifs/home" + + # Optional to apply Auth Providers + custom_auth_providers = [] + } +` + +var AccessZoneErrorResourceConfig = ` +resource "powerscale_accesszone" "zone" { + # Required fields + name = "tfaccAccessZoneError" + groupnet = "groupnet0" + path = "/ifs" + + # Optional to apply Auth Providers + custom_auth_providers = ["System"] + } +` +var AccessZoneUpdateResourceConfigError = ` +resource "powerscale_accesszone" "zone" { + # Required fields + name = "tfaccTestAccessZone6" + groupnet = "groupnet0" + path = "/some/bad/path/lol" + + # Optional to apply Auth Providers + custom_auth_providers = ["fakeAuthProvider"] + } +` diff --git a/powerscale/provider/cluster_data_source.go b/powerscale/provider/cluster_data_source.go new file mode 100644 index 00000000..a51079ac --- /dev/null +++ b/powerscale/provider/cluster_data_source.go @@ -0,0 +1,140 @@ +package provider + +import ( + "context" + "fmt" + "github.com/hashicorp/terraform-plugin-framework/datasource" + "github.com/hashicorp/terraform-plugin-framework/datasource/schema" + "github.com/hashicorp/terraform-plugin-framework/types" + "terraform-provider-powerscale/client" + "terraform-provider-powerscale/powerscale/helper" + "terraform-provider-powerscale/powerscale/models" +) + +// Ensure provider defined types fully satisfy framework interfaces. +var _ datasource.DataSource = &ClusterDataSource{} + +// NewClusterDataSource creates a new data source. +func NewClusterDataSource() datasource.DataSource { + return &ClusterDataSource{} +} + +// ClusterDataSource defines the data source implementation. +type ClusterDataSource struct { + client *client.Client +} + +// Metadata describes the data source arguments. +func (d *ClusterDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) { + resp.TypeName = req.ProviderTypeName + "_cluster" +} + +// Schema describes the data source arguments. +func (d *ClusterDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) { + resp.Schema = schema.Schema{ + MarkdownDescription: "The cluster attributes and cluster node information.", + Description: "The cluster attributes and cluster node information.", + Attributes: map[string]schema.Attribute{ + "id": schema.StringAttribute{ + Description: "Unique identifier of the cluster.", + MarkdownDescription: "Unique identifier of the cluster.", + Computed: true, + }, + "config": helper.GetClusterConfigSchema(), + "identity": helper.GetClusterIdentitySchema(), + "nodes": helper.GetClusterNodeSchema(), + "internal_networks": helper.GetClusterInternalNetworksSchema(), + }, + } +} + +// Configure configures the data source. +func (d *ClusterDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) { + // Prevent panic if the provider has not been configured. + if req.ProviderData == nil { + return + } + + pscaleClient, ok := req.ProviderData.(*client.Client) + + if !ok { + resp.Diagnostics.AddError( + "Unexpected Data Source Configure Type", + fmt.Sprintf("Expected *http.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData), + ) + + return + } + + d.client = pscaleClient +} + +// Read reads data from the data source. +func (d *ClusterDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) { + var data models.ClusterDataSource + + // Read Terraform configuration data into the model + resp.Diagnostics.Append(req.Config.Get(ctx, &data)...) + + if resp.Diagnostics.HasError() { + return + } + + // Read and map cluster config data + config, err := helper.GetClusterConfig(ctx, d.client) + if err != nil { + resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read cluster config, got error: %s", err)) + return + } + var dataConfig models.ClusterConfig + err = helper.CopyFields(ctx, config, &dataConfig) + if err != nil { + resp.Diagnostics.AddError("Failed to map cluster config fields", err.Error()) + return + } + data.Config = &dataConfig + + // Read and map cluster identity data + identity, err := helper.GetClusterIdentity(ctx, d.client) + if err != nil { + resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read cluster identity, got error: %s", err)) + return + } + var dataIdentity models.ClusterIdentity + err = helper.CopyFields(ctx, identity, &dataIdentity) + if err != nil { + resp.Diagnostics.AddError("Failed to map cluster identity fields", err.Error()) + return + } + data.Identity = &dataIdentity + + nodes, err := helper.GetClusterNodes(ctx, d.client) + if err != nil { + resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read cluster nodes, got error: %s", err)) + return + } + var dataNodes models.ClusterNodes + err = helper.CopyFields(ctx, nodes, &dataNodes) + if err != nil { + resp.Diagnostics.AddError("Failed to map cluster nodes", err.Error()) + return + } + data.Nodes = &dataNodes + + networks, err := helper.GetClusterInternalNetworks(ctx, d.client) + if err != nil { + resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read cluster internal networks, got error: %s", err)) + } + var dataNetworks models.ClusterInternalNetworks + err = helper.CopyFields(ctx, networks, &dataNetworks) + if err != nil { + resp.Diagnostics.AddError("Failed to map cluster internal networks", err.Error()) + return + } + data.InternalNetworks = &dataNetworks + + data.ID = types.StringValue("cluster-data-source") + + // Save data into Terraform state + resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) +} diff --git a/powerscale/provider/cluster_data_source_test.go b/powerscale/provider/cluster_data_source_test.go new file mode 100644 index 00000000..b4fe97f9 --- /dev/null +++ b/powerscale/provider/cluster_data_source_test.go @@ -0,0 +1,158 @@ +/* +Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. + +Licensed under the Mozilla Public License Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://mozilla.org/MPL/2.0/ + + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package provider + +import ( + "fmt" + "regexp" + "terraform-provider-powerscale/powerscale/helper" + "testing" + + . "github.com/bytedance/mockey" + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/terraform" +) + +func TestAccClusterDataSource(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Read testing + { + Config: ProviderConfig + testAccClusterDataSourceConfig, + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr("data.powerscale_cluster.test", "id", "cluster-data-source"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "config.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "config.devices.#"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "config.onefs_version.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "config.timezone.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "identity.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "identity.logon.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "internal_networks.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.#"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.0.drives.#"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.0.drives.0.firmware.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.0.hardware.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.0.partitions.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.0.sensors.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.0.state.%"), + resource.TestCheckResourceAttrSet("data.powerscale_cluster.test", "nodes.nodes.0.status.%"), + ), + }, + }, + }) +} + +func TestAccClusterConfigError(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Read testing + { + PreConfig: func() { + FunctionMocker = Mock(helper.GetClusterConfig).Return(nil, fmt.Errorf("mock error")).Build() + }, + Config: ProviderConfig + testAccClusterDataSourceConfig, + ExpectError: regexp.MustCompile(`.*Client Error*.`), + }, + }, + CheckDestroy: func(_ *terraform.State) error { + if FunctionMocker != nil { + FunctionMocker.UnPatch() + } + return nil + }, + }) +} + +func TestAccClusterIdentityError(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Read testing + { + PreConfig: func() { + FunctionMocker = Mock(helper.GetClusterIdentity).Return(nil, fmt.Errorf("mock error")).Build() + }, + Config: ProviderConfig + testAccClusterDataSourceConfig, + ExpectError: regexp.MustCompile(`.*Client Error*.`), + }, + }, + CheckDestroy: func(_ *terraform.State) error { + if FunctionMocker != nil { + FunctionMocker.UnPatch() + } + return nil + }, + }) +} + +func TestAccClusterNodesError(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Read testing + { + PreConfig: func() { + FunctionMocker = Mock(helper.GetClusterNodes).Return(nil, fmt.Errorf("mock error")).Build() + }, + Config: ProviderConfig + testAccClusterDataSourceConfig, + ExpectError: regexp.MustCompile(`.*Client Error*.`), + }, + }, + CheckDestroy: func(_ *terraform.State) error { + if FunctionMocker != nil { + FunctionMocker.UnPatch() + } + return nil + }, + }) +} + +func TestAccClusterInternalNetworksError(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Read testing + { + PreConfig: func() { + FunctionMocker = Mock(helper.GetClusterInternalNetworks).Return(nil, fmt.Errorf("mock error")).Build() + }, + Config: ProviderConfig + testAccClusterDataSourceConfig, + ExpectError: regexp.MustCompile(`.*Client Error*.`), + }, + }, + CheckDestroy: func(_ *terraform.State) error { + if FunctionMocker != nil { + FunctionMocker.UnPatch() + } + return nil + }, + }) +} + +var testAccClusterDataSourceConfig = ` +data "powerscale_cluster" "test" { +} +` diff --git a/powerscale/provider/example_data_source.go b/powerscale/provider/example_data_source.go deleted file mode 100644 index 74fd8fc1..00000000 --- a/powerscale/provider/example_data_source.go +++ /dev/null @@ -1,124 +0,0 @@ -/* -Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. - -Licensed under the Mozilla Public License Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://mozilla.org/MPL/2.0/ - - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package provider - -import ( - "context" - "fmt" - "terraform-provider-powerscale/client" - - "github.com/hashicorp/terraform-plugin-framework/datasource" - "github.com/hashicorp/terraform-plugin-framework/datasource/schema" - "github.com/hashicorp/terraform-plugin-framework/types" - "github.com/hashicorp/terraform-plugin-log/tflog" -) - -// Ensure provider defined types fully satisfy framework interfaces. -var _ datasource.DataSource = &ExampleDataSource{} - -// NewExampleDataSource creates a new data source. -func NewExampleDataSource() datasource.DataSource { - return &ExampleDataSource{} -} - -// ExampleDataSource defines the data source implementation. -type ExampleDataSource struct { - client *client.Client -} - -// ExampleDataSourceModel describes the data source data model. -type ExampleDataSourceModel struct { - ConfigurableAttribute types.String `tfsdk:"configurable_attribute"` - ID types.String `tfsdk:"id"` -} - -// Metadata describes the data source arguments. -func (d *ExampleDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) { - resp.TypeName = req.ProviderTypeName + "_example" -} - -// Schema describes the data source arguments. -func (d *ExampleDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) { - resp.Schema = schema.Schema{ - // This description is used by the documentation generator and the language server. - MarkdownDescription: "Example data source", - - Attributes: map[string]schema.Attribute{ - "configurable_attribute": schema.StringAttribute{ - MarkdownDescription: "Example configurable attribute", - Optional: true, - }, - "id": schema.StringAttribute{ - MarkdownDescription: "Example identifier", - Computed: true, - }, - }, - } -} - -// Configure configures the data source. -func (d *ExampleDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) { - // Prevent panic if the provider has not been configured. - if req.ProviderData == nil { - return - } - - pscaleClient, ok := req.ProviderData.(*client.Client) - - if !ok { - resp.Diagnostics.AddError( - "Unexpected Data Source Configure Type", - fmt.Sprintf("Expected *http.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData), - ) - - return - } - - d.client = pscaleClient -} - -// Read reads data from the data source. -func (d *ExampleDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) { - var data ExampleDataSourceModel - - // Read Terraform configuration data into the model - resp.Diagnostics.Append(req.Config.Get(ctx, &data)...) - - if resp.Diagnostics.HasError() { - return - } - - // If applicable, this is a great opportunity to initialize any necessary - // provider client data and make a call using it. - // httpResp, err := d.client.Do(httpReq) - // if err != nil { - // resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read example, got error: %s", err)) - // return - // } - - // For the purposes of this example code, hardcoding a response value to - // save into the Terraform state. - data.ID = types.StringValue("example-id") - - // Write logs using the tflog package - // Documentation: https://terraform.io/plugin/log - tflog.Trace(ctx, "read a data source") - - // Save data into Terraform state - resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) -} diff --git a/powerscale/provider/example_data_source_test.go b/powerscale/provider/example_data_source_test.go deleted file mode 100644 index 65f245f1..00000000 --- a/powerscale/provider/example_data_source_test.go +++ /dev/null @@ -1,46 +0,0 @@ -/* -Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. - -Licensed under the Mozilla Public License Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://mozilla.org/MPL/2.0/ - - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package provider - -import ( - "testing" - - "github.com/hashicorp/terraform-plugin-testing/helper/resource" -) - -func TestAccExampleDataSource(t *testing.T) { - resource.Test(t, resource.TestCase{ - PreCheck: func() { testAccPreCheck(t) }, - ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, - Steps: []resource.TestStep{ - // Read testing - { - Config: ProviderConfig + testAccExampleDataSourceConfig, - Check: resource.ComposeAggregateTestCheckFunc( - resource.TestCheckResourceAttr("data.powerscale_example.test", "id", "example-id"), - ), - }, - }, - }) -} - -var testAccExampleDataSourceConfig = ` -data "powerscale_example" "test" { - configurable_attribute = "example" -} -` diff --git a/powerscale/provider/example_resource.go b/powerscale/provider/example_resource.go deleted file mode 100644 index 10682a1c..00000000 --- a/powerscale/provider/example_resource.go +++ /dev/null @@ -1,210 +0,0 @@ -/* -Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. - -Licensed under the Mozilla Public License Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://mozilla.org/MPL/2.0/ - - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package provider - -import ( - "context" - "fmt" - "net/http" - - "github.com/hashicorp/terraform-plugin-framework/path" - "github.com/hashicorp/terraform-plugin-framework/resource" - "github.com/hashicorp/terraform-plugin-framework/resource/schema" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" - "github.com/hashicorp/terraform-plugin-framework/types" - "github.com/hashicorp/terraform-plugin-log/tflog" -) - -// Ensure provider defined types fully satisfy framework interfaces. -var _ resource.Resource = &ExampleResource{} -var _ resource.ResourceWithImportState = &ExampleResource{} - -// NewExampleResource creates a new resource. -func NewExampleResource() resource.Resource { - return &ExampleResource{} -} - -// ExampleResource defines the resource implementation. -type ExampleResource struct { - client *http.Client -} - -// ExampleResourceModel describes the resource data model. -type ExampleResourceModel struct { - ConfigurableAttribute types.String `tfsdk:"configurable_attribute"` - Defaulted types.String `tfsdk:"defaulted"` - ID types.String `tfsdk:"id"` -} - -// Metadata describes the resource arguments. -func (r *ExampleResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) { - resp.TypeName = req.ProviderTypeName + "_example" -} - -// Schema describes the resource arguments. -func (r *ExampleResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) { - resp.Schema = schema.Schema{ - // This description is used by the documentation generator and the language server. - MarkdownDescription: "Example resource", - - Attributes: map[string]schema.Attribute{ - "configurable_attribute": schema.StringAttribute{ - MarkdownDescription: "Example configurable attribute", - Optional: true, - }, - "defaulted": schema.StringAttribute{ - MarkdownDescription: "Example configurable attribute with default value", - Optional: true, - Computed: true, - Default: stringdefault.StaticString("example value when not configured"), - }, - "id": schema.StringAttribute{ - Computed: true, - MarkdownDescription: "Example identifier", - PlanModifiers: []planmodifier.String{ - stringplanmodifier.UseStateForUnknown(), - }, - }, - }, - } -} - -// Configure configures the resource. -func (r *ExampleResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) { - // Prevent panic if the provider has not been configured. - if req.ProviderData == nil { - return - } - - client, ok := req.ProviderData.(*http.Client) - - if !ok { - resp.Diagnostics.AddError( - "Unexpected Resource Configure Type", - fmt.Sprintf("Expected *http.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData), - ) - - return - } - - r.client = client -} - -// Create allocates the resource. -func (r *ExampleResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) { - var data *ExampleResourceModel - - // Read Terraform plan data into the model - resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...) - - if resp.Diagnostics.HasError() { - return - } - - // If applicable, this is a great opportunity to initialize any necessary - // provider client data and make a call using it. - // httpResp, err := r.client.Do(httpReq) - // if err != nil { - // resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to create example, got error: %s", err)) - // return - // } - - // For the purposes of this example code, hardcoding a response value to - // save into the Terraform state. - data.ID = types.StringValue("example-id") - - // Write logs using the tflog package - // Documentation: https://terraform.io/plugin/log - tflog.Trace(ctx, "created a resource") - - // Save data into Terraform state - resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) -} - -// Read reads the resource state. -func (r *ExampleResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { - var data *ExampleResourceModel - - // Read Terraform prior state data into the model - resp.Diagnostics.Append(req.State.Get(ctx, &data)...) - - if resp.Diagnostics.HasError() { - return - } - - // If applicable, this is a great opportunity to initialize any necessary - // provider client data and make a call using it. - // httpResp, err := r.client.Do(httpReq) - // if err != nil { - // resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to read example, got error: %s", err)) - // return - // } - - // Save updated data into Terraform state - resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) -} - -// Update updates the resource state. -func (r *ExampleResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { - var data *ExampleResourceModel - - // Read Terraform plan data into the model - resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...) - - if resp.Diagnostics.HasError() { - return - } - - // If applicable, this is a great opportunity to initialize any necessary - // provider client data and make a call using it. - // httpResp, err := r.client.Do(httpReq) - // if err != nil { - // resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to update example, got error: %s", err)) - // return - // } - - // Save updated data into Terraform state - resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) -} - -// Delete deletes the resource. -func (r *ExampleResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { - var data *ExampleResourceModel - - // Read Terraform prior state data into the model - resp.Diagnostics.Append(req.State.Get(ctx, &data)...) - - if resp.Diagnostics.HasError() { - return - } - - // If applicable, this is a great opportunity to initialize any necessary - // provider client data and make a call using it. - // httpResp, err := r.client.Do(httpReq) - // if err != nil { - // resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to delete example, got error: %s", err)) - // return - // } -} - -// ImportState imports the resource state. -func (r *ExampleResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) { - resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp) -} diff --git a/powerscale/provider/example_resource_test.go b/powerscale/provider/example_resource_test.go deleted file mode 100644 index 1ae602c2..00000000 --- a/powerscale/provider/example_resource_test.go +++ /dev/null @@ -1,59 +0,0 @@ -/* -Copyright (c) 2023 Dell Inc., or its subsidiaries. All Rights Reserved. - -Licensed under the Mozilla Public License Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://mozilla.org/MPL/2.0/ - - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -*/ - -package provider - -import ( - "testing" -) - -func TestAccExampleResource(t *testing.T) { - //resource.Test(t, resource.TestCase{ - // PreCheck: func() { testAccPreCheck(t) }, - // ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, - // Steps: []resource.TestStep{ - // // Create and Read testing - // { - // Config: testAccExampleResourceConfig("one"), - // Check: resource.ComposeAggregateTestCheckFunc( - // resource.TestCheckResourceAttr("scaffolding_example.test", "configurable_attribute", "one"), - // resource.TestCheckResourceAttr("scaffolding_example.test", "defaulted", "example value when not configured"), - // resource.TestCheckResourceAttr("scaffolding_example.test", "id", "example-id"), - // ), - // }, - // // ImportState testing - // { - // ResourceName: "scaffolding_example.test", - // ImportState: true, - // ImportStateVerify: true, - // // This is not normally necessary, but is here because this - // // example code does not have an actual upstream service. - // // Once the Read method is able to refresh information from - // // the upstream service, this can be removed. - // ImportStateVerifyIgnore: []string{"configurable_attribute", "defaulted"}, - // }, - // // Update and Read testing - // { - // Config: testAccExampleResourceConfig("two"), - // Check: resource.ComposeAggregateTestCheckFunc( - // resource.TestCheckResourceAttr("scaffolding_example.test", "configurable_attribute", "two"), - // ), - // }, - // // Delete testing automatically occurs in TestCase - // }, - //}) -} diff --git a/powerscale/provider/powerscale.env b/powerscale/provider/powerscale.env index c128af86..8adf7464 100644 --- a/powerscale/provider/powerscale.env +++ b/powerscale/provider/powerscale.env @@ -1,5 +1,5 @@ TF_ACC=1 -POWERSCALE_ENDPOINT= +POWERSCALE_ENDPOINT=https://:8080 POWERSCALE_USERNAME= POWERSCALE_PASSWORD= POWERSCALE_INSECURE= diff --git a/powerscale/provider/provider.go b/powerscale/provider/provider.go index 03799799..ba69fac3 100644 --- a/powerscale/provider/provider.go +++ b/powerscale/provider/provider.go @@ -179,16 +179,16 @@ func (p *PscaleProvider) Configure(ctx context.Context, req provider.ConfigureRe // Resources describes the provider resources. func (p *PscaleProvider) Resources(ctx context.Context) []func() resource.Resource { return []func() resource.Resource{ - NewExampleResource, + NewAccessZoneResource, } } // DataSources describes the provider data sources. func (p *PscaleProvider) DataSources(ctx context.Context) []func() datasource.DataSource { return []func() datasource.DataSource{ - NewExampleDataSource, NewAccessZoneDataSource, NewUserDataSource, + NewClusterDataSource, } } diff --git a/powerscale/provider/provider_test.go b/powerscale/provider/provider_test.go index 641cea9d..e47ab916 100644 --- a/powerscale/provider/provider_test.go +++ b/powerscale/provider/provider_test.go @@ -87,4 +87,8 @@ func testAccPreCheck(t *testing.T) { } t.Log(ProviderConfig) + // Before each test clear out the mocker + if FunctionMocker != nil { + FunctionMocker.UnPatch() + } }