×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
TrueSight Orchestration Content 20.19.01 ... Application adapters HP Service Manager adapter HP Service Manager actor adapter requests and responses Configuration_Management operations for the HP Service Manager adapter

Update Installed Software operation

The Update Installed Software operation updates the details of an installed software.

The following table describes the elements of the <items> XML element and the adapter request. If not specified, the valid value for an element should be assumed to be a string.

The default value for all elements is ignored.

Elements for the <items> XML element and adapter request for the Update Installed Software operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: update-installed-software

Yes

<model>

Contains the other elements in the request

Yes

<keys>

Contains elements that uniquely identify a record

A combination of the <application-name>, <license-number>, and <installed-on-c-i> elements must be used as the key.

If you do not specify the combination of the <application-name>, <license-number>, and <installed-on-c-i> elements in the <keys> element, the application tries to find the combination in the <instance> element. You can provide the values for the combination in the <keys> element, in the <instance> element, or in both elements.

Yes

<instance>

Specifies a unique record

The children of the <instance> element describe the fields of the record.

The only two higher-level elements are <keys> and <instance>. All other elements are child elements of the <instance> element.

Yes

<application-name>

Specifies the name of the installed application

A combination of the <application-name>, <license-number>, and <installed-on-c-i> elements must be used as the key.

Valid value: Any string

Notes:

  • The <application-name> element can be a child element of the <keys> and <instance> elements.
  • The <application-name> element is a required element in the <keys> element to locate the installed software entry to be updated.
  • The <application-name> element is an optional element in the <instance> element to specify the new desired value of the element.

Conditional

<license-number>

Specifies the license number of the installed software

A combination of the <application-name>, <license-number>, and <installed-on-c-i> elements must be used as the key.

Valid value: Any string

Notes:

  • The <application-name> element can be an optional child element of the <keys> and <instance> elements.
  • You can specify the element as a child element of the <keys> when the combination of the <application-name> and <installed-on-c-i> elements cannot uniquely locate the installed software entry to be updated.
  • You can specify the element as a child element of the <instance> element to specify the new desired value of the element.

No

<installed-on-c-i>

Specifies the configuration item where the software is installed

A combination of the <application-name>, <license-number>, and <installed-on-c-i> elements must be used as the key.

Valid value: Any string

Notes:

  • The <installed-on-c-i> element can be a required child element of the <keys> and an optional element in the <instance> element.
  • You can specify the element as a child element of the <keys> to locate the installed software entry to be updated.
  • You can specify the element as a child element of the <instance> element to specify the new desired value of the element.

No

<directory>

Specifies the directory where the software is installed

Valid value: Any string

No

<description>

Specifies a description of the installed software

Valid value: Any string

No

<version>

Specifies the version of the installed software

Valid value: Any string

No

<installation-date>

Specifies the date when the software was installed

Valid value: Date and time in the YYYY.MM.DD HH:MM:SS format

No

<installed-by>

Specifies the name of the person who installed the software

Valid value: Any string

No

<suite-component>

Specifies whether the installed software is a component of a suite

Valid values: true, false

No

<is-authorized>

Specifies whether the software is an authorized software

Valid values: true, false

No

<status>

Specifies the status of the software

Valid value: Any string

No

<serial-number>

Specifies the serial number of the software

Valid value: Any string

No

The following figure displays the sample adapter request for the Update Installed Software operation.

Sample adapter request for the Update Installed Software operation 


 <hp-service-manager-request>
    <entity>configurationitem</entity>
    <entity-type>installed-software</entity-type>
    <request>
      <operation-name>update-installed-software</operation-name>
      <parameters>
        <update-installed-software-request>
          <model>
            <keys>
              <license-number>
                <value>license number-01</value>
                <type>String</type>
              </license-number>
              <installed-on-c-i>
                <value>installed on c i-01</value>
                <type>String</type>
              </installed-on-c-i>
              <application-name>
                <value>application name-01</value>
                <type>String</type>
              </application-name>
            </keys>
            <instance>
              <application-name>
                <value>application name-01</value>
                <type>String</type>
              </application-name>
              <license-number>
                <value>license number-01</value>
                <type>String</type>
              </license-number>
              <installed-on-c-i>
                <value>installed on c i-01</value>
                <type>String</type>
              </installed-on-c-i>
              <directory>
                <value>directory-UPDATED</value>
                <type>String</type>
              </directory>
              <description>
                <value>description</value>
                <type>String</type>
              </description>
              <version>
                <value>version</value>
                <type>String</type>
              </version>
              <installation-date>
                <value>2008.11.01 08:00:00</value>
                <type>DateTime</type>
              </installation-date>
              <installed-by>
                <value>installed by</value>
                <type>String</type>
              </installed-by>
              <suite-component>
                <value>true</value>
                <type>Boolean</type>
              </suite-component>
              <is-authorized>
                <value>true</value>
                <type>Boolean</type>
              </is-authorized>
              <status>
                <value>status</value>
                <type>String</type>
              </status>
              <serial-number>
                <value>serial number</value>
                <type>String</type>
              </serial-number>
            </instance>
          </model>
        </update-installed-software-request>
      </parameters>
    </request>
  </hp-service-manager-request>


The following figure displays an adapter response for the Update Installed Software operation.

Sample adapter response for the Update Installed Software operation 


<hp-service-manager-response>
  <metadata>
    <count>1</count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <count>1</count>
      </metadata>
      <item>
        <metadata>
          <status>success</status>
        </metadata>
        <parameters>
          <model>
            <keys>
              <license-number>
                <value>license number-01</value>
                <type>String</type>
              </license-number>
              <installed-on-c-i>
                <value>installed on c i-01</value>
                <type>String</type>
              </installed-on-c-i>
              <application-name>
                <value>application name-01</value>
                <type>String</type>
              </application-name>
            </keys>
            <instance>
              <application-name>
                <value>application name-01</value>
                <type>String</type>
              </application-name>
              <license-number>
                <value>license number-01</value>
                <type>String</type>
              </license-number>
              <directory>
                <value>directory-UPDATED</value>
                <type>String</type>
              </directory>
              <description>
                <value>description</value>
                <type>String</type>
              </description>
              <version>
                <value>version</value>
                <type>String</type>
              </version>
              <installation-date>
                <value>2008.11.01 08:00:00</value>
                <type>DateTime</type>
              </installation-date>
              <installed-by>
                <value>installed by</value>
                <type>String</type>
              </installed-by>
              <installed-on-c-i>
                <value>installed on c i-01</value>
                <type>String</type>
              </installed-on-c-i>
              <suite-component>
                <value>true</value>
                <type>Boolean</type>
              </suite-component>
              <is-authorized>
                <value>true</value>
                <type>Boolean</type>
              </is-authorized>
              <status>
                <value>status</value>
                <type>String</type>
              </status>
              <serial-number>
                <value>serial number</value>
                <type>String</type>
              </serial-number>
              <uniquequery>license.number="license number-01" and logical.name="installed on c i-01" and application.name="application 
name-01"</uniquequery>
              <recordid>license number-01 - installed on c i-01 - application name-01</recordid>
            </instance>
          </model>
          <messages>
            <element>
              <value>pcsoftware record updated.</value>
            </element>
          </messages>
          <status>SUCCESS</status>
          <message>Success</message>
          <schema-revision-date>2010.01.21 00:00:00</schema-revision-date>
          <schema-revision-level>0</schema-revision-level>
          <return-code>0</return-code>
        </parameters>
      </item>
    </response>
  </responses>
</hp-service-manager-response>
Was this page helpful? Yes No Submitting... Thank you
Last modified by Deepa Bhat on May 08, 2018
hp_service_manager configuration

Comments

Log in or register to comment.

Create Installed Software operation
Delete Installed Software operation
© Copyright 2013 - 2019 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.