×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
TrueSight Orchestration Content 20.19.02 ... Application adapters Dell Advanced Infrastructure Manager adapter Dell AIM actor adapter requests and responses Persona operations

Add Network Connection To Persona operation

The Add Network Connection To Persona operation creates and adds a new network connection to an existing persona.

The following table describes the <items> XML and request elements for the Add Network Connection To Persona operation.

Adapter request elements for the Add Network Connection To Persona operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: add-network-connection-to-persona

Yes

<arguments>

Specifies a list of elements that are required for the operation

Yes

<targets>

Contains one or more <target> elements

Conditional; required if the actor adapter configuration is empty

<target>

Contains the name attribute that references a TrueSight Orchestration Grid Manager configuration node, or contains the elements that define a dynamic target

To reference a Grid Manager configuration node, the <target> element must be specified as a child of the <arguments> element and must contain the name of a configuration node that is defined in Grid Manager. If <target> is not provided or is left empty, the request is executed on the first defined configuration node.

To define a dynamic target, you can use one or more <target> elements in the <targets> element. If a dynamic target is not specified, the adapter uses the configuration information specified in Grid Manager. You can define dynamic targets by using the following child elements:

  • <host>
  • <user-name>
  • <password>
  • <protocol>
  • <port>
  • <use-ssl-certificate>
  • <allow-unsigned-certificate>
  • <install-certificate>
  • <passphrase>

Conditional; required if a target is referenced or defined in the request

<host>

Specifies the host name or the IP address of the server where the Dell AIM controller is installed

Conditional; required when using dynamic targets

<user-name>

Specifies the user name for the Dell AIM controller authentication

Conditional; required when using dynamic targets

<password>

Specifies the password that corresponds to the user name

The password element can contain an encryption-type attribute that indicates whether the password specified is encrypted.

Valid values for encryption-type attribute: Plain (default), Base64

Conditional; required when using dynamic targets

<protocol>

Specifies the communication protocol for the Dell AIM controller

Valid values: http (default), https

No

<port>

Specifies the communication port for the Dell AIM controller

Default values:

  • 80 for http protocol
  • 443 for https protocol

No

<use-ssl-certificate>

Specifies whether SSL certificates are used for authentication

Valid values: false (default), true

No

<allow-unsigned-certificates>

Specifies whether to allow unsigned certificates from trusted zones

If you are using self-signed SSL certificates (a common practice), set the value of this element to true.

On ecommerce sites or military installations, if you need to use signed certificates such as Verisign or Thawte (a rare practice), set the value of this element to false.

Valid values: false (default), true

No

<install-certificate>

Specifies whether to install security certificates automatically

If you prefer to have security certificates installed automatically (a common practice), set the value of this element to true.

If you prefer to manually export the security certificate from the Dell AIM server and manually import it into the cacerts file of the local peer of TrueSight Orchestration (a rare practice), set the value of this element to false.

Valid values: false (default), true

No

<passphrase>

Specifies the password to the keystore file (cacerts ) local to the TrueSight Orchestration peer

Default value: changeit

Note

The value of the <passphrase> element must match the password in the keystore. You can change the password by using keytool. If you change the password, you must update the value of the <passphrase> element.

No

<persona-id>

Specifies the ID of the persona to which the network connection is added

Yes

<network-connection>

Contains the elements that specify the details of the network connection

Yes

<ip-assignment-type>

Specifies the method that is used to assign an IP address to the network connection

Valid values:

  • dhcp: The IP address of the network connection is assigned by using the Dynamic Host Configuration Protocol (DHCP).
  • static: The IP address of the network connection is statically assigned (default).
  • VoeAssigned: The IP address of the network connection is assigned by the Dell AIM controller.

No

<register-with-dns>

Specifies that way in which the network connection is registered with the Domain Name System (DNS) server

Valid values:

  • disabled: Explicitly disables registration with the DNS server (default)
  • default: DNS registration is disabled
  • addDNSSuffix: Enables registration with the DNS suffix appended to the host name

No

<netbios-over-tcp>

Specifies the NetBIOS over TCP status for the network connection

Valid values:

  • disabled: Disables NetBIOS over TCP protocol for the network connection (default)
  • default: Equivalent to enabled
  • enabled: Enables NetBIOS over TCP protocol for the network connection

No

<id>

Specifies the ID of the network connection

Valid values: Any string

No

<name>

Specifies the name of the network connection

Valid values: Any string (maximum 15 characters in length)

Note

Network connection names can contain only alphanumeric characters, dashes (-), underscores (_), and periods (.).

No

<description>

Specifies a detailed description of the network connection

Valid values: Any string

No

<primary-channel>

Specifies the primary Dell AIM network channel of the persona to which the network connection is assigned

No

<secondary-channel>

Specifies the secondary Dell AIM network channel of the persona to which the network connection is assigned

No

<wins-address>

Specifies the address of the Windows Internet Name Service (WINS) for Microsoft Windows personas

Valid value: A valid WINS address string

No

<dhcp-hostname>

Specifies the host name of the persona to which the network connection is assigned

No

<enabled>

Specifies whether the network connection is enabled

Valid values: true (default), false

No

<network-id>

Specifies the ID of the network that the persona connects to by using the network connection

Valid value: A valid network ID

Yes

<ip-addresses>

Contains one or more <ip-address> elements

Conditional; required if an array of IP addresses is assigned to the network connection

<ip-address>

Contains the details of a specific IP address

Conditional; required if an array of IP addresses is assigned to the network connection

<address>

Specifies the IP address that is assigned to the persona

Valid value: A valid IP address

Conditional; required if an array of IP addresses is assigned to the network connection

<subnet-mask>

Specifies the subnet mask for the IP address

Valid value: A valid subnet mask

Conditional; required if an array of IP addresses is assigned to the network connection

<virtual>

Specifies whether the IP address is a virtual IP address

Valid values: true, false

Conditional; required if an array of IP addresses is assigned to the network connection

The following figure illustrates a sample adapter request for the Add Network Connection To Persona operation:

Sample adapter request for the Add Network Connection To Persona operation 

<dell-aim-request>
    <operation-name>add-network-connection-to-persona</operation-name>
    <arguments>
      <targets>
        <target>
          <host>scalent-controller</host>
          <user-name>username</user-name>
          <password encryption-type="Base64">cGFzc3dvcmQ=</password>
          <protocol>https</protocol>
          <port>443</port>
          <use-ssl-certificate>true</use-ssl-certificate>
          <allow-unsigned-certificate>true</allow-unsigned-certificate>
          <install-certificate>true</install-certificate>
          <passphrase>changeit</passphrase>
        </target>
      </targets>
      <target>config1</target>
      <persona-id>PI_WEBSTORE_APACHE.5.0</persona-id>
      <network-connection>
        <ip-assignment-type>dhcp</ip-assignment-type>
        <register-with-dns>default</register-with-dns>
        <netbios-over-tcp>default</netbios-over-tcp>
        <id>TEST NETWORK CONNECTION 1_2</id>
        <name>TEST_NETWORK102</name>
        <description />
        <primary-channel>1</primary-channel>
          <secondary-channel>2</secondary-channel>
          <wins-address>test</wins-address>
        <dhcp-hostname>Webstore Apache1</dhcp-hostname>
        <enabled>false</enabled>
        <network-id>VS_WEBSTORE_APACHE.1.0</network-id>
        <ip-addresses>
          <ip-address>
            <address>192.111.11.11</address>
            <subnet-mask>255.111.111.0</subnet-mask>
            <virtual>true</virtual>
          </ip-address>
        </ip-addresses>
      </network-connection>
    </arguments>
  </dell-aim-request>


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

Sample adapter response for the Add Network Connection To Persona operation 

<dell-aim-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>scalent-controller</target>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <message>Network Connection with ID - "TEST NETWORK 
        CONNECTION 1_2" for Persona -"PI_WEBSTORE_APACHE.5.0" 
        created successfully.</message>
      </output>
    </response>
  </responses>
</dell-aim-response>
Was this page helpful? Yes No Submitting... Thank you
Last modified by Shweta Hardikar on May 21, 2019
dell_aim persona

Comments

Log in or register to comment.

Persona operations
Find Persona Details operation
© Copyright 2013 - 2020 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.