Find Host operation

The Find Host operation finds details of Host or Hosts which satisfy the search criteria.

The following table describes the elements for this request.

Adapter request elements for the Find Host operation

Element	Definition	Required
<operation-name>	Specifies the name of the operation: find-host-inventory	Yes
<arguments>	Specifies a list of arguments required for the operation	Yes
<targets>	Contains the parent XML element for the <target> element, which specifies the dynamic targets	Conditional; required if the adapter configuration is empty in Grid Manager
<target>	Contains the child XML <targets> element, which specifies the dynamic targets Using dynamic targets, you can define connection information for a remote host in an adapter request. This capability enables you to configure an adapter in Grid Manager by specifying configuration information in an adapter request. This XML element can have <host>, <user-name>, <password>, <protocol>, and <port> as its child elements. Notes An adapter configuration specified by using request-level dynamic targets takes precedence over Grid Manager level configuration information. If you specify the request-level dynamic target by using <targets>, the request ignores the <targets> element that is a child of the <arguments> element.	Conditional; required if <targets> is present in the adapter request
<host>	Specifies the host name or IP address of the server on which NetApp DataFabric Manager is running	Conditional; required if <targets> is present in the adapter request
<user-name>	Specifies the user name required to log on to the NetApp DataFabric Manager	Conditional; required if <targets> is present in the adapter request
<password>	Specifies the password that corresponds to the <user-name> The <password> element can contain an encryption-type attribute. The encryption-type attribute indicates whether the password specified is encrypted. Valid values for encryption-type attribute: Base64, Plain (default)	Conditional; required if <targets> is present in the adapter request
<protocol>	Specifies the communication protocol used by the adapter Valid values: http (default), https	No
<port>	Specifies the port on which NetApp DataFabric Manager is enabled Default values: 8088 (http), 8488 (https)	No
<target>	Specifies the child XML element of the <arguments> element You can use this element to specify the connection information for a DFM server. You can use a comma-separated list of configuration names, which executes the request simultaneously on all DFM servers identified by the configuration names. Valid values: The values specified for the <target> XML element must be the same as the values that have been specified for the name attribute of the <config> element in the Grid Manager adapter configuration. You can provide "ALL" as the value. In this case, the request is executed on all the DFM servers defined in the Grid Manager adapter configuration. You can specify multiple comma-separated names to allow for simultaneous execution of requests across multiple DFM servers. You can skip this element. In this case, the request is executed on the first defined Grid Manager adapter configuration. You can leave this element empty. In this case, the request is executed on the first defined Grid Manager adapter configuration. Note If you specify a request-level dynamic target by using <targets>, the request ignores this element.	No
<host-dp-filter-info	Specifies the parent element that holds search parameter values specific to the data protection policy	No
<expand-filer-to-vfilers>	Specifies whether to return all the vfiler units belonging to the storage system If this is true and the <object-name-or-id> is a storage system and the host-types contains "vfiler" then all vFiler units belonging to the storage system are returned, else it is ignored. Valid values: true, false (default)	No
<is-dp-ignored>	Lists aggregates that have been set to be ignored for data protection If false, the request lists only aggregates that have not been set to be ignored for data protection. If not specified, lists all aggregates without taking into account whether they have been ignored or not.	No
<is-in-dataset>	Lists hosts that are in a dataset only Valid values: true, false (default)	No
<is-in-resourcepool>	Lists hosts that are in a resource pool only Valid values: true, false (default)	No
<is-snapmirrored-only>	Lists SnapMirror hosts only Indicates a boolean field A host could be either a source or a destination for the SnapMirror. Valid values: true, false (default)	No
<is-snapvault-primary-only>	Lists the SnapVault primary systems Valid values: true, false (default)	No
<is-snapvault-secondary-only>	Lists the SnapVault secondary systems Valid values: true, false (default)	No
<is-unprotected>	Lists hosts that are not protected, which means it is: Not in any resource pool Not a member of a node in a dataset with protection policy assigned If false or not set, list all hosts.	No
<host-types>	Contains a parent element that holds different host-type values, which need to be included in the search A host-types element can hold multiple host-type values.	No
<host-type>	Holds values of the host-type that need to be included in the search Valid values: filer, vfiler, cluster, vserver, agent, ossv, and switch Multiple host-type values may be specified in the <host-types> element as follows: <host-types> <host-type>filer</host-type> <host-type>cluster</host-type> ... ... ... </host-types>	No
<include-is-available>	Calculates the <is-available status> for each host, which may increase the time taken to call the operation	No
<include-migration-info>	Returns the migration information for the migrating vFiler units Valid values: true, false (default)	No
<include-perf-space-details>	Returns the details of the space consumed by the performance data of the host Valid values: true, false (default)	No
<is-direct-member-only>	Returns the hosts that are only the direct members of the specified resource group This field is meaningful only if a resource group name or ID is given for the <object-name-or-id> field. Valid values: true, false (default)	No
<license-filter>	Specifies the filter for listing the storage systems based on the services licensed Only those storage systems that have all the licenses installed as specified in the input are listed.	No
<license>	Specifies the name of the licensed Data ONTAP service Valid values: nfs, cifs, iscsi, fcp, multistore, a_sis, snapmirror_sync Note The <license> element is valid only when the <license-filter> element is present.	Conditional
<object-management-filter>	Specifies the filter the object based on the Data ONTAP interface that provides complete management for the object i.e. ONTAP CLIs, SNMP, ONTAPI etc. If no filter is supplied, all objects are considered. Valid values: "node" - For objects manageable by node management interface "cluster" - For objects manageable by cluster management interface	No
<object-name-or-id>	Specifies the name or identifier of an object to list hosts for The allowed object types for this argument are: Resource Group Resource Pool Dataset Storage Set Host Aggregate Volume Qtree OSSV Directory If the <object-name-or-id> element identifies a host, that single host is returned. If the <object-name-or-id> resolves to more than one hosts, all of them are returned. If no <object-name-or-id> is provided, all hosts are listed. Host Agents and OSSV agents may use a subdomain to identify themselves, unlike other host types. If the <host-types> element includes "agent" or "ossv", all sub domains beginning with the host name are checked.	No
<query-host>	Queries the host to update the database and refresh the values returned in the following elements: <host-status> <is-agent-ossv-enabled> <is-snapvault-enabled> <is-ndmp-enabled> <is-snapmirror-enabled> <snapvault-access-specifier> <ndmp-access-specifier> <snapmirror-access-specifier> <host-communication-status> <host-credentials-status> <ndmp-communication-status> <ndmp-credentials-status> <ndmp-agent-status> <is-snapvault-primary> <is-snapvault-secondary> <is-snapmirror-host> <is-unix-primary> <is-linux-primary> <is-windows-primary> <is-windows-ofm-primary> <is-nearstore> Note Errors in communicating with or authenticating to the host prevent updating all the elements that are supported.	No
<vfiler-ipspace>	Specifies the filter for listing vFiler units If specified, only the vFiler units that belong to the ipspace are listed Applicable only for the host-type "vfiler"	No

A sample adapter request for this operation is given in the following figure.

Sample adapter request for Find Host operation

<netapp-storage-request>
   <operation-name>find-host-inventory</operation-name>
   <arguments>
     <targets>
       <target>
         <host>server137</host>
         <user-name>username</user-name>
         <password encryption-type = "Base64">cGFzc3dvcmQ=</password>
         <protocol>http</protocol>
         <port>8088</port>
       </target>
     </targets>
     <target />
     <expand-filer-to-vfilers>true</expand-filer-to-vfilers>
     <host-dp-filter-info>
       <is-dp-ignored>false</is-dp-ignored>
       <is-in-dataset>false</is-in-dataset>
       <is-in-resourcepool>false</is-in-resourcepool>
       <is-snapmirrored-only>false</is-snapmirrored-only>
       <is-snapvault-primary-only>false</is-snapvault-primary-only>
       <is-snapvault-secondary-only>false</is-snapvault-secondary-only>
       <is-unprotected>false</is-unprotected>
     </host-dp-filter-info>
     <host-types>
       <host-type>filer</host-type>
     </host-types>
     <include-is-available>false</include-is-available>
     <include-migration-info>false</include-migration-info>
     <include-perf-space-details>false</include-perf-space-details>
     <is-direct-member-only>false</is-direct-member-only>
     <license-filter>
       <license>nfs</license>
       <license>cifs</license>
     </license-filter>
     <object-management-filter>node</object-management-filter>
     <object-name-or-id>object_name_1</object-name-or-id>
     <query-host>false</query-host>
     <vfiler-ipspace>ipspace3</vfiler-ipspace>
   </arguments>
</netapp-storage-request>

A sample adapter response for this operation is given in the following figure.

Sample adapter response for Find Host operation

{<netapp-storage-response>
<metadata>
   <status>success</status>
   <response-count>1</response-count>
</metadata>
<responses>
   <response>
     <metadata>
       <target>server137</target>
       <status>success</status>
       <count>1</count>
     </metadata>
     <output>
       <host-info>
         <id>1729</id>
         <name>netappsim732-1</name>
         <host-id>1729</host-id>
         <host-name>netappsim732-1</host-name>
         <host-fqdn>netappsim732-1.synapse.com</host-fqdn>
         <host-address>172.11.11.111</host-address>
         <host-type>filer</host-type>
         <host-model>Simulator</host-model>
         <host-description />
         <host-status>up</host-status>
         <host-communication-status>up</host-communication-status>
         <host-username>root</host-username>
         <host-credentials-status>good</host-credentials-status>
         <host-perf-info>
           <host-perf-status>unknown</host-perf-status>
           <is-data-available>true</is-data-available>
         </host-perf-info>
         <licenses>
           <license>nfs</license>
           <license>cifs</license>
           <license>iscsi</license>
           <license>multistore</license>
           <license>snapmirror_sync</license>
         </licenses>
         <service-statuses>
           <service-status>
             <service>nfs</service>
             <status>up</status>
           </service-status>
           <service-status>
             <service>cifs</service>
             <status>up</status>
           </service-status>
           <service-status>
             <service>iscsi</service>
             <status>up</status>
           </service-status>
           <service-status>
             <service>fcp</service>
           <status>down</status>
         </service-status>
         </service-statuses>
         <partner-storage-system-id>0</partner-storage-system-id>
         <partner-storage-system-name />
         <admin-port />
         <admin-transport>http</admin-transport>
         <perf-advisor-transport />
         <use-hosts-equiv>false</use-hosts-equiv>
         <ndmp-communication-status>up</ndmp-communication-status>
         <ndmp-communication-timestamp>1279877644</ndmp-communication-timestamp>
         <ndmp-credentials-status>good</ndmp-credentials-status>
         <ndmp-agent-status>up</ndmp-agent-status>
         <ndmp-timestamp>1279877644</ndmp-timestamp>
         <host-os>7.3.2</host-os>
         <host-version>7.3.2</host-version>
         <host-obj-status>critical</host-obj-status>
         <ndmp-credentials>
           <ndmp-username>root</ndmp-username>
           <ndmp-password />
           <ndmp-port />
         </ndmp-credentials>
         <host-dp-info>
           <is-dp-ignored>false</is-dp-ignored>
           <is-in-dataset>false</is-in-dataset>
           <datasets />
           <is-snapvault-primary>true</is-snapvault-primary>
           <is-snapvault-secondary>true</is-snapvault-secondary>
           <is-snapmirror-host>true</is-snapmirror-host>
           <is-unix-primary>true</is-unix-primary>
           <is-linux-primary>true</is-linux-primary>
           <is-windows-primary>true</is-windows-primary>
           <is-windows-ofm-primary>true</is-windows-ofm-primary>
           <is-nearstore>false</is-nearstore>
           <is-snapvault-enabled>true</is-snapvault-enabled>
           <is-ndmp-enabled>true</is-ndmp-enabled>
           <is-snapmirror-enabled>true</is-snapmirror-enabled>
           <snapvault-access-specifier>none</snapvault-access-specifier>
           <ndmp-access-specifier>all</ndmp-access-specifier>
           <snapmirror-access-specifier>legacy</snapmirror-access-specifier>
           <is-agent-ossv-enabled>false</is-agent-ossv-enabled>
           <host-resourcepool>DEV_Silver</host-resourcepool>
           <snapvault-max-backup-threads />
         </host-dp-info>
       </host-info>
     </output>
   </response>
</responses>
</netapp-storage-response>

The following table describes the response elements.

Adapter response elements for the Find Host operation

Find Host operation

On this page