Vsan Iscsi Target System Vsan Vit Get Home Object

Vsan Iscsi Target System Vsan Vit Get Home Object

Gets the home object which stores the metadata for vSAN iSCSI target service.

If the home object is not found, a VsanFault will be raised.
Please don't rely on this function to decide whether need to create the home object or not, because the home object may be in creation process.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanIscsiTargetSystem/{moId}/VsanVitGetHomeObject
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanIscsiTargetSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
VsanVitGetHomeObjectRequestType of type(s) application/json
Required 
"VsanVitGetHomeObjectRequestType Object"
cluster
Required

: reference to cluster resource.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

VsanObjectInformation for the home object.

Returns VsanObjectInformation of type(s) application/json 
"VsanObjectInformation Object"
string
directoryName
Optional

The friendly name of a namespace object.

string
vsanObjectUuid
Optional

vSAN object UUID.

If not set, object couldn't be found in the current cluster.

string
vsanHealth
Optional

Health of the vSAN object, as seen by the host.

The possible value is 'inaccessible', 'reduced-availability-with-no-rebuild', 'reduced-availability-with-no-rebuild-delay-timer', 'reduced-availability-with-active-rebuild', 'data-move', 'non-availability-related-reconfig', 'non-availability-related-incompliance', 'healthy'

array of object
policyAttributes
Optional

vSAN policy attributes used for the policy of the object.

Not set if the object couldn't be found, or if the object is not healthy enough to determine its policy. Its format is key-value pair list, each key-value pair represents one attribute, the key is the attribute name, the value is the attribute value represented by string format.

string
spbmProfileUuid
Optional

UUID of SPBM profile used for the policy of the object when it was applied to vSAN Object.

Not set if the object couldn't be found, if the object is not healthy enough to determine its policy, or if the object doesn't use a SPBM managed policy.

string
spbmProfileGenerationId
Optional

Generation ID of SPBM profile used for the policy of the object when it was applied to vSAN Object.

Not set if the object couldn't be found, if the object is not healthy enough to determine its policy, or if the object doesn't use a SPBM managed policy.

spbmComplianceResult
Optional

Describes the results of profile compliance checking for a vSAN object.


500

Failure

Returns VsanFault of type(s) application/json 
"VsanFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanIscsiTargetSystem/{moId}/VsanVitGetHomeObject
On This Page
V San Service Api Operations
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Initiator Group
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Initiators To Group
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Initiators To Target
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi LUN
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Target
POST
Vsan Iscsi Target System Vsan Vit Add Iscsi Target To Group
POST
Vsan Iscsi Target System Vsan Vit Edit Iscsi LUN
POST
Vsan Iscsi Target System Vsan Vit Edit Iscsi Target
POST
Vsan Iscsi Target System Vsan Vit Get Home Object
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Initiator Group
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Initiator Groups
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi LUN
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi LU Ns
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Target
POST
Vsan Iscsi Target System Vsan Vit Get Iscsi Targets
POST
Vsan Iscsi Target System Vsan Vit Query Iscsi Target Service Version
POST
Vsan Iscsi Target System Vsan Remediate Iscsi Luns Runtime Status
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Initiator Group
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Initiators From Group
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Initiators From Target
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi LUN
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Target
POST
Vsan Iscsi Target System Vsan Vit Remove Iscsi Target From Group