- Notes, cautions, and warnings
- Introduction to this guide
- Introduction to the OneFS API
- System configuration API
- System configuration API overview
- System configuration API resources
- Authentication and access control overview
- Authentication classes
- Authentication resources
- Authentication access token resource
- Authentication user access resource
- Security objects cache resource
- Authentication user password resource
- Authentication users resource
- Authentication users member of resource
- Authentication groups resource
- Authentication groups members resource
- Authentication netgroups resource
- Authentication settings mapping resource
- Authentication mapping identities resource
- Authentication mapping users rules resource
- Authentication mapping users lookup resource
- Authentication providers summary resource
- Authentication Kerberos providers resource
- Authentication settings krb5 defaults resource
- Authentication settings krb5 realms resource
- Authentication settings krb5 domains resource
- LDAP provider template resources
- Authentication ADS providers domains resource
- Authentication ADS providers resource
- Authentication ADS providers controllers resource
- Authentication ADS providers search resource
- Authentication Duo provider resource
- Authentication file providers resource
- Authentication LDAP providers resource
- Authentication local providers resource
- Authentication NIS providers resource
- Authentication settings ACL resource
- Authentication privileges resource
- Authentication roles resource
- Authentication roles members resource
- Authentication roles privileges resource
- Authentication global settings resource
- Authentication shells resource
- Authentication well-known resource
- Configured TLS certificate authority resource
- Configured TLS server certificate resources
- Configured TLS certificate settings resource
- Authentication error resource
- ID resolution resource
- ID resolution domains resource
- ID resolution LIN resource
- ID resolution zones resource
- ID resolution zone groups resource
- ID resolution zones users resource
- Authentication API examples
- Change a user password
- Create a local group
- Modify a local group
- Add a member to a local group
- Create a user
- Modify a user
- Join a domain
- Modify an ADS provider
- Create an LDAP provider
- Modify an LDAP provider
- Modify a local provider
- Create an authentication role
- Modify an authentication role
- Modify global authentication settings
- Create a krb5 realm
- Create a krb5 domain
- Modify krb5 domains
- Modify krb5 settings
- Auditing overview
- Data Security overview
- NFS security
- NFS classes
- NFS resources
- NFS exports summary resource
- NFS exports resource
- NFS check resource
- NFS aliases resource
- NFS NLM locks resource
- NFS NLM lock waiters resource
- NFS NLM sessions resource
- NFS NLM sessions check resource
- NFS log level resource
- NFS netgroup resource
- NFS netgroup check resource
- NFS netgroup flush resource
- NFS default export settings resource
- NFS global settings resource
- NFS exports configuration check resource
- NFS zone settings resource
- NFS reload resource
- NFS API examples
- SMB
- S3
- FTP
- HTTP and HTTPS security
- HDFS security
- OpenStack Swift
- Networking
- Network resources
- Network external resource
- Network subnets resource
- Network DNS cache resource
- Network DNS cache flush resource
- Network interfaces resource
- Network pools resource
- Network rules resource
- Network SmartConnect rebalance all IP resource
- Network groupnets resource
- Network groupnets subnets resource
- Network groupnets subnets pools resource
- Network groupnets subnets pools interfaces resource
- Network groupnets subnets pools rebalance IP resource
- Network groupnets subnets pools rules resource
- Network groupnets subnets pools SmartConnect suspend nodes resource
- Network groupnets subnets pools SmartConnect resume nodes resource
- Network resources
- IPMI remote power
- System jobs overview
- Cluster statistics
- Statistics resources
- Statistics current resource
- Statistics keys resource
- Statistics history resource
- Statistics operations resource
- Statistics protocols resource
- Statistics summary client resource
- Statistics summary drive resource
- Statistics summary heat resource
- Statistics summary protocol resource
- Statistics summary protocol stats resource
- Statistics summary system resource
- Statistics summary workload resource
- Statistics resources
- FSA
- Events and alerts
- HealthCheck
- Snapshots overview
- Snapshots resources
- Snapshot license resource
- Snapshot summary resource
- Snapshots resource
- Snapshot schedules resource
- Snapshot locks resource
- Snapshot pending resource
- Snapshot aliases resource
- Snapshot changelists resource
- Snapshot changelists changelist lins resource
- Snapshot changelists changelist resource
- Snapshot repstates resource
- Snapshot settings resource
- Writable snapshot resources
- Snapshots API examples
- Snapshots resources
- NDMP backup and recovery
- SyncIQ data replication overview
- Sync resources
- File matching patterns
- Sync license resource
- Sync certificates server resource
- Sync certificates peer resource
- Sync jobs resource
- Sync policies resource
- Sync policies reset resource
- Sync reports resource
- Sync reports rotate resource
- Sync target policies resource
- Sync target policies cancel resource
- SyncIQ target reports resource
- Sync service policies resource
- Sync service policies reset resource
- Sync service target policies reset resource
- Sync service target policies cancel resource
- Sync rules resource
- Sync settings resource
- Sync advanced settings resource
- Sync history CPU resource
- Sync history file resource
- Sync history network resource
- Sync history worker resource
- SyncIQ API examples
- Sync resources
- SmartLock overview
- Deduplication overview
- General cluster configuration
- General cluster configuration resources
- Cluster configuration backup and restore resources
- Cluster configuration resource
- Cluster configuration join mode resource
- Cluster email resource
- Cluster identity resource
- Cluster internal networks resource
- Cluster nodes resource
- Cluster add node resource
- Cluster nodes available resource
- Cluster nodes LNN resource
- Cluster update LNN resource
- Cluster nodes LNN drive config resource
- Cluster nodes LNN drives resource
- Cluster nodes LNN drives purpose list resource
- Cluster nodes LNN drive ID resource
- Cluster nodes LNN drives add drive ID resource
- Cluster nodes LNN drives and drive ID firmware resource
- Cluster nodes LNN drives and drive ID firmware update resource
- Cluster nodes LNN drives and drive ID format resource
- Cluster nodes LNN drives and drive ID purpose resource
- Cluster nodes LNN drives and drive ID smartfail resource
- Cluster nodes LNN drives and drive ID stop fail resource
- Cluster nodes LNN drives and drive ID suspend resource
- Cluster nodes LNN hardware resource
- Cluster nodes LNN internal IP address resource
- Cluster nodes LNN partitions resource
- Cluster nodes LNN reboot resource
- Cluster nodes LNN sensors resource
- Cluster nodes LNN shutdown resource
- Cluster nodes LNN sleds resource
- Cluster nodes LNN sleds sledid resource
- Cluster nodes LNN state resource
- Cluster nodes LNN state read-only resource
- Cluster nodes LNN state service light resource
- Cluster nodes LNN state smartfail resource
- Cluster nodes LNN status
- Cluster nodes LNN status battery status resource
- Cluster nodes LNN status CPU status resource
- Cluster nodes LNN status nonvolatile RAM status resource
- Cluster nodes LNN status power supplies status resource
- Local cluster nodes resource
- Local cluster nodes LNN resource
- Local cluster nodes LNN drives resource
- Local cluster nodes LNN drive config resource
- Local cluster nodes LNN drives firmware resource
- Local cluster nodes LNN internal IP address resource
- Cluster owner resource
- Cluster file system statistics resource
- Cluster time resource
- Cluster time zone resource
- Cluster time zone regions resource
- Cluster time zone settings resource
- Local cluster time resource
- Cluster version resource
- SSH settings resource
- IP address pools
- Structure of the file system
- General cluster configuration resources
- Licensing
- Security hardening
- External key management for SEDs using KMIP
- Upgrading OneFS
- Upgrade cluster resources
- Upgrade cluster resource
- Upgrade cluster pause resource
- Upgrade cluster resume resource
- Upgrade cluster upgrade resource
- Upgrade cluster assess resource
- Upgrade cluster commit resource
- Upgrade cluster add remaining nodes resource
- Upgrade cluster archive resource
- Upgrade cluster nodes resource
- Upgrade cluster nodes firmware status resource
- Upgrade cluster nodes patch synchronization resource
- Upgrade cluster firmware assess resource
- Upgrade cluster firmware progress resource
- Upgrade cluster firmware status resource
- Upgrade cluster firmware upgrade resource
- Upgrade cluster retry last action resource
- Upgrade cluster rollback resource
- Upgrade cluster rolling reboot resource
- Upgrade cluster patch resource
- Upgrade cluster patch abort resource
- Upgrade cluster drain resources
- Upgrade cluster resources
- Cluster date and time
- Managing SNMP settings
- Hardware
- File pools
- Storage pools overview
- Storage pools resources
- Storage pool settings resource
- Storage pools tiers resource
- Storage pools node pools resource
- Storage pools resource
- Storage pools suggested protection resource
- Storage pool compatibilities SSD active resource
- Storage pool compatibilities SSD available resource
- Storage pool compatibilities class available resource
- Storage pool compatibilities class active resource
- Storage pool status resource
- Storage pools API examples
- Storage pools resources
- CloudPools
- CloudPools resources
- CloudPools pools resource
- CloudPools access resource
- CloudPools account resource
- CloudPools TLS client certificates resource
- CloudPools jobs resource
- CloudPools job files resource
- CloudPools network proxy resourceCloudPools network proxy resource
- CloudPools settings resource
- CloudPools encryption key resource
- CloudPools end user license agreement resource
- CloudPools resources
- SmartQuotas overview
- Common Anti-Virus Agent (CAVA)
- ICAP anti-virus
- Performance
- Authentication and access control overview
- File system access API
- File system access API overview
- Troubleshooting
- File system access operations
- Access points
- Directory operations
- File operations
- Access control lists
- Access control personas
- Access rights for directories
- Access rights for files
- Access rights for files and directories
- Inherited access rights
- Get the ACL of a directory
- Get the ACL of a file
- Set the ACL for a directory when the directory is created
- Set the ACL for a file when the file is created
- Set the ACL of a directory
- Set the ACL of a file
- Query operations
- SmartLock settings
PowerScale OneFS API Reference
System configuration API overview
You can access cluster configuration, status information, and file system content through objects and collections of objects. These objects and collections are exposed as resource URIs, which are represented as JavaScript Object Notation (JSON) formatted documents.
Please provide ratings (1-5 stars).
Please provide ratings (1-5 stars).
Please provide ratings (1-5 stars).
Please select whether the article was helpful or not.
Comments cannot contain these special characters: <>()\