Find Site Status operation

The Find Site Status operation finds the status of a site.

The following table describes the <items> XML elements for the Find Site Status operation:

Elements for the <items> XML element and adapter request for the Find Site Status operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `find-site-status`	Yes
`<arguments>`	Specifies a list of arguments required for this operation	Yes
`<target>`	Specifies the connection information for the Microsoft System Center Configuration Manager application Valid values: The value specified for the `<target>` element must be the same as that specified for the name attribute of the `<config>` element in the adapter configuration. Default value: The first configuration defined in the adapter configuration	No
`<availability-state>`	Specifies the availability state of the site system Valid values: Online Failed Unknown	No
`<bytes-free>`	Specifies the amount of unused storage space in kilobytes for the storage object	No
`<bytes-total>`	Specifies the maximum amount of storage space in kilobytes of the storage object A negative value indicates that information is currently unavailable.	No
`<down-since>`	Specifies the date and time when the storage object is first found to be down (inaccessible) The storage object is considered down if the site server fails to connect to the storage object due to network, security, or other problems. The value is null if the storage object is accessible. The time zone is based on the time zone of the `<site-code>` element. Valid values: Any input in datetime format - YYYYmmDDhhMMssuuuuuu+ YYYY: year; mm: month; DD: date; hh: hour; MM: minute; ss: second; uuuuuu: microsecond; +: Offset from local time	No
`<object-type>`	Specifies the type of object for which the status is being reported Valid values: NALPATH SQL_DB SQL_LOG	No
`<percent-free>`	Specifies the percentage of free storage space available on the storage object	No
`<role>`	Specifies the Configuration Manager role performed by the site system Valid values: SMS Component Server SMS Distribution Point SMS Fallback Status Point Note The role values might be visible with different names on the application. For example: SMS Component Server: ConfigMgr Component Server SMS Distribution Point: ConfigMgr Distribution Point SMS Fallback Status Point: ConfigMgr Fallback Status Point	No
`<site-code>`	Specifies the code of the Microsoft System Center Configuration Manager site	No
`<status>`	Specifies the status value indicating the health of the component Valid Values: OK: GREEN (0) There are no warning or error messages. WARNING: YELLOW (1) Warning messages are generated, but error messages are not generated. CRITICAL: RED (2) There are error messages.	No

The following figure shows a sample adapter request for the Find Site Status operation:

Sample adapter request for the Find Site Status operation

<mssccm-request>
    <operation-name>find-site-status</operation-name>
    <arguments>
      <target>config1</target>
      <availability-state>Online</availability-state>
      <bytes-free>24315492</bytes-free>
      <bytes-total>83875332</bytes-total>
      <down-since />
      <object-type>NALPATH</object-type>
      <percent-free>28</percent-free>
      <role>AI Update Service Point</role>
      <site-code>123</site-code>
      <status>OK</status>
    </arguments>
  </mssccm-request>

The following figure shows the adapter response for the sample request:

Sample adapter response for the Find Site Status operation

<mssccm-response>
  <metadata>
    <response-count>1</response-count>
    <status>success</status>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>config1</target>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <availability-state>Online</availability-state>
        <bytes-free>24315492</bytes-free>
        <bytes-total>83875332</bytes-total>
        <down-since />
        <object-type>NALPATH</object-type>
        <percent-free>28</percent-free>
        <role>AI Update Service Point</role>
        <site-code>123</site-code>
        <site-object>["Display=\\machine\C$\Program Files\Microsoft Configuration Manager\"]MSWNET:["SMS_SITE=123"]\\machine\C$\Program Files\Microsoft Configuration Manager\</site-object>
        <site-system>
["Display=\\machine\"]MSWNET:["SMS_SITE=123"]\\machine\</site-system>
        <status>OK</status>
      </output>
    </response>
  </responses>
</mssccm-response>

Find Site Status operation

Comments