Oracle FS System Resources

The Oracle FS System RESTful API provides a resource view of the world. A resource is any entity that is identified by an ID or fully qualified name (FQN).

The following Oracle FS System entities are accessible as resources with IDs or FQNs using the HTTP GET, PUT, POST, and DELETE commands. Unless otherwise noted, the IDs or FQNs are of the entities themselves.

Note: Your Oracle FS System might not support all of the resources listed.

Table 1 Resources with IDs
Resource	URI resource fragment	Notes
Account	/account
Enclosure	/enclosure
Cifs	/cifs	Using File Server as its ID or FQN
Cifs Share	/cifs_share
Clone Filesystem	/clone_filesystem
Clone LUN	/clone_lun
Event notification	/event_notification
File Server	/fileserver
Filesystem	/filesystem
Host group	/host_group
Host map	/hostmap
iSCSI	/iscsi	Using the Controller ID or FQN to retrieve Controller‑specific iSCSI settings
Job	/job
Log Bundle	/system_log
LUN	/lun
NDMP	/ndmp
NFS	/nfs	Using File Server as its ID or FQN
NFS Export	/nfs_export
NFS Host	/nfs_host
Profile	/profile
Report	/report
SAN host	/san_host
Controller	/controller
Snapshot	/snapshot	Using source filesystem ID or FQN
Snapshot Schedule	/snapshot_schedule
SNMP Host	/snmp_host
Storage Domain	/storage_domain /drive_group
System Alert	/system_alert
Task	/task
UPS	/ups
VIF	/vif
Volume Group	/volume_group

The following Oracle FS System resources are accessible as pseudo-resources as there is no ID required due to the global nature of the entity:

Table 2 Resources that do not have IDs
Resource	URI resource fragment	Notes
Call Home	/call_home
Errors	/errors
Event Log	/event_log
Haltpoint	/haltpoint
NAS	/nas	Retrieves NAS service status
Pilot	/pilot
Quota	/quota
Route	/route
SAN	/san
Software Update	/software_update
Statistics	/statistics
System	/system
Time	/time
Version	/version

The following Oracle FS System resources are partially supported by the RESTful API:

Table 3 Partially-supported resources
Resource	URI resource fragment	Notes
Enclosure Console	enclosure_console	The API supports commands that open, close, write, and read the console. The API does not support the option to do a polling read.
Storage Allocation	storage_allocation

The Oracle FS System RESTful API employs the following HTTP verbs to implement Oracle FS System monitoring and management functions: GET, POST, PUT, and DELETE. The following table shows how the HTTP verbs are mapped to the Oracle FS CLI subcommand calls:

Table 4 Mapping HTTP verbs to FSCLI subcommands
Action	HTTP verb	FSCLI subcommand	Notes
Create a resource	POST	-add	The message body contains the options for creating the resource of the POST request. The message body is either an XML format or a JSON format and contains the minimum options required for the resource in question. The response is the ID and FQN of the created object.
Modify a resource	PUT	-modify	The URI must contain the resource ID. A message body must be provided with the PUT request and contain the properties that you want to change. This action must be idempotent.
Delete a resource	DELETE	-delete	If you provide the resource ID in the URI, the specified resource is deleted. If you do not provide the resource ID in the URI, you must provide a message body with the options that identify a collection of resources to delete. This action must be idempotent.
Display resource by ID	GET	-list -details	Retrieving by only specifying the ID in the URI returns the details of the resource. The basic FSCLI response is returned.
Display a collection of resources	GET	-list	By providing only the resource in the URI, the current FSCLI response is returned, namely, the ID and FQN for each resource instance. Any additional options supported by a given FSCLI command must be provided in a CGI query string format on the URI. This action must be idempotent.
Perform a command	POST	Any commands that do an action.	The resource ID may or may not be required based on the command. The command itself is included in the URI following the ID.