APIs in Category: resource
API version 6.1

 
resource-lookup
APIs are provided for resolving managed resources to their corresponding resource keys. The resource keys can then be used as input to other management APIs.

NetApp Manage ONTAP
 
resource-lookup [top]

Lookup a managed resource by its fully qualified name. Returns the resource key for the managed resource.
Input Name Range Type Description
qualified-name string
The fully qualified name of the managed resource. The format of the qualified name for each resource type is defined as follows ({placeholders} that should be substituted with actual values): Data ONTAP resource types:
  • aggregate: {cluster-node-name}:{aggregate-name}
  • cluster: {cluster-name}
  • cluster_node: {cluster-node-name}
  • disk: {disk-name}
  • export_policy: {vserver-name}:{export-policy-name}
  • lun: {vserver-name}:/{volume-name}/{lun-name} or {vserver-name}:/{volume-name}/{qtree-name}/{lun-name}
  • network_lif: {owner-name}:{lif-name} where {owner-name} can be any of: {cluster-name} or {cluster-node-name} or {vserver-name}
  • network_port: {cluster-node-name}:{network-port-name}
  • qtree: {vserver-name}:/{volume-name}/{qtree-name}
  • snap_mirror: {source-vserver-name}:{source-volume-name} ->{dest-vserver-name}:{dest-volume-name}
  • snapshot: {vserver-name}:/{volume-name}:{snapshot-name}
  • storage_class: {vserver-name}:{storage-class-name}
  • storage_shelf: {cluster-node-name}:{channel-name}:{shelf-identifier}
  • volume: {vserver-name}:/{volume-name}
  • vserver: {vserver-name}
OnCommand resource types:
  • resource_pool: {resource-pool-name}
  • service_workflow: {service-workflow-name}
  • storage_service: {storage-service-name}
  • storage_service_node: {storage-service-name}:{storage-service-node-name}
  • storage_service_connection: {storage-service-name}:{source-node-name} ->{storage-service-name}:{destination-node-name}
type resource-type
Specifies the type of the managed resource being looked up. Not all resource types support lookup by name. See the documentation of qualified-name for a list of supported resource types and their name formats.
 
Output Name Range Type Description
resource-key resource-key
The resource key that represents the managed resource.
 Errno  Description
 EOBJECTNOTFOUND
 EOBJECTAMBIGUOUS
 EINVALIDOBJECTTYPE
 EINVALIDINPUT

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]

 
Element definition: resource-type [top]
A canonical type name for a managed resource. Includes both Data ONTAP and OnCommand resource types. Valid Data ONTAP resource types:
  • aggregate
  • cluster
  • cluster_node
  • disk
  • export_policy
  • export_rule
  • fcp_lif
  • fcp_port
  • flash_device
  • igroup
  • iscsi_portal_group
  • lun
  • lun_mapping
  • network_lif
  • network_port
  • ontap_job_schedule
  • plex
  • portset
  • qtree
  • raid_group
  • routing_group
  • service_processor
  • sis_policy
  • snap_mirror
  • snapshot
  • snapshot_policy
  • snapshot_policy_schedule
  • storage_class
  • storage_shelf
  • volume
  • volume_move
  • vserver
Valid OnCommand resource types:
  • management_station
  • resource_pool
  • service_workflow
  • storage_service
  • storage_service_connection
  • storage_service_node
[none]