nodeum_sdk 1.85.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +21 -0
- data/README.md +472 -0
- data/Rakefile +10 -0
- data/docs/ActiveJobStatus.md +23 -0
- data/docs/ApiKey.md +21 -0
- data/docs/ApiKeyCollection.md +19 -0
- data/docs/ApiKeyFull.md +17 -0
- data/docs/ApiKeyFullAllOf.md +17 -0
- data/docs/ApiKeyScope.md +19 -0
- data/docs/AttributeError.md +17 -0
- data/docs/Blank.md +16 -0
- data/docs/ByDateFacet.md +35 -0
- data/docs/ByDateFacetBucket.md +17 -0
- data/docs/ByDateFacetBucketAllOf.md +17 -0
- data/docs/ByDateFacetBuckets.md +17 -0
- data/docs/ByFileExtensionFacet.md +17 -0
- data/docs/ByFileExtensionFacetAllOf.md +17 -0
- data/docs/ByGroupOwnerFacet.md +17 -0
- data/docs/ByGroupOwnerFacetAllOf.md +17 -0
- data/docs/ByPrimaryFacet.md +17 -0
- data/docs/ByPrimaryFacetAllOf.md +17 -0
- data/docs/BySecondaryBucket.md +17 -0
- data/docs/BySecondaryBucketAllOf.md +17 -0
- data/docs/BySecondaryBuckets.md +17 -0
- data/docs/BySecondaryFacet.md +29 -0
- data/docs/BySecondaryTypeFacet.md +17 -0
- data/docs/BySecondaryTypeFacetAllOf.md +17 -0
- data/docs/BySizeFacet.md +35 -0
- data/docs/ByUserOwnerFacet.md +17 -0
- data/docs/ByUserOwnerFacetAllOf.md +17 -0
- data/docs/CloudBucket.md +31 -0
- data/docs/CloudBucketCollection.md +19 -0
- data/docs/CloudBucketSimpleCollection.md +17 -0
- data/docs/CloudBucketsApi.md +908 -0
- data/docs/CloudConnector.md +31 -0
- data/docs/CloudConnectorCollection.md +19 -0
- data/docs/CloudConnectorsApi.md +442 -0
- data/docs/Container.md +35 -0
- data/docs/ContainerCollection.md +19 -0
- data/docs/ContainerPrivilege.md +23 -0
- data/docs/ContainerPrivilegeCollection.md +19 -0
- data/docs/ContainersApi.md +650 -0
- data/docs/DateToFileFacets.md +31 -0
- data/docs/Error.md +19 -0
- data/docs/FileFacet.md +19 -0
- data/docs/FilesApi.md +2090 -0
- data/docs/Frozen.md +16 -0
- data/docs/GreaterThan.md +19 -0
- data/docs/GreaterThanAllOf.md +19 -0
- data/docs/GreaterThanOrEqualTo.md +19 -0
- data/docs/ImportFile.md +39 -0
- data/docs/ImportFileCollection.md +19 -0
- data/docs/ImportFileWithPath.md +41 -0
- data/docs/Invalid.md +17 -0
- data/docs/LessThan.md +19 -0
- data/docs/LessThanAllOf.md +19 -0
- data/docs/LessThanOrEqualTo.md +19 -0
- data/docs/MountCollection.md +17 -0
- data/docs/MountInfo.md +57 -0
- data/docs/MountNotification.md +19 -0
- data/docs/MountStatus.md +21 -0
- data/docs/MountsApi.md +63 -0
- data/docs/Nas.md +27 -0
- data/docs/NasApi.md +322 -0
- data/docs/NasCollection.md +19 -0
- data/docs/NasShare.md +35 -0
- data/docs/NasShareCollection.md +19 -0
- data/docs/NasSharesApi.md +1155 -0
- data/docs/NodeumFile.md +39 -0
- data/docs/NodeumFileCollection.md +19 -0
- data/docs/NodeumFileWithPath.md +17 -0
- data/docs/NodeumFileWithPathAllOf.md +17 -0
- data/docs/OccurrenceLessThan.md +19 -0
- data/docs/OccurrenceLessThanAllOf.md +19 -0
- data/docs/OccurrenceLessThanOrEqualTo.md +19 -0
- data/docs/OnTapesFile.md +25 -0
- data/docs/OnTapesFileCollection.md +19 -0
- data/docs/Pool.md +27 -0
- data/docs/PoolCollection.md +19 -0
- data/docs/PoolUp.md +21 -0
- data/docs/PoolUpAllOf.md +21 -0
- data/docs/PoolsApi.md +798 -0
- data/docs/PrimaryScan.md +25 -0
- data/docs/QuotaOnCache.md +16 -0
- data/docs/Reset.md +17 -0
- data/docs/ResetSections.md +21 -0
- data/docs/SizeToDateFacets.md +31 -0
- data/docs/StatisticsApi.md +386 -0
- data/docs/SystemGroup.md +21 -0
- data/docs/SystemGroupCollection.md +19 -0
- data/docs/SystemUser.md +23 -0
- data/docs/SystemUserCollection.md +19 -0
- data/docs/SystemsApi.md +183 -0
- data/docs/Taken.md +17 -0
- data/docs/TakenAllOf.md +17 -0
- data/docs/Tape.md +65 -0
- data/docs/TapeCollection.md +19 -0
- data/docs/TapeDrive.md +55 -0
- data/docs/TapeDriveAllOf.md +55 -0
- data/docs/TapeDriveCollection.md +19 -0
- data/docs/TapeDriveDevice.md +29 -0
- data/docs/TapeDriveDeviceCollection.md +17 -0
- data/docs/TapeDrivesApi.md +730 -0
- data/docs/TapeLibrariesApi.md +403 -0
- data/docs/TapeLibrary.md +27 -0
- data/docs/TapeLibraryAllOf.md +27 -0
- data/docs/TapeLibraryCollection.md +19 -0
- data/docs/TapeLibraryDevice.md +37 -0
- data/docs/TapeLibraryDeviceCollection.md +17 -0
- data/docs/TapeStat.md +115 -0
- data/docs/TapeStatCollection.md +19 -0
- data/docs/TapesApi.md +959 -0
- data/docs/Task.md +55 -0
- data/docs/TaskCallback.md +21 -0
- data/docs/TaskCallbackCollection.md +19 -0
- data/docs/TaskCallbacksApi.md +326 -0
- data/docs/TaskCollection.md +19 -0
- data/docs/TaskDestinationCollection.md +19 -0
- data/docs/TaskDestinationDown.md +25 -0
- data/docs/TaskDestinationUp.md +27 -0
- data/docs/TaskDestinationsApi.md +328 -0
- data/docs/TaskExecution.md +51 -0
- data/docs/TaskExecutionCollection.md +19 -0
- data/docs/TaskExecutionsApi.md +336 -0
- data/docs/TaskMetadataApi.md +326 -0
- data/docs/TaskMetadatum.md +21 -0
- data/docs/TaskMetadatumCollection.md +19 -0
- data/docs/TaskOption.md +21 -0
- data/docs/TaskOptionCollection.md +19 -0
- data/docs/TaskOptionsApi.md +326 -0
- data/docs/TaskSchedule.md +34 -0
- data/docs/TaskScheduleCollection.md +19 -0
- data/docs/TaskSchedulesApi.md +322 -0
- data/docs/TaskSourceCollection.md +19 -0
- data/docs/TaskSourceDown.md +29 -0
- data/docs/TaskSourceUp.md +33 -0
- data/docs/TaskSourcesApi.md +330 -0
- data/docs/TasksApi.md +846 -0
- data/docs/TooLong.md +17 -0
- data/docs/TooLongAllOf.md +17 -0
- data/docs/TooShort.md +17 -0
- data/docs/TooShortAllOf.md +17 -0
- data/docs/TypeToSecondaryFacets.md +25 -0
- data/docs/UsersApi.md +418 -0
- data/git_push.sh +58 -0
- data/lib/nodeum_sdk.rb +180 -0
- data/lib/nodeum_sdk/api/cloud_buckets_api.rb +1026 -0
- data/lib/nodeum_sdk/api/cloud_connectors_api.rb +491 -0
- data/lib/nodeum_sdk/api/containers_api.rb +736 -0
- data/lib/nodeum_sdk/api/files_api.rb +2418 -0
- data/lib/nodeum_sdk/api/mounts_api.rb +78 -0
- data/lib/nodeum_sdk/api/nas_api.rb +361 -0
- data/lib/nodeum_sdk/api/nas_shares_api.rb +1305 -0
- data/lib/nodeum_sdk/api/pools_api.rb +876 -0
- data/lib/nodeum_sdk/api/statistics_api.rb +418 -0
- data/lib/nodeum_sdk/api/systems_api.rb +215 -0
- data/lib/nodeum_sdk/api/tape_drives_api.rb +858 -0
- data/lib/nodeum_sdk/api/tape_libraries_api.rb +457 -0
- data/lib/nodeum_sdk/api/tapes_api.rb +1104 -0
- data/lib/nodeum_sdk/api/task_callbacks_api.rb +382 -0
- data/lib/nodeum_sdk/api/task_destinations_api.rb +385 -0
- data/lib/nodeum_sdk/api/task_executions_api.rb +399 -0
- data/lib/nodeum_sdk/api/task_metadata_api.rb +382 -0
- data/lib/nodeum_sdk/api/task_options_api.rb +382 -0
- data/lib/nodeum_sdk/api/task_schedules_api.rb +364 -0
- data/lib/nodeum_sdk/api/task_sources_api.rb +388 -0
- data/lib/nodeum_sdk/api/tasks_api.rb +951 -0
- data/lib/nodeum_sdk/api/users_api.rb +452 -0
- data/lib/nodeum_sdk/api_client.rb +386 -0
- data/lib/nodeum_sdk/api_error.rb +57 -0
- data/lib/nodeum_sdk/configuration.rb +255 -0
- data/lib/nodeum_sdk/models/active_job_status.rb +267 -0
- data/lib/nodeum_sdk/models/api_key.rb +224 -0
- data/lib/nodeum_sdk/models/api_key_collection.rb +217 -0
- data/lib/nodeum_sdk/models/api_key_full.rb +220 -0
- data/lib/nodeum_sdk/models/api_key_full_all_of.rb +208 -0
- data/lib/nodeum_sdk/models/api_key_scope.rb +215 -0
- data/lib/nodeum_sdk/models/attribute_error.rb +216 -0
- data/lib/nodeum_sdk/models/blank.rb +209 -0
- data/lib/nodeum_sdk/models/by_date_facet.rb +295 -0
- data/lib/nodeum_sdk/models/by_date_facet_bucket.rb +218 -0
- data/lib/nodeum_sdk/models/by_date_facet_bucket_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_date_facet_buckets.rb +208 -0
- data/lib/nodeum_sdk/models/by_file_extension_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_file_extension_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_group_owner_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_group_owner_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_primary_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_primary_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_secondary_bucket.rb +218 -0
- data/lib/nodeum_sdk/models/by_secondary_bucket_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_secondary_buckets.rb +208 -0
- data/lib/nodeum_sdk/models/by_secondary_facet.rb +268 -0
- data/lib/nodeum_sdk/models/by_secondary_type_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_secondary_type_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/by_size_facet.rb +295 -0
- data/lib/nodeum_sdk/models/by_user_owner_facet.rb +218 -0
- data/lib/nodeum_sdk/models/by_user_owner_facet_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/cloud_bucket.rb +269 -0
- data/lib/nodeum_sdk/models/cloud_bucket_collection.rb +217 -0
- data/lib/nodeum_sdk/models/cloud_bucket_simple_collection.rb +208 -0
- data/lib/nodeum_sdk/models/cloud_connector.rb +303 -0
- data/lib/nodeum_sdk/models/cloud_connector_collection.rb +217 -0
- data/lib/nodeum_sdk/models/container.rb +321 -0
- data/lib/nodeum_sdk/models/container_collection.rb +217 -0
- data/lib/nodeum_sdk/models/container_privilege.rb +279 -0
- data/lib/nodeum_sdk/models/container_privilege_collection.rb +217 -0
- data/lib/nodeum_sdk/models/date_to_file_facets.rb +269 -0
- data/lib/nodeum_sdk/models/error.rb +221 -0
- data/lib/nodeum_sdk/models/file_facet.rb +215 -0
- data/lib/nodeum_sdk/models/frozen.rb +209 -0
- data/lib/nodeum_sdk/models/greater_than.rb +230 -0
- data/lib/nodeum_sdk/models/greater_than_all_of.rb +217 -0
- data/lib/nodeum_sdk/models/greater_than_or_equal_to.rb +230 -0
- data/lib/nodeum_sdk/models/import_file.rb +339 -0
- data/lib/nodeum_sdk/models/import_file_collection.rb +217 -0
- data/lib/nodeum_sdk/models/import_file_with_path.rb +356 -0
- data/lib/nodeum_sdk/models/invalid.rb +220 -0
- data/lib/nodeum_sdk/models/less_than.rb +230 -0
- data/lib/nodeum_sdk/models/less_than_all_of.rb +217 -0
- data/lib/nodeum_sdk/models/less_than_or_equal_to.rb +230 -0
- data/lib/nodeum_sdk/models/mount_collection.rb +208 -0
- data/lib/nodeum_sdk/models/mount_info.rb +420 -0
- data/lib/nodeum_sdk/models/mount_notification.rb +249 -0
- data/lib/nodeum_sdk/models/mount_status.rb +224 -0
- data/lib/nodeum_sdk/models/nas.rb +285 -0
- data/lib/nodeum_sdk/models/nas_collection.rb +217 -0
- data/lib/nodeum_sdk/models/nas_share.rb +287 -0
- data/lib/nodeum_sdk/models/nas_share_collection.rb +217 -0
- data/lib/nodeum_sdk/models/nodeum_file.rb +339 -0
- data/lib/nodeum_sdk/models/nodeum_file_collection.rb +217 -0
- data/lib/nodeum_sdk/models/nodeum_file_with_path.rb +240 -0
- data/lib/nodeum_sdk/models/nodeum_file_with_path_all_of.rb +206 -0
- data/lib/nodeum_sdk/models/occurrence_less_than.rb +230 -0
- data/lib/nodeum_sdk/models/occurrence_less_than_all_of.rb +217 -0
- data/lib/nodeum_sdk/models/occurrence_less_than_or_equal_to.rb +230 -0
- data/lib/nodeum_sdk/models/on_tapes_file.rb +278 -0
- data/lib/nodeum_sdk/models/on_tapes_file_collection.rb +217 -0
- data/lib/nodeum_sdk/models/pool.rb +297 -0
- data/lib/nodeum_sdk/models/pool_collection.rb +217 -0
- data/lib/nodeum_sdk/models/pool_up.rb +264 -0
- data/lib/nodeum_sdk/models/pool_up_all_of.rb +230 -0
- data/lib/nodeum_sdk/models/primary_scan.rb +276 -0
- data/lib/nodeum_sdk/models/quota_on_cache.rb +209 -0
- data/lib/nodeum_sdk/models/reset.rb +209 -0
- data/lib/nodeum_sdk/models/reset_sections.rb +265 -0
- data/lib/nodeum_sdk/models/size_to_date_facets.rb +269 -0
- data/lib/nodeum_sdk/models/system_group.rb +226 -0
- data/lib/nodeum_sdk/models/system_group_collection.rb +217 -0
- data/lib/nodeum_sdk/models/system_user.rb +233 -0
- data/lib/nodeum_sdk/models/system_user_collection.rb +217 -0
- data/lib/nodeum_sdk/models/taken.rb +220 -0
- data/lib/nodeum_sdk/models/taken_all_of.rb +207 -0
- data/lib/nodeum_sdk/models/tape.rb +456 -0
- data/lib/nodeum_sdk/models/tape_collection.rb +217 -0
- data/lib/nodeum_sdk/models/tape_drive.rb +423 -0
- data/lib/nodeum_sdk/models/tape_drive_all_of.rb +411 -0
- data/lib/nodeum_sdk/models/tape_drive_collection.rb +217 -0
- data/lib/nodeum_sdk/models/tape_drive_device.rb +261 -0
- data/lib/nodeum_sdk/models/tape_drive_device_collection.rb +208 -0
- data/lib/nodeum_sdk/models/tape_library.rb +297 -0
- data/lib/nodeum_sdk/models/tape_library_all_of.rb +285 -0
- data/lib/nodeum_sdk/models/tape_library_collection.rb +217 -0
- data/lib/nodeum_sdk/models/tape_library_device.rb +330 -0
- data/lib/nodeum_sdk/models/tape_library_device_collection.rb +208 -0
- data/lib/nodeum_sdk/models/tape_stat.rb +647 -0
- data/lib/nodeum_sdk/models/tape_stat_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task.rb +483 -0
- data/lib/nodeum_sdk/models/task_callback.rb +258 -0
- data/lib/nodeum_sdk/models/task_callback_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_destination_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_destination_down.rb +242 -0
- data/lib/nodeum_sdk/models/task_destination_up.rb +251 -0
- data/lib/nodeum_sdk/models/task_execution.rb +441 -0
- data/lib/nodeum_sdk/models/task_execution_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_metadatum.rb +224 -0
- data/lib/nodeum_sdk/models/task_metadatum_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_option.rb +258 -0
- data/lib/nodeum_sdk/models/task_option_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_schedule.rb +278 -0
- data/lib/nodeum_sdk/models/task_schedule_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_source_collection.rb +217 -0
- data/lib/nodeum_sdk/models/task_source_down.rb +262 -0
- data/lib/nodeum_sdk/models/task_source_up.rb +280 -0
- data/lib/nodeum_sdk/models/too_long.rb +220 -0
- data/lib/nodeum_sdk/models/too_long_all_of.rb +207 -0
- data/lib/nodeum_sdk/models/too_short.rb +220 -0
- data/lib/nodeum_sdk/models/too_short_all_of.rb +207 -0
- data/lib/nodeum_sdk/models/type_to_secondary_facets.rb +242 -0
- data/lib/nodeum_sdk/version.rb +15 -0
- data/nodeum_sdk.gemspec +39 -0
- data/spec/api/cloud_buckets_api_spec.rb +237 -0
- data/spec/api/cloud_connectors_api_spec.rb +129 -0
- data/spec/api/containers_api_spec.rb +180 -0
- data/spec/api/files_api_spec.rb +570 -0
- data/spec/api/mounts_api_spec.rb +46 -0
- data/spec/api/nas_api_spec.rb +104 -0
- data/spec/api/nas_shares_api_spec.rb +292 -0
- data/spec/api/pools_api_spec.rb +203 -0
- data/spec/api/statistics_api_spec.rb +113 -0
- data/spec/api/systems_api_spec.rb +70 -0
- data/spec/api/tape_drives_api_spec.rb +220 -0
- data/spec/api/tape_libraries_api_spec.rb +127 -0
- data/spec/api/tapes_api_spec.rb +279 -0
- data/spec/api/task_callbacks_api_spec.rb +106 -0
- data/spec/api/task_destinations_api_spec.rb +107 -0
- data/spec/api/task_executions_api_spec.rb +127 -0
- data/spec/api/task_metadata_api_spec.rb +106 -0
- data/spec/api/task_options_api_spec.rb +106 -0
- data/spec/api/task_schedules_api_spec.rb +104 -0
- data/spec/api/task_sources_api_spec.rb +108 -0
- data/spec/api/tasks_api_spec.rb +226 -0
- data/spec/api/users_api_spec.rb +119 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/active_job_status_spec.rb +63 -0
- data/spec/models/api_key_collection_spec.rb +47 -0
- data/spec/models/api_key_full_all_of_spec.rb +41 -0
- data/spec/models/api_key_full_spec.rb +41 -0
- data/spec/models/api_key_scope_spec.rb +47 -0
- data/spec/models/api_key_spec.rb +53 -0
- data/spec/models/attribute_error_spec.rb +41 -0
- data/spec/models/blank_spec.rb +35 -0
- data/spec/models/by_date_facet_bucket_all_of_spec.rb +41 -0
- data/spec/models/by_date_facet_bucket_spec.rb +41 -0
- data/spec/models/by_date_facet_buckets_spec.rb +41 -0
- data/spec/models/by_date_facet_spec.rb +95 -0
- data/spec/models/by_file_extension_facet_all_of_spec.rb +41 -0
- data/spec/models/by_file_extension_facet_spec.rb +41 -0
- data/spec/models/by_group_owner_facet_all_of_spec.rb +41 -0
- data/spec/models/by_group_owner_facet_spec.rb +41 -0
- data/spec/models/by_primary_facet_all_of_spec.rb +41 -0
- data/spec/models/by_primary_facet_spec.rb +41 -0
- data/spec/models/by_secondary_bucket_all_of_spec.rb +41 -0
- data/spec/models/by_secondary_bucket_spec.rb +41 -0
- data/spec/models/by_secondary_buckets_spec.rb +41 -0
- data/spec/models/by_secondary_facet_spec.rb +77 -0
- data/spec/models/by_secondary_type_facet_all_of_spec.rb +41 -0
- data/spec/models/by_secondary_type_facet_spec.rb +41 -0
- data/spec/models/by_size_facet_spec.rb +95 -0
- data/spec/models/by_user_owner_facet_all_of_spec.rb +41 -0
- data/spec/models/by_user_owner_facet_spec.rb +41 -0
- data/spec/models/cloud_bucket_collection_spec.rb +47 -0
- data/spec/models/cloud_bucket_simple_collection_spec.rb +41 -0
- data/spec/models/cloud_bucket_spec.rb +83 -0
- data/spec/models/cloud_connector_collection_spec.rb +47 -0
- data/spec/models/cloud_connector_spec.rb +87 -0
- data/spec/models/container_collection_spec.rb +47 -0
- data/spec/models/container_privilege_collection_spec.rb +47 -0
- data/spec/models/container_privilege_spec.rb +67 -0
- data/spec/models/container_spec.rb +99 -0
- data/spec/models/date_to_file_facets_spec.rb +83 -0
- data/spec/models/error_spec.rb +47 -0
- data/spec/models/file_facet_spec.rb +47 -0
- data/spec/models/frozen_spec.rb +35 -0
- data/spec/models/greater_than_all_of_spec.rb +47 -0
- data/spec/models/greater_than_or_equal_to_spec.rb +47 -0
- data/spec/models/greater_than_spec.rb +47 -0
- data/spec/models/import_file_collection_spec.rb +47 -0
- data/spec/models/import_file_spec.rb +111 -0
- data/spec/models/import_file_with_path_spec.rb +117 -0
- data/spec/models/invalid_spec.rb +41 -0
- data/spec/models/less_than_all_of_spec.rb +47 -0
- data/spec/models/less_than_or_equal_to_spec.rb +47 -0
- data/spec/models/less_than_spec.rb +47 -0
- data/spec/models/mount_collection_spec.rb +41 -0
- data/spec/models/mount_info_spec.rb +165 -0
- data/spec/models/mount_notification_spec.rb +51 -0
- data/spec/models/mount_status_spec.rb +53 -0
- data/spec/models/nas_collection_spec.rb +47 -0
- data/spec/models/nas_share_collection_spec.rb +47 -0
- data/spec/models/nas_share_spec.rb +95 -0
- data/spec/models/nas_spec.rb +75 -0
- data/spec/models/nodeum_file_collection_spec.rb +47 -0
- data/spec/models/nodeum_file_spec.rb +111 -0
- data/spec/models/nodeum_file_with_path_all_of_spec.rb +41 -0
- data/spec/models/nodeum_file_with_path_spec.rb +41 -0
- data/spec/models/occurrence_less_than_all_of_spec.rb +47 -0
- data/spec/models/occurrence_less_than_or_equal_to_spec.rb +47 -0
- data/spec/models/occurrence_less_than_spec.rb +47 -0
- data/spec/models/on_tapes_file_collection_spec.rb +47 -0
- data/spec/models/on_tapes_file_spec.rb +69 -0
- data/spec/models/pool_collection_spec.rb +47 -0
- data/spec/models/pool_spec.rb +79 -0
- data/spec/models/pool_up_all_of_spec.rb +53 -0
- data/spec/models/pool_up_spec.rb +53 -0
- data/spec/models/primary_scan_spec.rb +69 -0
- data/spec/models/quota_on_cache_spec.rb +35 -0
- data/spec/models/reset_sections_spec.rb +57 -0
- data/spec/models/reset_spec.rb +41 -0
- data/spec/models/size_to_date_facets_spec.rb +83 -0
- data/spec/models/system_group_collection_spec.rb +47 -0
- data/spec/models/system_group_spec.rb +53 -0
- data/spec/models/system_user_collection_spec.rb +47 -0
- data/spec/models/system_user_spec.rb +59 -0
- data/spec/models/taken_all_of_spec.rb +41 -0
- data/spec/models/taken_spec.rb +41 -0
- data/spec/models/tape_collection_spec.rb +47 -0
- data/spec/models/tape_drive_all_of_spec.rb +159 -0
- data/spec/models/tape_drive_collection_spec.rb +47 -0
- data/spec/models/tape_drive_device_collection_spec.rb +41 -0
- data/spec/models/tape_drive_device_spec.rb +77 -0
- data/spec/models/tape_drive_spec.rb +159 -0
- data/spec/models/tape_library_all_of_spec.rb +75 -0
- data/spec/models/tape_library_collection_spec.rb +47 -0
- data/spec/models/tape_library_device_collection_spec.rb +41 -0
- data/spec/models/tape_library_device_spec.rb +105 -0
- data/spec/models/tape_library_spec.rb +75 -0
- data/spec/models/tape_spec.rb +189 -0
- data/spec/models/tape_stat_collection_spec.rb +47 -0
- data/spec/models/tape_stat_spec.rb +335 -0
- data/spec/models/task_callback_collection_spec.rb +47 -0
- data/spec/models/task_callback_spec.rb +57 -0
- data/spec/models/task_collection_spec.rb +47 -0
- data/spec/models/task_destination_collection_spec.rb +47 -0
- data/spec/models/task_destination_down_spec.rb +65 -0
- data/spec/models/task_destination_up_spec.rb +71 -0
- data/spec/models/task_execution_collection_spec.rb +47 -0
- data/spec/models/task_execution_spec.rb +163 -0
- data/spec/models/task_metadatum_collection_spec.rb +47 -0
- data/spec/models/task_metadatum_spec.rb +53 -0
- data/spec/models/task_option_collection_spec.rb +47 -0
- data/spec/models/task_option_spec.rb +57 -0
- data/spec/models/task_schedule_collection_spec.rb +47 -0
- data/spec/models/task_schedule_spec.rb +89 -0
- data/spec/models/task_source_collection_spec.rb +47 -0
- data/spec/models/task_source_down_spec.rb +77 -0
- data/spec/models/task_source_up_spec.rb +89 -0
- data/spec/models/task_spec.rb +183 -0
- data/spec/models/too_long_all_of_spec.rb +41 -0
- data/spec/models/too_long_spec.rb +41 -0
- data/spec/models/too_short_all_of_spec.rb +41 -0
- data/spec/models/too_short_spec.rb +41 -0
- data/spec/models/type_to_secondary_facets_spec.rb +65 -0
- data/spec/spec_helper.rb +111 -0
- metadata +718 -0
data/docs/Nas.md
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# Nodeum::Nas
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | | [optional] [readonly]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**host** | **String** | | [optional]
|
10
|
+
**type** | **String** | | [optional]
|
11
|
+
**comment** | **String** | | [optional]
|
12
|
+
**price** | **String** | | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Nodeum'
|
18
|
+
|
19
|
+
instance = Nodeum::Nas.new(id: 2,
|
20
|
+
name: samba,
|
21
|
+
host: samba.local,
|
22
|
+
type: smb_v3,
|
23
|
+
comment: Local NAS,
|
24
|
+
price: 120.0)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
data/docs/NasApi.md
ADDED
@@ -0,0 +1,322 @@
|
|
1
|
+
# Nodeum::NasApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost/api/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_nas**](NasApi.md#create_nas) | **POST** /nas | Creates a new NAS.
|
8
|
+
[**destroy_nas**](NasApi.md#destroy_nas) | **DELETE** /nas/{nas_id} | Destroys a specific NAS.
|
9
|
+
[**index_nas**](NasApi.md#index_nas) | **GET** /nas | Lists all NAS.
|
10
|
+
[**show_nas**](NasApi.md#show_nas) | **GET** /nas/{nas_id} | Displays a specific NAS.
|
11
|
+
[**update_nas**](NasApi.md#update_nas) | **PUT** /nas/{nas_id} | Updates a specific NAS.
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## create_nas
|
16
|
+
|
17
|
+
> Nas create_nas(nas_body)
|
18
|
+
|
19
|
+
Creates a new NAS.
|
20
|
+
|
21
|
+
**API Key Scope**: nas / create
|
22
|
+
|
23
|
+
### Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'nodeum_sdk'
|
28
|
+
# setup authorization
|
29
|
+
Nodeum.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: BasicAuth
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
|
34
|
+
# Configure API key authorization: BearerAuth
|
35
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_instance = Nodeum::NasApi.new
|
41
|
+
nas_body = Nodeum::Nas.new # Nas |
|
42
|
+
|
43
|
+
begin
|
44
|
+
#Creates a new NAS.
|
45
|
+
result = api_instance.create_nas(nas_body)
|
46
|
+
p result
|
47
|
+
rescue Nodeum::ApiError => e
|
48
|
+
puts "Exception when calling NasApi->create_nas: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**nas_body** | [**Nas**](Nas.md)| |
|
58
|
+
|
59
|
+
### Return type
|
60
|
+
|
61
|
+
[**Nas**](Nas.md)
|
62
|
+
|
63
|
+
### Authorization
|
64
|
+
|
65
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
66
|
+
|
67
|
+
### HTTP request headers
|
68
|
+
|
69
|
+
- **Content-Type**: application/json
|
70
|
+
- **Accept**: application/json
|
71
|
+
|
72
|
+
|
73
|
+
## destroy_nas
|
74
|
+
|
75
|
+
> destroy_nas(nas_id)
|
76
|
+
|
77
|
+
Destroys a specific NAS.
|
78
|
+
|
79
|
+
**API Key Scope**: nas / destroy
|
80
|
+
|
81
|
+
### Example
|
82
|
+
|
83
|
+
```ruby
|
84
|
+
# load the gem
|
85
|
+
require 'nodeum_sdk'
|
86
|
+
# setup authorization
|
87
|
+
Nodeum.configure do |config|
|
88
|
+
# Configure HTTP basic authorization: BasicAuth
|
89
|
+
config.username = 'YOUR USERNAME'
|
90
|
+
config.password = 'YOUR PASSWORD'
|
91
|
+
|
92
|
+
# Configure API key authorization: BearerAuth
|
93
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
94
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
95
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
96
|
+
end
|
97
|
+
|
98
|
+
api_instance = Nodeum::NasApi.new
|
99
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
100
|
+
|
101
|
+
begin
|
102
|
+
#Destroys a specific NAS.
|
103
|
+
api_instance.destroy_nas(nas_id)
|
104
|
+
rescue Nodeum::ApiError => e
|
105
|
+
puts "Exception when calling NasApi->destroy_nas: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
|
112
|
+
Name | Type | Description | Notes
|
113
|
+
------------- | ------------- | ------------- | -------------
|
114
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
nil (empty response body)
|
119
|
+
|
120
|
+
### Authorization
|
121
|
+
|
122
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: Not defined
|
127
|
+
- **Accept**: Not defined
|
128
|
+
|
129
|
+
|
130
|
+
## index_nas
|
131
|
+
|
132
|
+
> NasCollection index_nas(opts)
|
133
|
+
|
134
|
+
Lists all NAS.
|
135
|
+
|
136
|
+
**API Key Scope**: nas / index
|
137
|
+
|
138
|
+
### Example
|
139
|
+
|
140
|
+
```ruby
|
141
|
+
# load the gem
|
142
|
+
require 'nodeum_sdk'
|
143
|
+
# setup authorization
|
144
|
+
Nodeum.configure do |config|
|
145
|
+
# Configure HTTP basic authorization: BasicAuth
|
146
|
+
config.username = 'YOUR USERNAME'
|
147
|
+
config.password = 'YOUR PASSWORD'
|
148
|
+
|
149
|
+
# Configure API key authorization: BearerAuth
|
150
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
151
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
152
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
153
|
+
end
|
154
|
+
|
155
|
+
api_instance = Nodeum::NasApi.new
|
156
|
+
opts = {
|
157
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
158
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
159
|
+
sort_by: ['sort_by_example'], # Array<String> | Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
160
|
+
id: 'id_example', # String | Filter on id
|
161
|
+
name: 'name_example', # String | Filter on name
|
162
|
+
comment: 'comment_example', # String | Filter on comment
|
163
|
+
host: 'host_example', # String | Filter on host
|
164
|
+
type: 'type_example', # String | Filter on type
|
165
|
+
price: 'price_example' # String | Filter on price
|
166
|
+
}
|
167
|
+
|
168
|
+
begin
|
169
|
+
#Lists all NAS.
|
170
|
+
result = api_instance.index_nas(opts)
|
171
|
+
p result
|
172
|
+
rescue Nodeum::ApiError => e
|
173
|
+
puts "Exception when calling NasApi->index_nas: #{e}"
|
174
|
+
end
|
175
|
+
```
|
176
|
+
|
177
|
+
### Parameters
|
178
|
+
|
179
|
+
|
180
|
+
Name | Type | Description | Notes
|
181
|
+
------------- | ------------- | ------------- | -------------
|
182
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
183
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
184
|
+
**sort_by** | [**Array<String>**](String.md)| Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. | [optional]
|
185
|
+
**id** | **String**| Filter on id | [optional]
|
186
|
+
**name** | **String**| Filter on name | [optional]
|
187
|
+
**comment** | **String**| Filter on comment | [optional]
|
188
|
+
**host** | **String**| Filter on host | [optional]
|
189
|
+
**type** | **String**| Filter on type | [optional]
|
190
|
+
**price** | **String**| Filter on price | [optional]
|
191
|
+
|
192
|
+
### Return type
|
193
|
+
|
194
|
+
[**NasCollection**](NasCollection.md)
|
195
|
+
|
196
|
+
### Authorization
|
197
|
+
|
198
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
199
|
+
|
200
|
+
### HTTP request headers
|
201
|
+
|
202
|
+
- **Content-Type**: Not defined
|
203
|
+
- **Accept**: application/json
|
204
|
+
|
205
|
+
|
206
|
+
## show_nas
|
207
|
+
|
208
|
+
> Nas show_nas(nas_id)
|
209
|
+
|
210
|
+
Displays a specific NAS.
|
211
|
+
|
212
|
+
**API Key Scope**: nas / show
|
213
|
+
|
214
|
+
### Example
|
215
|
+
|
216
|
+
```ruby
|
217
|
+
# load the gem
|
218
|
+
require 'nodeum_sdk'
|
219
|
+
# setup authorization
|
220
|
+
Nodeum.configure do |config|
|
221
|
+
# Configure HTTP basic authorization: BasicAuth
|
222
|
+
config.username = 'YOUR USERNAME'
|
223
|
+
config.password = 'YOUR PASSWORD'
|
224
|
+
|
225
|
+
# Configure API key authorization: BearerAuth
|
226
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
227
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
228
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
229
|
+
end
|
230
|
+
|
231
|
+
api_instance = Nodeum::NasApi.new
|
232
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
233
|
+
|
234
|
+
begin
|
235
|
+
#Displays a specific NAS.
|
236
|
+
result = api_instance.show_nas(nas_id)
|
237
|
+
p result
|
238
|
+
rescue Nodeum::ApiError => e
|
239
|
+
puts "Exception when calling NasApi->show_nas: #{e}"
|
240
|
+
end
|
241
|
+
```
|
242
|
+
|
243
|
+
### Parameters
|
244
|
+
|
245
|
+
|
246
|
+
Name | Type | Description | Notes
|
247
|
+
------------- | ------------- | ------------- | -------------
|
248
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
249
|
+
|
250
|
+
### Return type
|
251
|
+
|
252
|
+
[**Nas**](Nas.md)
|
253
|
+
|
254
|
+
### Authorization
|
255
|
+
|
256
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
257
|
+
|
258
|
+
### HTTP request headers
|
259
|
+
|
260
|
+
- **Content-Type**: Not defined
|
261
|
+
- **Accept**: application/json
|
262
|
+
|
263
|
+
|
264
|
+
## update_nas
|
265
|
+
|
266
|
+
> Nas update_nas(nas_id, nas_body)
|
267
|
+
|
268
|
+
Updates a specific NAS.
|
269
|
+
|
270
|
+
**API Key Scope**: nas / update
|
271
|
+
|
272
|
+
### Example
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
# load the gem
|
276
|
+
require 'nodeum_sdk'
|
277
|
+
# setup authorization
|
278
|
+
Nodeum.configure do |config|
|
279
|
+
# Configure HTTP basic authorization: BasicAuth
|
280
|
+
config.username = 'YOUR USERNAME'
|
281
|
+
config.password = 'YOUR PASSWORD'
|
282
|
+
|
283
|
+
# Configure API key authorization: BearerAuth
|
284
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
285
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
286
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
287
|
+
end
|
288
|
+
|
289
|
+
api_instance = Nodeum::NasApi.new
|
290
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
291
|
+
nas_body = Nodeum::Nas.new # Nas |
|
292
|
+
|
293
|
+
begin
|
294
|
+
#Updates a specific NAS.
|
295
|
+
result = api_instance.update_nas(nas_id, nas_body)
|
296
|
+
p result
|
297
|
+
rescue Nodeum::ApiError => e
|
298
|
+
puts "Exception when calling NasApi->update_nas: #{e}"
|
299
|
+
end
|
300
|
+
```
|
301
|
+
|
302
|
+
### Parameters
|
303
|
+
|
304
|
+
|
305
|
+
Name | Type | Description | Notes
|
306
|
+
------------- | ------------- | ------------- | -------------
|
307
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
308
|
+
**nas_body** | [**Nas**](Nas.md)| |
|
309
|
+
|
310
|
+
### Return type
|
311
|
+
|
312
|
+
[**Nas**](Nas.md)
|
313
|
+
|
314
|
+
### Authorization
|
315
|
+
|
316
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
317
|
+
|
318
|
+
### HTTP request headers
|
319
|
+
|
320
|
+
- **Content-Type**: application/json
|
321
|
+
- **Accept**: application/json
|
322
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Nodeum::NasCollection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional] [readonly]
|
8
|
+
**nas** | [**Array<Nas>**](Nas.md) | | [optional] [readonly]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Nodeum'
|
14
|
+
|
15
|
+
instance = Nodeum::NasCollection.new(count: 1,
|
16
|
+
nas: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/NasShare.md
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
# Nodeum::NasShare
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | | [optional] [readonly]
|
8
|
+
**nas_id** | **Integer** | | [optional] [readonly]
|
9
|
+
**pool_id** | **Integer** | | [optional] [readonly]
|
10
|
+
**name** | **String** | | [optional]
|
11
|
+
**path** | **String** | | [optional]
|
12
|
+
**options** | **String** | | [optional]
|
13
|
+
**username** | **String** | | [optional]
|
14
|
+
**password** | **String** | | [optional]
|
15
|
+
**file_count** | **Integer** | | [optional] [readonly]
|
16
|
+
**file_size_sum** | **Integer** | | [optional] [readonly]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'Nodeum'
|
22
|
+
|
23
|
+
instance = Nodeum::NasShare.new(id: 10,
|
24
|
+
nas_id: 2,
|
25
|
+
pool_id: 6,
|
26
|
+
name: archives_general,
|
27
|
+
path: archives/general,
|
28
|
+
options: rsize=1048576,wsize=1048576,
|
29
|
+
username: admin,
|
30
|
+
password: [censored],
|
31
|
+
file_count: null,
|
32
|
+
file_size_sum: null)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Nodeum::NasShareCollection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**count** | **Integer** | | [optional] [readonly]
|
8
|
+
**nas_shares** | [**Array<NasShare>**](NasShare.md) | | [optional] [readonly]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Nodeum'
|
14
|
+
|
15
|
+
instance = Nodeum::NasShareCollection.new(count: 1,
|
16
|
+
nas_shares: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,1155 @@
|
|
1
|
+
# Nodeum::NasSharesApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost/api/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_nas_share_by_nas**](NasSharesApi.md#create_nas_share_by_nas) | **POST** /nas/{nas_id}/nas_shares | Creates a new NAS share.
|
8
|
+
[**destroy_nas_share**](NasSharesApi.md#destroy_nas_share) | **DELETE** /nas_shares/{nas_share_id} | Destroys a specific NAS share.
|
9
|
+
[**destroy_nas_share_by_nas**](NasSharesApi.md#destroy_nas_share_by_nas) | **DELETE** /nas/{nas_id}/nas_shares/{nas_share_id} | Destroys a specific NAS share.
|
10
|
+
[**destroy_nas_share_by_pool**](NasSharesApi.md#destroy_nas_share_by_pool) | **DELETE** /pools/{pool_id}/nas_shares/{nas_share_id} | Destroys a specific NAS share.
|
11
|
+
[**index_nas_shares**](NasSharesApi.md#index_nas_shares) | **GET** /nas_shares | Lists all NAS shares.
|
12
|
+
[**index_nas_shares_by_nas**](NasSharesApi.md#index_nas_shares_by_nas) | **GET** /nas/{nas_id}/nas_shares | Lists all NAS shares.
|
13
|
+
[**index_nas_shares_by_pool**](NasSharesApi.md#index_nas_shares_by_pool) | **GET** /pools/{pool_id}/nas_shares | Lists all NAS shares from pool.
|
14
|
+
[**mount_status_nas_share**](NasSharesApi.md#mount_status_nas_share) | **GET** /nas_shares/{nas_share_id}/mount | Get mount status of NAS Share.
|
15
|
+
[**mount_status_nas_share_by_nas**](NasSharesApi.md#mount_status_nas_share_by_nas) | **GET** /nas/{nas_id}/nas_shares/{nas_share_id}/mount | Get mount status of NAS Share.
|
16
|
+
[**mount_status_nas_share_by_pool**](NasSharesApi.md#mount_status_nas_share_by_pool) | **GET** /pools/{pool_id}/nas_shares/{nas_share_id}/mount | Get mount status of NAS Share.
|
17
|
+
[**show_nas_share**](NasSharesApi.md#show_nas_share) | **GET** /nas_shares/{nas_share_id} | Displays a specific NAS share.
|
18
|
+
[**show_nas_share_by_nas**](NasSharesApi.md#show_nas_share_by_nas) | **GET** /nas/{nas_id}/nas_shares/{nas_share_id} | Displays a specific NAS share.
|
19
|
+
[**show_nas_share_by_pool**](NasSharesApi.md#show_nas_share_by_pool) | **GET** /pools/{pool_id}/nas_shares/{nas_share_id} | Displays a specific NAS share.
|
20
|
+
[**test_nas_share**](NasSharesApi.md#test_nas_share) | **PUT** /nas/{nas_id}/nas_shares/-/test | Test an unsaved NAS Share.
|
21
|
+
[**test_result_nas_share**](NasSharesApi.md#test_result_nas_share) | **GET** /nas/{nas_id}/nas_shares/-/test | Check result of a NAS Share test job.
|
22
|
+
[**update_nas_share**](NasSharesApi.md#update_nas_share) | **PUT** /nas_shares/{nas_share_id} | Updates a specific NAS share.
|
23
|
+
[**update_nas_share_by_nas**](NasSharesApi.md#update_nas_share_by_nas) | **PUT** /nas/{nas_id}/nas_shares/{nas_share_id} | Updates a specific NAS share.
|
24
|
+
[**update_nas_share_by_pool**](NasSharesApi.md#update_nas_share_by_pool) | **PUT** /pools/{pool_id}/nas_shares/{nas_share_id} | Updates a specific NAS share.
|
25
|
+
|
26
|
+
|
27
|
+
|
28
|
+
## create_nas_share_by_nas
|
29
|
+
|
30
|
+
> NasShare create_nas_share_by_nas(nas_id, nas_share_body)
|
31
|
+
|
32
|
+
Creates a new NAS share.
|
33
|
+
|
34
|
+
**API Key Scope**: nas_shares / create
|
35
|
+
|
36
|
+
### Example
|
37
|
+
|
38
|
+
```ruby
|
39
|
+
# load the gem
|
40
|
+
require 'nodeum_sdk'
|
41
|
+
# setup authorization
|
42
|
+
Nodeum.configure do |config|
|
43
|
+
# Configure HTTP basic authorization: BasicAuth
|
44
|
+
config.username = 'YOUR USERNAME'
|
45
|
+
config.password = 'YOUR PASSWORD'
|
46
|
+
|
47
|
+
# Configure API key authorization: BearerAuth
|
48
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
49
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
50
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
51
|
+
end
|
52
|
+
|
53
|
+
api_instance = Nodeum::NasSharesApi.new
|
54
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
55
|
+
nas_share_body = Nodeum::NasShare.new # NasShare |
|
56
|
+
|
57
|
+
begin
|
58
|
+
#Creates a new NAS share.
|
59
|
+
result = api_instance.create_nas_share_by_nas(nas_id, nas_share_body)
|
60
|
+
p result
|
61
|
+
rescue Nodeum::ApiError => e
|
62
|
+
puts "Exception when calling NasSharesApi->create_nas_share_by_nas: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
|
69
|
+
Name | Type | Description | Notes
|
70
|
+
------------- | ------------- | ------------- | -------------
|
71
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
72
|
+
**nas_share_body** | [**NasShare**](NasShare.md)| |
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
[**NasShare**](NasShare.md)
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: application/json
|
85
|
+
- **Accept**: application/json
|
86
|
+
|
87
|
+
|
88
|
+
## destroy_nas_share
|
89
|
+
|
90
|
+
> destroy_nas_share(nas_share_id)
|
91
|
+
|
92
|
+
Destroys a specific NAS share.
|
93
|
+
|
94
|
+
**API Key Scope**: nas_shares / destroy
|
95
|
+
|
96
|
+
### Example
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
# load the gem
|
100
|
+
require 'nodeum_sdk'
|
101
|
+
# setup authorization
|
102
|
+
Nodeum.configure do |config|
|
103
|
+
# Configure HTTP basic authorization: BasicAuth
|
104
|
+
config.username = 'YOUR USERNAME'
|
105
|
+
config.password = 'YOUR PASSWORD'
|
106
|
+
|
107
|
+
# Configure API key authorization: BearerAuth
|
108
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
110
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = Nodeum::NasSharesApi.new
|
114
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
115
|
+
|
116
|
+
begin
|
117
|
+
#Destroys a specific NAS share.
|
118
|
+
api_instance.destroy_nas_share(nas_share_id)
|
119
|
+
rescue Nodeum::ApiError => e
|
120
|
+
puts "Exception when calling NasSharesApi->destroy_nas_share: #{e}"
|
121
|
+
end
|
122
|
+
```
|
123
|
+
|
124
|
+
### Parameters
|
125
|
+
|
126
|
+
|
127
|
+
Name | Type | Description | Notes
|
128
|
+
------------- | ------------- | ------------- | -------------
|
129
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
130
|
+
|
131
|
+
### Return type
|
132
|
+
|
133
|
+
nil (empty response body)
|
134
|
+
|
135
|
+
### Authorization
|
136
|
+
|
137
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
138
|
+
|
139
|
+
### HTTP request headers
|
140
|
+
|
141
|
+
- **Content-Type**: Not defined
|
142
|
+
- **Accept**: Not defined
|
143
|
+
|
144
|
+
|
145
|
+
## destroy_nas_share_by_nas
|
146
|
+
|
147
|
+
> destroy_nas_share_by_nas(nas_id, nas_share_id)
|
148
|
+
|
149
|
+
Destroys a specific NAS share.
|
150
|
+
|
151
|
+
**API Key Scope**: nas_shares / destroy
|
152
|
+
|
153
|
+
### Example
|
154
|
+
|
155
|
+
```ruby
|
156
|
+
# load the gem
|
157
|
+
require 'nodeum_sdk'
|
158
|
+
# setup authorization
|
159
|
+
Nodeum.configure do |config|
|
160
|
+
# Configure HTTP basic authorization: BasicAuth
|
161
|
+
config.username = 'YOUR USERNAME'
|
162
|
+
config.password = 'YOUR PASSWORD'
|
163
|
+
|
164
|
+
# Configure API key authorization: BearerAuth
|
165
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
166
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
167
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
168
|
+
end
|
169
|
+
|
170
|
+
api_instance = Nodeum::NasSharesApi.new
|
171
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
172
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
173
|
+
|
174
|
+
begin
|
175
|
+
#Destroys a specific NAS share.
|
176
|
+
api_instance.destroy_nas_share_by_nas(nas_id, nas_share_id)
|
177
|
+
rescue Nodeum::ApiError => e
|
178
|
+
puts "Exception when calling NasSharesApi->destroy_nas_share_by_nas: #{e}"
|
179
|
+
end
|
180
|
+
```
|
181
|
+
|
182
|
+
### Parameters
|
183
|
+
|
184
|
+
|
185
|
+
Name | Type | Description | Notes
|
186
|
+
------------- | ------------- | ------------- | -------------
|
187
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
188
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
189
|
+
|
190
|
+
### Return type
|
191
|
+
|
192
|
+
nil (empty response body)
|
193
|
+
|
194
|
+
### Authorization
|
195
|
+
|
196
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
197
|
+
|
198
|
+
### HTTP request headers
|
199
|
+
|
200
|
+
- **Content-Type**: Not defined
|
201
|
+
- **Accept**: Not defined
|
202
|
+
|
203
|
+
|
204
|
+
## destroy_nas_share_by_pool
|
205
|
+
|
206
|
+
> destroy_nas_share_by_pool(pool_id, nas_share_id)
|
207
|
+
|
208
|
+
Destroys a specific NAS share.
|
209
|
+
|
210
|
+
**API Key Scope**: nas_shares / destroy
|
211
|
+
|
212
|
+
### Example
|
213
|
+
|
214
|
+
```ruby
|
215
|
+
# load the gem
|
216
|
+
require 'nodeum_sdk'
|
217
|
+
# setup authorization
|
218
|
+
Nodeum.configure do |config|
|
219
|
+
# Configure HTTP basic authorization: BasicAuth
|
220
|
+
config.username = 'YOUR USERNAME'
|
221
|
+
config.password = 'YOUR PASSWORD'
|
222
|
+
|
223
|
+
# Configure API key authorization: BearerAuth
|
224
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
225
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
226
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
227
|
+
end
|
228
|
+
|
229
|
+
api_instance = Nodeum::NasSharesApi.new
|
230
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
231
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
232
|
+
|
233
|
+
begin
|
234
|
+
#Destroys a specific NAS share.
|
235
|
+
api_instance.destroy_nas_share_by_pool(pool_id, nas_share_id)
|
236
|
+
rescue Nodeum::ApiError => e
|
237
|
+
puts "Exception when calling NasSharesApi->destroy_nas_share_by_pool: #{e}"
|
238
|
+
end
|
239
|
+
```
|
240
|
+
|
241
|
+
### Parameters
|
242
|
+
|
243
|
+
|
244
|
+
Name | Type | Description | Notes
|
245
|
+
------------- | ------------- | ------------- | -------------
|
246
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
247
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
248
|
+
|
249
|
+
### Return type
|
250
|
+
|
251
|
+
nil (empty response body)
|
252
|
+
|
253
|
+
### Authorization
|
254
|
+
|
255
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
256
|
+
|
257
|
+
### HTTP request headers
|
258
|
+
|
259
|
+
- **Content-Type**: Not defined
|
260
|
+
- **Accept**: Not defined
|
261
|
+
|
262
|
+
|
263
|
+
## index_nas_shares
|
264
|
+
|
265
|
+
> NasShareCollection index_nas_shares(opts)
|
266
|
+
|
267
|
+
Lists all NAS shares.
|
268
|
+
|
269
|
+
**API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password
|
270
|
+
|
271
|
+
### Example
|
272
|
+
|
273
|
+
```ruby
|
274
|
+
# load the gem
|
275
|
+
require 'nodeum_sdk'
|
276
|
+
# setup authorization
|
277
|
+
Nodeum.configure do |config|
|
278
|
+
# Configure HTTP basic authorization: BasicAuth
|
279
|
+
config.username = 'YOUR USERNAME'
|
280
|
+
config.password = 'YOUR PASSWORD'
|
281
|
+
|
282
|
+
# Configure API key authorization: BearerAuth
|
283
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
284
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
285
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
286
|
+
end
|
287
|
+
|
288
|
+
api_instance = Nodeum::NasSharesApi.new
|
289
|
+
opts = {
|
290
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
291
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
292
|
+
sort_by: ['sort_by_example'], # Array<String> | Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
293
|
+
id: 'id_example', # String | Filter on id
|
294
|
+
name: 'name_example', # String | Filter on name
|
295
|
+
path: 'path_example', # String | Filter on path
|
296
|
+
options: 'options_example', # String | Filter on options
|
297
|
+
username: 'username_example', # String | Filter on username
|
298
|
+
nas_id: 'nas_id_example', # String | Filter on NAS id
|
299
|
+
pool_id: 'pool_id_example' # String | Filter on a pool id
|
300
|
+
}
|
301
|
+
|
302
|
+
begin
|
303
|
+
#Lists all NAS shares.
|
304
|
+
result = api_instance.index_nas_shares(opts)
|
305
|
+
p result
|
306
|
+
rescue Nodeum::ApiError => e
|
307
|
+
puts "Exception when calling NasSharesApi->index_nas_shares: #{e}"
|
308
|
+
end
|
309
|
+
```
|
310
|
+
|
311
|
+
### Parameters
|
312
|
+
|
313
|
+
|
314
|
+
Name | Type | Description | Notes
|
315
|
+
------------- | ------------- | ------------- | -------------
|
316
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
317
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
318
|
+
**sort_by** | [**Array<String>**](String.md)| Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. | [optional]
|
319
|
+
**id** | **String**| Filter on id | [optional]
|
320
|
+
**name** | **String**| Filter on name | [optional]
|
321
|
+
**path** | **String**| Filter on path | [optional]
|
322
|
+
**options** | **String**| Filter on options | [optional]
|
323
|
+
**username** | **String**| Filter on username | [optional]
|
324
|
+
**nas_id** | **String**| Filter on NAS id | [optional]
|
325
|
+
**pool_id** | **String**| Filter on a pool id | [optional]
|
326
|
+
|
327
|
+
### Return type
|
328
|
+
|
329
|
+
[**NasShareCollection**](NasShareCollection.md)
|
330
|
+
|
331
|
+
### Authorization
|
332
|
+
|
333
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
334
|
+
|
335
|
+
### HTTP request headers
|
336
|
+
|
337
|
+
- **Content-Type**: Not defined
|
338
|
+
- **Accept**: application/json
|
339
|
+
|
340
|
+
|
341
|
+
## index_nas_shares_by_nas
|
342
|
+
|
343
|
+
> NasShareCollection index_nas_shares_by_nas(nas_id, opts)
|
344
|
+
|
345
|
+
Lists all NAS shares.
|
346
|
+
|
347
|
+
**API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password
|
348
|
+
|
349
|
+
### Example
|
350
|
+
|
351
|
+
```ruby
|
352
|
+
# load the gem
|
353
|
+
require 'nodeum_sdk'
|
354
|
+
# setup authorization
|
355
|
+
Nodeum.configure do |config|
|
356
|
+
# Configure HTTP basic authorization: BasicAuth
|
357
|
+
config.username = 'YOUR USERNAME'
|
358
|
+
config.password = 'YOUR PASSWORD'
|
359
|
+
|
360
|
+
# Configure API key authorization: BearerAuth
|
361
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
362
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
363
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
364
|
+
end
|
365
|
+
|
366
|
+
api_instance = Nodeum::NasSharesApi.new
|
367
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
368
|
+
opts = {
|
369
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
370
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
371
|
+
sort_by: ['sort_by_example'], # Array<String> | Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
372
|
+
id: 'id_example', # String | Filter on id
|
373
|
+
name: 'name_example', # String | Filter on name
|
374
|
+
path: 'path_example', # String | Filter on path
|
375
|
+
options: 'options_example', # String | Filter on options
|
376
|
+
username: 'username_example', # String | Filter on username
|
377
|
+
pool_id: 'pool_id_example' # String | Filter on a pool id
|
378
|
+
}
|
379
|
+
|
380
|
+
begin
|
381
|
+
#Lists all NAS shares.
|
382
|
+
result = api_instance.index_nas_shares_by_nas(nas_id, opts)
|
383
|
+
p result
|
384
|
+
rescue Nodeum::ApiError => e
|
385
|
+
puts "Exception when calling NasSharesApi->index_nas_shares_by_nas: #{e}"
|
386
|
+
end
|
387
|
+
```
|
388
|
+
|
389
|
+
### Parameters
|
390
|
+
|
391
|
+
|
392
|
+
Name | Type | Description | Notes
|
393
|
+
------------- | ------------- | ------------- | -------------
|
394
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
395
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
396
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
397
|
+
**sort_by** | [**Array<String>**](String.md)| Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. | [optional]
|
398
|
+
**id** | **String**| Filter on id | [optional]
|
399
|
+
**name** | **String**| Filter on name | [optional]
|
400
|
+
**path** | **String**| Filter on path | [optional]
|
401
|
+
**options** | **String**| Filter on options | [optional]
|
402
|
+
**username** | **String**| Filter on username | [optional]
|
403
|
+
**pool_id** | **String**| Filter on a pool id | [optional]
|
404
|
+
|
405
|
+
### Return type
|
406
|
+
|
407
|
+
[**NasShareCollection**](NasShareCollection.md)
|
408
|
+
|
409
|
+
### Authorization
|
410
|
+
|
411
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
412
|
+
|
413
|
+
### HTTP request headers
|
414
|
+
|
415
|
+
- **Content-Type**: Not defined
|
416
|
+
- **Accept**: application/json
|
417
|
+
|
418
|
+
|
419
|
+
## index_nas_shares_by_pool
|
420
|
+
|
421
|
+
> NasShareCollection index_nas_shares_by_pool(pool_id, opts)
|
422
|
+
|
423
|
+
Lists all NAS shares from pool.
|
424
|
+
|
425
|
+
**API Key Scope**: nas_shares / index Optional API Key Explicit Scope: nas_shares / get_password
|
426
|
+
|
427
|
+
### Example
|
428
|
+
|
429
|
+
```ruby
|
430
|
+
# load the gem
|
431
|
+
require 'nodeum_sdk'
|
432
|
+
# setup authorization
|
433
|
+
Nodeum.configure do |config|
|
434
|
+
# Configure HTTP basic authorization: BasicAuth
|
435
|
+
config.username = 'YOUR USERNAME'
|
436
|
+
config.password = 'YOUR PASSWORD'
|
437
|
+
|
438
|
+
# Configure API key authorization: BearerAuth
|
439
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
440
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
441
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
442
|
+
end
|
443
|
+
|
444
|
+
api_instance = Nodeum::NasSharesApi.new
|
445
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
446
|
+
opts = {
|
447
|
+
limit: 56, # Integer | The number of items to display for pagination.
|
448
|
+
offset: 56, # Integer | The number of items to skip for pagination.
|
449
|
+
sort_by: ['sort_by_example'], # Array<String> | Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
|
450
|
+
id: 'id_example', # String | Filter on id
|
451
|
+
name: 'name_example', # String | Filter on name
|
452
|
+
path: 'path_example', # String | Filter on path
|
453
|
+
options: 'options_example', # String | Filter on options
|
454
|
+
username: 'username_example', # String | Filter on username
|
455
|
+
nas_id: 'nas_id_example' # String | Filter on NAS id
|
456
|
+
}
|
457
|
+
|
458
|
+
begin
|
459
|
+
#Lists all NAS shares from pool.
|
460
|
+
result = api_instance.index_nas_shares_by_pool(pool_id, opts)
|
461
|
+
p result
|
462
|
+
rescue Nodeum::ApiError => e
|
463
|
+
puts "Exception when calling NasSharesApi->index_nas_shares_by_pool: #{e}"
|
464
|
+
end
|
465
|
+
```
|
466
|
+
|
467
|
+
### Parameters
|
468
|
+
|
469
|
+
|
470
|
+
Name | Type | Description | Notes
|
471
|
+
------------- | ------------- | ------------- | -------------
|
472
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
473
|
+
**limit** | **Integer**| The number of items to display for pagination. | [optional]
|
474
|
+
**offset** | **Integer**| The number of items to skip for pagination. | [optional]
|
475
|
+
**sort_by** | [**Array<String>**](String.md)| Sort results by attribute. Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`. | [optional]
|
476
|
+
**id** | **String**| Filter on id | [optional]
|
477
|
+
**name** | **String**| Filter on name | [optional]
|
478
|
+
**path** | **String**| Filter on path | [optional]
|
479
|
+
**options** | **String**| Filter on options | [optional]
|
480
|
+
**username** | **String**| Filter on username | [optional]
|
481
|
+
**nas_id** | **String**| Filter on NAS id | [optional]
|
482
|
+
|
483
|
+
### Return type
|
484
|
+
|
485
|
+
[**NasShareCollection**](NasShareCollection.md)
|
486
|
+
|
487
|
+
### Authorization
|
488
|
+
|
489
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
490
|
+
|
491
|
+
### HTTP request headers
|
492
|
+
|
493
|
+
- **Content-Type**: Not defined
|
494
|
+
- **Accept**: application/json
|
495
|
+
|
496
|
+
|
497
|
+
## mount_status_nas_share
|
498
|
+
|
499
|
+
> MountStatus mount_status_nas_share(nas_share_id)
|
500
|
+
|
501
|
+
Get mount status of NAS Share.
|
502
|
+
|
503
|
+
**API Key Scope**: nas_shares / mount_status
|
504
|
+
|
505
|
+
### Example
|
506
|
+
|
507
|
+
```ruby
|
508
|
+
# load the gem
|
509
|
+
require 'nodeum_sdk'
|
510
|
+
# setup authorization
|
511
|
+
Nodeum.configure do |config|
|
512
|
+
# Configure HTTP basic authorization: BasicAuth
|
513
|
+
config.username = 'YOUR USERNAME'
|
514
|
+
config.password = 'YOUR PASSWORD'
|
515
|
+
|
516
|
+
# Configure API key authorization: BearerAuth
|
517
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
518
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
519
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
520
|
+
end
|
521
|
+
|
522
|
+
api_instance = Nodeum::NasSharesApi.new
|
523
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
524
|
+
|
525
|
+
begin
|
526
|
+
#Get mount status of NAS Share.
|
527
|
+
result = api_instance.mount_status_nas_share(nas_share_id)
|
528
|
+
p result
|
529
|
+
rescue Nodeum::ApiError => e
|
530
|
+
puts "Exception when calling NasSharesApi->mount_status_nas_share: #{e}"
|
531
|
+
end
|
532
|
+
```
|
533
|
+
|
534
|
+
### Parameters
|
535
|
+
|
536
|
+
|
537
|
+
Name | Type | Description | Notes
|
538
|
+
------------- | ------------- | ------------- | -------------
|
539
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
540
|
+
|
541
|
+
### Return type
|
542
|
+
|
543
|
+
[**MountStatus**](MountStatus.md)
|
544
|
+
|
545
|
+
### Authorization
|
546
|
+
|
547
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
548
|
+
|
549
|
+
### HTTP request headers
|
550
|
+
|
551
|
+
- **Content-Type**: Not defined
|
552
|
+
- **Accept**: application/json
|
553
|
+
|
554
|
+
|
555
|
+
## mount_status_nas_share_by_nas
|
556
|
+
|
557
|
+
> MountStatus mount_status_nas_share_by_nas(nas_id, nas_share_id)
|
558
|
+
|
559
|
+
Get mount status of NAS Share.
|
560
|
+
|
561
|
+
**API Key Scope**: nas_shares / mount_status
|
562
|
+
|
563
|
+
### Example
|
564
|
+
|
565
|
+
```ruby
|
566
|
+
# load the gem
|
567
|
+
require 'nodeum_sdk'
|
568
|
+
# setup authorization
|
569
|
+
Nodeum.configure do |config|
|
570
|
+
# Configure HTTP basic authorization: BasicAuth
|
571
|
+
config.username = 'YOUR USERNAME'
|
572
|
+
config.password = 'YOUR PASSWORD'
|
573
|
+
|
574
|
+
# Configure API key authorization: BearerAuth
|
575
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
576
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
577
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
578
|
+
end
|
579
|
+
|
580
|
+
api_instance = Nodeum::NasSharesApi.new
|
581
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
582
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
583
|
+
|
584
|
+
begin
|
585
|
+
#Get mount status of NAS Share.
|
586
|
+
result = api_instance.mount_status_nas_share_by_nas(nas_id, nas_share_id)
|
587
|
+
p result
|
588
|
+
rescue Nodeum::ApiError => e
|
589
|
+
puts "Exception when calling NasSharesApi->mount_status_nas_share_by_nas: #{e}"
|
590
|
+
end
|
591
|
+
```
|
592
|
+
|
593
|
+
### Parameters
|
594
|
+
|
595
|
+
|
596
|
+
Name | Type | Description | Notes
|
597
|
+
------------- | ------------- | ------------- | -------------
|
598
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
599
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
600
|
+
|
601
|
+
### Return type
|
602
|
+
|
603
|
+
[**MountStatus**](MountStatus.md)
|
604
|
+
|
605
|
+
### Authorization
|
606
|
+
|
607
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
608
|
+
|
609
|
+
### HTTP request headers
|
610
|
+
|
611
|
+
- **Content-Type**: Not defined
|
612
|
+
- **Accept**: application/json
|
613
|
+
|
614
|
+
|
615
|
+
## mount_status_nas_share_by_pool
|
616
|
+
|
617
|
+
> MountStatus mount_status_nas_share_by_pool(pool_id, nas_share_id)
|
618
|
+
|
619
|
+
Get mount status of NAS Share.
|
620
|
+
|
621
|
+
**API Key Scope**: nas_shares / mount_status
|
622
|
+
|
623
|
+
### Example
|
624
|
+
|
625
|
+
```ruby
|
626
|
+
# load the gem
|
627
|
+
require 'nodeum_sdk'
|
628
|
+
# setup authorization
|
629
|
+
Nodeum.configure do |config|
|
630
|
+
# Configure HTTP basic authorization: BasicAuth
|
631
|
+
config.username = 'YOUR USERNAME'
|
632
|
+
config.password = 'YOUR PASSWORD'
|
633
|
+
|
634
|
+
# Configure API key authorization: BearerAuth
|
635
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
636
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
637
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
638
|
+
end
|
639
|
+
|
640
|
+
api_instance = Nodeum::NasSharesApi.new
|
641
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
642
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
643
|
+
|
644
|
+
begin
|
645
|
+
#Get mount status of NAS Share.
|
646
|
+
result = api_instance.mount_status_nas_share_by_pool(pool_id, nas_share_id)
|
647
|
+
p result
|
648
|
+
rescue Nodeum::ApiError => e
|
649
|
+
puts "Exception when calling NasSharesApi->mount_status_nas_share_by_pool: #{e}"
|
650
|
+
end
|
651
|
+
```
|
652
|
+
|
653
|
+
### Parameters
|
654
|
+
|
655
|
+
|
656
|
+
Name | Type | Description | Notes
|
657
|
+
------------- | ------------- | ------------- | -------------
|
658
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
659
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
660
|
+
|
661
|
+
### Return type
|
662
|
+
|
663
|
+
[**MountStatus**](MountStatus.md)
|
664
|
+
|
665
|
+
### Authorization
|
666
|
+
|
667
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
668
|
+
|
669
|
+
### HTTP request headers
|
670
|
+
|
671
|
+
- **Content-Type**: Not defined
|
672
|
+
- **Accept**: application/json
|
673
|
+
|
674
|
+
|
675
|
+
## show_nas_share
|
676
|
+
|
677
|
+
> NasShare show_nas_share(nas_share_id)
|
678
|
+
|
679
|
+
Displays a specific NAS share.
|
680
|
+
|
681
|
+
**API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password
|
682
|
+
|
683
|
+
### Example
|
684
|
+
|
685
|
+
```ruby
|
686
|
+
# load the gem
|
687
|
+
require 'nodeum_sdk'
|
688
|
+
# setup authorization
|
689
|
+
Nodeum.configure do |config|
|
690
|
+
# Configure HTTP basic authorization: BasicAuth
|
691
|
+
config.username = 'YOUR USERNAME'
|
692
|
+
config.password = 'YOUR PASSWORD'
|
693
|
+
|
694
|
+
# Configure API key authorization: BearerAuth
|
695
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
696
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
697
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
698
|
+
end
|
699
|
+
|
700
|
+
api_instance = Nodeum::NasSharesApi.new
|
701
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
702
|
+
|
703
|
+
begin
|
704
|
+
#Displays a specific NAS share.
|
705
|
+
result = api_instance.show_nas_share(nas_share_id)
|
706
|
+
p result
|
707
|
+
rescue Nodeum::ApiError => e
|
708
|
+
puts "Exception when calling NasSharesApi->show_nas_share: #{e}"
|
709
|
+
end
|
710
|
+
```
|
711
|
+
|
712
|
+
### Parameters
|
713
|
+
|
714
|
+
|
715
|
+
Name | Type | Description | Notes
|
716
|
+
------------- | ------------- | ------------- | -------------
|
717
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
718
|
+
|
719
|
+
### Return type
|
720
|
+
|
721
|
+
[**NasShare**](NasShare.md)
|
722
|
+
|
723
|
+
### Authorization
|
724
|
+
|
725
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
726
|
+
|
727
|
+
### HTTP request headers
|
728
|
+
|
729
|
+
- **Content-Type**: Not defined
|
730
|
+
- **Accept**: application/json
|
731
|
+
|
732
|
+
|
733
|
+
## show_nas_share_by_nas
|
734
|
+
|
735
|
+
> NasShare show_nas_share_by_nas(nas_id, nas_share_id)
|
736
|
+
|
737
|
+
Displays a specific NAS share.
|
738
|
+
|
739
|
+
**API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password
|
740
|
+
|
741
|
+
### Example
|
742
|
+
|
743
|
+
```ruby
|
744
|
+
# load the gem
|
745
|
+
require 'nodeum_sdk'
|
746
|
+
# setup authorization
|
747
|
+
Nodeum.configure do |config|
|
748
|
+
# Configure HTTP basic authorization: BasicAuth
|
749
|
+
config.username = 'YOUR USERNAME'
|
750
|
+
config.password = 'YOUR PASSWORD'
|
751
|
+
|
752
|
+
# Configure API key authorization: BearerAuth
|
753
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
754
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
755
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
756
|
+
end
|
757
|
+
|
758
|
+
api_instance = Nodeum::NasSharesApi.new
|
759
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
760
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
761
|
+
|
762
|
+
begin
|
763
|
+
#Displays a specific NAS share.
|
764
|
+
result = api_instance.show_nas_share_by_nas(nas_id, nas_share_id)
|
765
|
+
p result
|
766
|
+
rescue Nodeum::ApiError => e
|
767
|
+
puts "Exception when calling NasSharesApi->show_nas_share_by_nas: #{e}"
|
768
|
+
end
|
769
|
+
```
|
770
|
+
|
771
|
+
### Parameters
|
772
|
+
|
773
|
+
|
774
|
+
Name | Type | Description | Notes
|
775
|
+
------------- | ------------- | ------------- | -------------
|
776
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
777
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
778
|
+
|
779
|
+
### Return type
|
780
|
+
|
781
|
+
[**NasShare**](NasShare.md)
|
782
|
+
|
783
|
+
### Authorization
|
784
|
+
|
785
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
786
|
+
|
787
|
+
### HTTP request headers
|
788
|
+
|
789
|
+
- **Content-Type**: Not defined
|
790
|
+
- **Accept**: application/json
|
791
|
+
|
792
|
+
|
793
|
+
## show_nas_share_by_pool
|
794
|
+
|
795
|
+
> NasShare show_nas_share_by_pool(pool_id, nas_share_id)
|
796
|
+
|
797
|
+
Displays a specific NAS share.
|
798
|
+
|
799
|
+
**API Key Scope**: nas_shares / show Optional API Key Explicit Scope: nas_shares / get_password
|
800
|
+
|
801
|
+
### Example
|
802
|
+
|
803
|
+
```ruby
|
804
|
+
# load the gem
|
805
|
+
require 'nodeum_sdk'
|
806
|
+
# setup authorization
|
807
|
+
Nodeum.configure do |config|
|
808
|
+
# Configure HTTP basic authorization: BasicAuth
|
809
|
+
config.username = 'YOUR USERNAME'
|
810
|
+
config.password = 'YOUR PASSWORD'
|
811
|
+
|
812
|
+
# Configure API key authorization: BearerAuth
|
813
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
814
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
815
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
816
|
+
end
|
817
|
+
|
818
|
+
api_instance = Nodeum::NasSharesApi.new
|
819
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
820
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
821
|
+
|
822
|
+
begin
|
823
|
+
#Displays a specific NAS share.
|
824
|
+
result = api_instance.show_nas_share_by_pool(pool_id, nas_share_id)
|
825
|
+
p result
|
826
|
+
rescue Nodeum::ApiError => e
|
827
|
+
puts "Exception when calling NasSharesApi->show_nas_share_by_pool: #{e}"
|
828
|
+
end
|
829
|
+
```
|
830
|
+
|
831
|
+
### Parameters
|
832
|
+
|
833
|
+
|
834
|
+
Name | Type | Description | Notes
|
835
|
+
------------- | ------------- | ------------- | -------------
|
836
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
837
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
838
|
+
|
839
|
+
### Return type
|
840
|
+
|
841
|
+
[**NasShare**](NasShare.md)
|
842
|
+
|
843
|
+
### Authorization
|
844
|
+
|
845
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
846
|
+
|
847
|
+
### HTTP request headers
|
848
|
+
|
849
|
+
- **Content-Type**: Not defined
|
850
|
+
- **Accept**: application/json
|
851
|
+
|
852
|
+
|
853
|
+
## test_nas_share
|
854
|
+
|
855
|
+
> ActiveJobStatus test_nas_share(nas_id, nas_share_body)
|
856
|
+
|
857
|
+
Test an unsaved NAS Share.
|
858
|
+
|
859
|
+
**API Key Scope**: nas_shares / test
|
860
|
+
|
861
|
+
### Example
|
862
|
+
|
863
|
+
```ruby
|
864
|
+
# load the gem
|
865
|
+
require 'nodeum_sdk'
|
866
|
+
# setup authorization
|
867
|
+
Nodeum.configure do |config|
|
868
|
+
# Configure HTTP basic authorization: BasicAuth
|
869
|
+
config.username = 'YOUR USERNAME'
|
870
|
+
config.password = 'YOUR PASSWORD'
|
871
|
+
|
872
|
+
# Configure API key authorization: BearerAuth
|
873
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
874
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
875
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
876
|
+
end
|
877
|
+
|
878
|
+
api_instance = Nodeum::NasSharesApi.new
|
879
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
880
|
+
nas_share_body = Nodeum::NasShare.new # NasShare |
|
881
|
+
|
882
|
+
begin
|
883
|
+
#Test an unsaved NAS Share.
|
884
|
+
result = api_instance.test_nas_share(nas_id, nas_share_body)
|
885
|
+
p result
|
886
|
+
rescue Nodeum::ApiError => e
|
887
|
+
puts "Exception when calling NasSharesApi->test_nas_share: #{e}"
|
888
|
+
end
|
889
|
+
```
|
890
|
+
|
891
|
+
### Parameters
|
892
|
+
|
893
|
+
|
894
|
+
Name | Type | Description | Notes
|
895
|
+
------------- | ------------- | ------------- | -------------
|
896
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
897
|
+
**nas_share_body** | [**NasShare**](NasShare.md)| |
|
898
|
+
|
899
|
+
### Return type
|
900
|
+
|
901
|
+
[**ActiveJobStatus**](ActiveJobStatus.md)
|
902
|
+
|
903
|
+
### Authorization
|
904
|
+
|
905
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
906
|
+
|
907
|
+
### HTTP request headers
|
908
|
+
|
909
|
+
- **Content-Type**: application/json
|
910
|
+
- **Accept**: application/json, queued, working, failed
|
911
|
+
|
912
|
+
|
913
|
+
## test_result_nas_share
|
914
|
+
|
915
|
+
> ActiveJobStatus test_result_nas_share(nas_id, job_id)
|
916
|
+
|
917
|
+
Check result of a NAS Share test job.
|
918
|
+
|
919
|
+
**API Key Scope**: nas_shares / test
|
920
|
+
|
921
|
+
### Example
|
922
|
+
|
923
|
+
```ruby
|
924
|
+
# load the gem
|
925
|
+
require 'nodeum_sdk'
|
926
|
+
# setup authorization
|
927
|
+
Nodeum.configure do |config|
|
928
|
+
# Configure HTTP basic authorization: BasicAuth
|
929
|
+
config.username = 'YOUR USERNAME'
|
930
|
+
config.password = 'YOUR PASSWORD'
|
931
|
+
|
932
|
+
# Configure API key authorization: BearerAuth
|
933
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
934
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
935
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
936
|
+
end
|
937
|
+
|
938
|
+
api_instance = Nodeum::NasSharesApi.new
|
939
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
940
|
+
job_id = 'job_id_example' # String | ID of active job
|
941
|
+
|
942
|
+
begin
|
943
|
+
#Check result of a NAS Share test job.
|
944
|
+
result = api_instance.test_result_nas_share(nas_id, job_id)
|
945
|
+
p result
|
946
|
+
rescue Nodeum::ApiError => e
|
947
|
+
puts "Exception when calling NasSharesApi->test_result_nas_share: #{e}"
|
948
|
+
end
|
949
|
+
```
|
950
|
+
|
951
|
+
### Parameters
|
952
|
+
|
953
|
+
|
954
|
+
Name | Type | Description | Notes
|
955
|
+
------------- | ------------- | ------------- | -------------
|
956
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
957
|
+
**job_id** | **String**| ID of active job |
|
958
|
+
|
959
|
+
### Return type
|
960
|
+
|
961
|
+
[**ActiveJobStatus**](ActiveJobStatus.md)
|
962
|
+
|
963
|
+
### Authorization
|
964
|
+
|
965
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
966
|
+
|
967
|
+
### HTTP request headers
|
968
|
+
|
969
|
+
- **Content-Type**: Not defined
|
970
|
+
- **Accept**: application/json, queued, working, failed
|
971
|
+
|
972
|
+
|
973
|
+
## update_nas_share
|
974
|
+
|
975
|
+
> NasShare update_nas_share(nas_share_id, nas_share_body)
|
976
|
+
|
977
|
+
Updates a specific NAS share.
|
978
|
+
|
979
|
+
**API Key Scope**: nas_shares / update
|
980
|
+
|
981
|
+
### Example
|
982
|
+
|
983
|
+
```ruby
|
984
|
+
# load the gem
|
985
|
+
require 'nodeum_sdk'
|
986
|
+
# setup authorization
|
987
|
+
Nodeum.configure do |config|
|
988
|
+
# Configure HTTP basic authorization: BasicAuth
|
989
|
+
config.username = 'YOUR USERNAME'
|
990
|
+
config.password = 'YOUR PASSWORD'
|
991
|
+
|
992
|
+
# Configure API key authorization: BearerAuth
|
993
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
994
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
995
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
996
|
+
end
|
997
|
+
|
998
|
+
api_instance = Nodeum::NasSharesApi.new
|
999
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
1000
|
+
nas_share_body = Nodeum::NasShare.new # NasShare |
|
1001
|
+
|
1002
|
+
begin
|
1003
|
+
#Updates a specific NAS share.
|
1004
|
+
result = api_instance.update_nas_share(nas_share_id, nas_share_body)
|
1005
|
+
p result
|
1006
|
+
rescue Nodeum::ApiError => e
|
1007
|
+
puts "Exception when calling NasSharesApi->update_nas_share: #{e}"
|
1008
|
+
end
|
1009
|
+
```
|
1010
|
+
|
1011
|
+
### Parameters
|
1012
|
+
|
1013
|
+
|
1014
|
+
Name | Type | Description | Notes
|
1015
|
+
------------- | ------------- | ------------- | -------------
|
1016
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
1017
|
+
**nas_share_body** | [**NasShare**](NasShare.md)| |
|
1018
|
+
|
1019
|
+
### Return type
|
1020
|
+
|
1021
|
+
[**NasShare**](NasShare.md)
|
1022
|
+
|
1023
|
+
### Authorization
|
1024
|
+
|
1025
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
1026
|
+
|
1027
|
+
### HTTP request headers
|
1028
|
+
|
1029
|
+
- **Content-Type**: application/json
|
1030
|
+
- **Accept**: application/json
|
1031
|
+
|
1032
|
+
|
1033
|
+
## update_nas_share_by_nas
|
1034
|
+
|
1035
|
+
> NasShare update_nas_share_by_nas(nas_id, nas_share_id, nas_share_body)
|
1036
|
+
|
1037
|
+
Updates a specific NAS share.
|
1038
|
+
|
1039
|
+
**API Key Scope**: nas_shares / update
|
1040
|
+
|
1041
|
+
### Example
|
1042
|
+
|
1043
|
+
```ruby
|
1044
|
+
# load the gem
|
1045
|
+
require 'nodeum_sdk'
|
1046
|
+
# setup authorization
|
1047
|
+
Nodeum.configure do |config|
|
1048
|
+
# Configure HTTP basic authorization: BasicAuth
|
1049
|
+
config.username = 'YOUR USERNAME'
|
1050
|
+
config.password = 'YOUR PASSWORD'
|
1051
|
+
|
1052
|
+
# Configure API key authorization: BearerAuth
|
1053
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1054
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1055
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
api_instance = Nodeum::NasSharesApi.new
|
1059
|
+
nas_id = 'nas_id_example' # String | Numeric ID or name of NAS.
|
1060
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
1061
|
+
nas_share_body = Nodeum::NasShare.new # NasShare |
|
1062
|
+
|
1063
|
+
begin
|
1064
|
+
#Updates a specific NAS share.
|
1065
|
+
result = api_instance.update_nas_share_by_nas(nas_id, nas_share_id, nas_share_body)
|
1066
|
+
p result
|
1067
|
+
rescue Nodeum::ApiError => e
|
1068
|
+
puts "Exception when calling NasSharesApi->update_nas_share_by_nas: #{e}"
|
1069
|
+
end
|
1070
|
+
```
|
1071
|
+
|
1072
|
+
### Parameters
|
1073
|
+
|
1074
|
+
|
1075
|
+
Name | Type | Description | Notes
|
1076
|
+
------------- | ------------- | ------------- | -------------
|
1077
|
+
**nas_id** | **String**| Numeric ID or name of NAS. |
|
1078
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
1079
|
+
**nas_share_body** | [**NasShare**](NasShare.md)| |
|
1080
|
+
|
1081
|
+
### Return type
|
1082
|
+
|
1083
|
+
[**NasShare**](NasShare.md)
|
1084
|
+
|
1085
|
+
### Authorization
|
1086
|
+
|
1087
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
1088
|
+
|
1089
|
+
### HTTP request headers
|
1090
|
+
|
1091
|
+
- **Content-Type**: application/json
|
1092
|
+
- **Accept**: application/json
|
1093
|
+
|
1094
|
+
|
1095
|
+
## update_nas_share_by_pool
|
1096
|
+
|
1097
|
+
> NasShare update_nas_share_by_pool(pool_id, nas_share_id, nas_share_body)
|
1098
|
+
|
1099
|
+
Updates a specific NAS share.
|
1100
|
+
|
1101
|
+
**API Key Scope**: nas_shares / update
|
1102
|
+
|
1103
|
+
### Example
|
1104
|
+
|
1105
|
+
```ruby
|
1106
|
+
# load the gem
|
1107
|
+
require 'nodeum_sdk'
|
1108
|
+
# setup authorization
|
1109
|
+
Nodeum.configure do |config|
|
1110
|
+
# Configure HTTP basic authorization: BasicAuth
|
1111
|
+
config.username = 'YOUR USERNAME'
|
1112
|
+
config.password = 'YOUR PASSWORD'
|
1113
|
+
|
1114
|
+
# Configure API key authorization: BearerAuth
|
1115
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1116
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1117
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
api_instance = Nodeum::NasSharesApi.new
|
1121
|
+
pool_id = 'pool_id_example' # String | Numeric ID, or name of pool.
|
1122
|
+
nas_share_id = 'nas_share_id_example' # String | Numeric ID or name of NAS share.
|
1123
|
+
nas_share_body = Nodeum::NasShare.new # NasShare |
|
1124
|
+
|
1125
|
+
begin
|
1126
|
+
#Updates a specific NAS share.
|
1127
|
+
result = api_instance.update_nas_share_by_pool(pool_id, nas_share_id, nas_share_body)
|
1128
|
+
p result
|
1129
|
+
rescue Nodeum::ApiError => e
|
1130
|
+
puts "Exception when calling NasSharesApi->update_nas_share_by_pool: #{e}"
|
1131
|
+
end
|
1132
|
+
```
|
1133
|
+
|
1134
|
+
### Parameters
|
1135
|
+
|
1136
|
+
|
1137
|
+
Name | Type | Description | Notes
|
1138
|
+
------------- | ------------- | ------------- | -------------
|
1139
|
+
**pool_id** | **String**| Numeric ID, or name of pool. |
|
1140
|
+
**nas_share_id** | **String**| Numeric ID or name of NAS share. |
|
1141
|
+
**nas_share_body** | [**NasShare**](NasShare.md)| |
|
1142
|
+
|
1143
|
+
### Return type
|
1144
|
+
|
1145
|
+
[**NasShare**](NasShare.md)
|
1146
|
+
|
1147
|
+
### Authorization
|
1148
|
+
|
1149
|
+
[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
|
1150
|
+
|
1151
|
+
### HTTP request headers
|
1152
|
+
|
1153
|
+
- **Content-Type**: application/json
|
1154
|
+
- **Accept**: application/json
|
1155
|
+
|