addSCMConnectivityProvider command

Use the addSCMConnectivityProvider command to add a Service Connectivity Management (SCM) 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.

Use the following command to list all the Service Connectivity Management administrative commands:

print AdminTask.help('SCMAdminCommands')

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

Prerequisites

The following conditions must be met:

The command must be run on the deployment manager node.
If the deployment manager is stopped, use the wsadmin -conntype none option to run the command in disconnected mode.
If the deployment manager is running, you must connect with a user ID that has WebSphere Application Server configurator privileges. Do not use the wsadmin -conntype none option.

Location

Start the wsadmin scripting client from the deployment_manager_profile/bin directory. The addSCMConnectivityProvider command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you will find exception stack traces and other information.

Syntax

addSCMConnectivityProvider
-name connectivityProviderName
-node nodeName -server serverName
-cluster clusterName
-proxyHostHTTP httpHost
-proxyPortHTTP httpPort
-proxyHostHTTPS httpsHost
-proxyPortHTTPS httpsPort
[-description connectivityProviderDescription]
[-contact contactName]
[-organization organizationName]
[-location locationName]
[-authAlias alias]
[-repertoire sslConfig]

Parameters

-name connectivityProviderName: A required parameter that specifies 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 required 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 required 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 required 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 required 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 into account web servers and other network components.

-proxyPortHTTP httpPort: A required 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 into account web servers and other network components.

-proxyHostHTTPS httpsHost: A required 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 into account web servers and other network components.

-proxyPortHTTPS httpsPort: A required 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 into account web servers and other network components.

-description connectivityProviderDescription: A required parameter that provides a brief description of the connectivity provider. Its default value is an empty string. The name, description, contact, organization and location will be visible to users of the Service Federation Management console.

-contact contactName: A required parameter that specifies the name of a contact person for the connectivity provider. Its default value is an empty string. The name, description, contact, organization, and location will be visible to users of the Service Federation Management console.

-organization organizationName: A required parameter that specifies the name of the owning organization for the connectivity provider. Its default value is an empty string. The name, description, contact, organization, and location will be visible to users of the Service Federation Management console.

-location locationName: A required parameter that specifies the location for the connectivity provider. Its default value is an empty string. The name, description, contact, organization, and location will be visible to users of the Service Federation Management console.

-authAlias alias: An optional 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: An optional 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. If this parameter is not specified, the server's default SSL configuration will be used.

Examples

The following Jython example adds a connectivity provider named myProvider associated with server server1 on node cpNode where web service clients access that server directly:

wsadmin>AdminTask.addSCMConnectivityProvider( ['-name', 'myProvider, 
'-node', 'cpNode', '-server', 'server1, '-proxyHostHTTP', 'webserver.example.com', 
'-proxyPortHTTP, '80', '-proxyHostHTTPS', 'webserver.example.com', 
'-proxyPortHTTPS', '443' ])

The following Jython example adds a connectivity provider named myScalableProvider associated with cluster cpCluster where web service clients access servers in that cluster via a web server:

wsadmin>AdminTask.addSCMConnectivityProvider( ['-name', 'myScalableProvider',
'-cluster', 'cpCluster', '-proxyHostHTTP', 'webserver.example.com', 
'-proxyPortHTTP', '80', '-proxyHostHTTPS', 'webserver.example.com', 
'-proxyPortHTTPS', '443'] )

The following Jython 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:

wsadmin>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'] )