Previous Topic: SDK Support for Client Authentication using X.509 CertificatesNext Topic: Blueprint Wizard UI Reference


Opening the CA Configuration Automation Server UI in Context

Context launch lets you launch the CCA Server UI directly using a URL. The context launch provides a mechanism to launch some CA Configuration Automation operations or dialogs using a URL. This URL can act as an integration tool and can be used in any report or application UI.

URL Parameters

The common parameters are as follows:

eem=eem-artifact

Specifies credentials to log in to CA EEM.

type

Specifies the type of the operation or dialog.

Parameters to run a Change Detection operation on a server are as follows:

type=cd

Specifies the run Change Detection operation on a server.

server=server-name OR ipaddress=ip-address

Specifies the server name or the IP address.

source=(defaults to 1)

Specifies the source snapshot to run Change Detection. The values are as follows:

target=(defaults to 2)

Specifies the target snapshot. The values are as follows:

Example:

http://servername:portnumber/CCAUI.html?type=cd&eem=eem-artifact&server=servername.ca.com&source=1&target=2

Parameters to view Change Detection dialog for a server are as follows:

type=cdd

Specifies the Change Detection operation for a server.

server=server-name OR ipaddress=ip-address

Specifies the server name or IP address.

Example:

http:// servername:portnumber/CCAUI.html?type=cdd&eem=token&server=servername.ca.com

Parameters to run Compare for two servers are as follows:

type=compare

Specifies to run a Compare operation for two servers.

srcserver=server-name or srcip=ip-address

Specifies the source server name or the IP address.

tgtserver=server-name or tgtip=ip-address

Specifies the target server or IP address.

source=(defaults to 1)

Specifies the source snapshot to run compare operations. The values are as follows:

target=(defaults to 1)

Specifies the target snapshot. The values are as follows:

For componentOnly parameter=(defaults to 0)

Specifies software components that are compared on the selected servers.

Note: If you select component only (1), provide the following parameters:

Use comma to separate multiple target component UUIDS.

Examples:

Parameters to show Compare dialog for two servers:

type=compared

Displays the Compare Servers dialog.

srcserver=server-name or srcip=ip-address

Specifies the source server name and the IP address.

tgtserver=server-name or tgtip=ip-address

Specifies the target server name or the IP address.

Example:

http://servername:portnumber/CCAUI.html?type=compared&srcserver=servername.ca.com&tgtserver=servername.ca.com

Parameters to view component for a selected component on server:

type=cv

Specifies view compare operations for a selected component on a server.

server=server-name or ipaddress=ip-address

Specifies the server name or IP address.

comp=component-name

Specifies the component name.

Example:

http://servername:portnumber/CCAUI.html?type=cv&server=servername.ca.com&comp=CCA%20Server

Parameters to view Compliance Job results:

type=cjresult

Specifies the Compliance job operations.

resultuuid= result uuid of the history record

Specifies the UUID of the history entries.

Example:

http://servername:portnumber/CCAUI.html?type=cjresult&eem=eem-artifact&resultuuid="xyz"

Parameters for Access Profile details:

type=ap

Specifies the Access profile operations.

profile=profile-name

Specifies the profile name.

Example:

http://servername:portnumber/CCAUI.html?type=ap&profile=xyz

Parameters for Management Profile details:

type=mp

Specifies the Management Profile operations.

profile=profile-name

Specifies the profile name.

Example:

http://servername:portnumber/CCAUI.html?type=mp&profile=xyz

Parameters for Remediation Profile details:

type=rp

Specifies the Remediation Profile operations.

profile=profile-name

Specifies the profile name.

Example:

http://servername:portNumber/CCAUI.html?type=rp&profile=xyz

Parameters for Blueprint tab:

type=bp

Specifies the Blueprint.

Example

http://servername:portnumber/CCAUI.html?type=bp

Parameters for Server Log:

type=sl

Specifies the server log operations.

server=server-name OR ipaddress=ip-address

Specifies the server name or the IP address.

Example:

http:// servername:portnumber/CCAUI.html?type=sl&server=servername.ca.com

Parameters for Server Component List:

type=sc

Specifies the Server Component list operations.

server=server-name OR ipaddress=ip-address

Specifies the server name or the IP address.

Example

http:// servername:portnumber/CCAUI.html?type=sc&server=servername.ca.com

Parameters to run Rule Compliance for a server or service:

type=rc

Specifies the Rule Compliance operations.

server=server-name OR ipaddress=ip-address OR service=service_name

Specifies the server name, IP address, or service name.

source=(defaults to 1)

Specifies the source snapshot to run Rule compliance operations.

Example

http://servername:portnumber/CCAUI.html?type=rc&eem=eem-artifact&server=servername.ca.com&source=1

Parameters to view Rule Compliance dialog for a server or service:

type=rcd

Specifies the Rule Compliance operations.

server=server-name or ipaddress=ip-address or service_name=service

Specifies the server name, IP address, or service name.

Example:

http:// servername:portnumber/CCAUI.html?type=rcd&eem=eem-artifact&server=servername.ca.com

Parameters to view Charts:

type=chart

Specifies the chart type.

name=chart-name

Specifies the chart name.

Example:

http://servername:portnumber/CCAUI.html?type=chart&name=Servers by OS Family

The chart names are as follows:

Parameters required for graphs:

type=graph

Specifies the graph type.

name=localized name

Specifies the name of the localized graph.

id=non-localized name

Specifies the name of the predefined graphs installed with CA Configuration Automation.

Example:

http://servername:portnumber/CCAUI.jsp?type=graph&name=All Server Relationships.

Note: Localized and non-localized graph names are same for English CCA Server. The ID parameter is applicable only for non-English CCA Server to access predefined graphs with English names.

Parameters required for CA CMDB:

type=ci&objtype=&name=&component=&eem=
type=ci&objtype=&name=&component=&eem=path= (Component only) path = installed directory or default directory

The following table shows the URL changes required for CA CMDB to support the context launch supported by CA Configuration Automation.

Object type

URL type argument (objtype=xxx)

URL name argument (name=xxx)

URL component argument (component=xxx)

EEM artifact

Example federated asset ID

Server (including virtual and lpar)

server

server name

n/a

optional

objtype=server&name=my_server_name&component=&eem=artifact

Service

service

service name

n/a

optional

objtype=service&name=my service name&component=&eem=artifact

Component

component

server name

component name

optional

objtype=component&name= my_server_name &component=my component name&eem=artifact

File system
(not supported)

 

 

 

 

 

NIC

nic

server name

nic ip address

optional

objtype=nic&name= my_server_name &component=my nic ip address&eem=artifact

Hard drive
(not supported)

 

 

 

 

 

Cluster
(not supported)

 

 

 

 

 

Blueprint
(not supported)