addSCMConnectivityProvider command

IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts > Commands (wsadmin scripting)
addSCMConnectivityProvider command

Use the addSCMConnectivityProvider command to add a Service Connectivity Management (SCM) connectivity provider.
Before you begin

The addSCMConnectivityProvider command is run using the AdminTask object of the wsadmin scripting client.

Locate the command that starts the wsadmin scripting client: this is found in the install_root\bin directory.
Run the wsadmin command.

If the server is not running, use the -conntype none option.
If you are not connecting to the default profile, use the -profileName profile_name option.

Use the following command to list all the Service Connectivity Management administrative commands.
Using JACL:
$AdminTask help SCMAdminCommands 
Using Jython:
print AdminTask.help('SCMAdminCommands')
Use the following command to get detailed help on a particular command.
Using JACL:
AdminTask help command_name$
Using Jython:
print AdminTask.help('command_name')
Syntax
>>-wsadmin-- --addSCMConnectivityProvider-- -name--------------->

>--+- -node-- -server-+-- -proxyHostHTTP-- -proxyPortHTTP------->
   '- -cluster--------'

>-- -proxyHostHTTPS-- -proxyPortHTTPS--+----------------+------->
                                       '- -description-'

>--+-----------+--+----------------+--+------------+------------>
   '- -contact-'  '- -organization-'  '- -location-'

>--+-------------+--+--------------+---------------------------><
   '- -authAlias-'  '- -repertoire-'
Purpose

The addSCMConnectivityProvider command adds a Service Connectivity Management connectivity provider. A connectivity provider is a logical partition of the ESB that is exposed via the Service Connectivity Management Protocol. It defines the target (server or cluster) to which proxy gateway modules will be deployed when a Service Federation Management group proxy is created on that connectivity provider. It also defines properties that will be used for proxy targets created on those group proxies.

Command name

addSCMConnectivityProvider.

Target

Not applicable.

Result

javax.management.ObjectName SCMConnectivityProvider – the connectivity provider to be displayed.

Parameters

-name connectivityProviderName

The name of the connectivity provider, as a string. This must be unique within the cell. An exception is thrown if the name already exists. The name, description, contact, organization and location will be visible to users of the Service Federation Management console.

-node nodeName

A parameter that specifies the name of the node hosting the server to which the proxy gateway module for a group proxy should be deployed. To add a server as a connectivity provider, you must specify both a server and a node.

-server serverName

A parameter that specifies the name of the server to which the proxy gateway module for a group proxy should be deployed. To add a server as a connectivity provider, you must specify both a server and a node.

-cluster clusterName

A parameter that specifies the name of the cluster to which the proxy gateway module for a group proxy should be deployed. To add a cluster as a connectivity provider, you must specify just the cluster name.

-proxyHostHTTP httpHost

A parameter that specifies the host name that will be returned for the endpoint of an insecure proxy target. This should be the host that web service clients in another domain will use to access the proxy, taking in to account web servers and other network components.

-proxyPortHTTP httpPort

A parameter that specifies the port that will be returned for the endpoint of an insecure proxy target. This should be the host that web service clients in another domain will use to access the proxy, taking in to account web servers and other network components.

-proxyHostHTTPS httpsHost

A parameter that specifies the host name that will be returned for the endpoint of a secure proxy target. This should be the host that web service clients in another domain will use to access the proxy, taking in to account web servers and other network components.

-proxyPortHTTPS httpsPort

A parameter that specifies the port that will be returned for the endpoint of a secure proxy target. This should be the host that web service clients in another domain will use to access the proxy taking in to account web servers and other network components.

-description connectivityProviderDescription

A brief description of the connectivity provider. This is optional and defaults to an empty string. The name, description, contact, organization and location will be visible to users of the Service Federation Management console.

-contact contactName

A parameter that specifies the name of a contact person for the connectivity provider. This is optional and defaults to an empty string. The name, description, contact, organization and location will be visible to users of the Service Federation Management console.

-organization organizationName

A parameter that specifies the name of the owning organization for the connectivity provider. This is optional and defaults to an empty string. The name, description, contact, organization and location will be visible to users of the Service Federation Management console.

-location locationName

A parameter that specifies the location for the connectivity provider. This is optional and defaults to an empty string. The name, description, contact, organization and location will be visible to users of the Service Federation Management console.

-authAlias alias

A parameter that specifies the authentication alias that will provide the basic authentication credentials used to retrieve WSDL documents via HTTP from the service registry associated with the connectivity provider's domain. This parameter need not be specified if basic authentication is not required to connect to the service registry.

-repertoire sslConfig

A parameter that specifies the SSL configuration used to retrieve WSDL documents via HTTP from a secure service registry associated with the connectivity provider's domain. This is optional and, if not specified, the server's default SSL configuration will be used.

Examples

The following example adds a connectivity provider named myProvider associated with server server1 on node cpNode where web service clients access that server directly:
Use JACL:
$AdminTask addSCMConnectivityProvider {-name myProvider -node cpNode 
-server server1 –proxyHostHTTP server1.example.com 
–proxyPortHTTP 9080 –proxyHostHTTPS server1.example.com 
–proxyPortHTTPS 9443}
Use Jython:
AdminTask.addSCMConnectivityProvider('[-name myProvider 
-node cpNode -server server1 –proxyHostHTTP webserver.example.com 
–proxyPortHTTP 80 –proxyHostHTTPS webserver.example.com 
–proxyPortHTTPS 443]')
The following example adds a connectivity provider named myScalableProvider associated with cluster cpCluster where web service clients access servers in that cluster via a web server:
Use JACL:
$AdminTask addSCMConnectivityProvider {-name myScalableProvider 
-cluster cpCluster –proxyHostHTTP webserver.example.com 
–proxyPortHTTP 80 –proxyHostHTTPS webserver.example.com 
–proxyPortHTTPS 443}
Use Jython:
AdminTask.addSCMConnectivityProvider('[-name myScalableProvider
-cluster cpCluster –proxyHostHTTP webserver.example.com 
–proxyPortHTTP 80 –proxyHostHTTPS webserver.example.com 
–proxyPortHTTPS 443]')
The following example demonstrates the use of the optional parameters to specify additional information that will appear in the Service Federation Management console and for connecting to the service registry securely:
Use JACL:
$AdminTask addSCMConnectivityProvider {-name myScalableProvider 
-cluster cpCluster –proxyHostHTTP webserver.example.com 
–proxyPortHTTP 80 –proxyHostHTTPS webserver.example.com 
–proxyPortHTTPS 443 –description "My Connectivity Provider" 
–contact "Contact Name” –organization "Owning Organization" 
–location "ESB location" –authAlias REGISTRY_AUTH_ALIAS 
–repertoire REGISTRY_SSL_CONFIG }
Use Jython:
AdminTask.addSCMConnectivityProvider('[-name myScalableProvider
-cluster cpCluster –proxyHostHTTP webserver.example.com 
–proxyPortHTTP 80 –proxyHostHTTPS webserver.example.com 
–proxyPortHTTPS 443 –description "My Connectivity Provider" 
–contact "Contact Name” –organization "Owning Organization" 
–location "ESB location" –authAlias REGISTRY_AUTH_ALIAS 
–repertoire REGISTRY_SSL_CONFIG]')
Parent topic: Commands (wsadmin scripting)
Related information:

Obtaining online help using wsadmin scripting
Administrative command invocation syntax using wsadmin scripting
Use the wsadmin scripting tool
Jython script library