Service End Point Management

Shell Commands › Service End Point Management

Service End Point Management

This section contains the following topics:

svcpt config

svcpt config

The svcpt config command lists the properties of a service end point.

Syntax

This command has the following format:

svcpt config /endpoint_catalog_name:endpoint_name -- boundary [--batch]

Parameters

endpoint_catalog_name: Specifies the name of the global catalog that contains the service end point appliance.
endpoint_name: Specifies the name of the service end point appliance.
--boundary: Specifies that the properties relate to the appliance boundary.
--batch: (Optional) Displays output in UDL format. The format facilitates programmatic interpretation of the result.

Example: List the Properties of a Gateway Appliance for a CICS Subsystem

This example lists the properties of the CICS_SYS01 gateway appliance for a CICS subsystem. The appliance is in the zos_svcpt global catalog.

svcpt config /zos_svcpt:CICS_SYS01 --boundary

This section contains the following topics:

svcpt config Command Output Specification

svcpt config output

Without the --batch option, the output of this command is a table that contains the following columns:

Property: Is the property name.
Value: Is the property value.

If the --batch option is specified, this command has the following output:

component endpoint_name :
   {
   property property1 : value1
   …
   property service_port : 50001
   property service_host : co11.co.com
   …
   property propertyn : valuen
   }

The service_host and service_port properties are always there. Other properties are user-defined.

svcpt create

The svcpt create command creates a service end point.

A service end point is a cataloged gateway appliance that is configured to talk to a specific resource.

Syntax

This command has the following format:

svcpt create /endpoint_catalog_name:endpoint_name
             /endpoint_type_catalog_name:endpoint_type_name
             [.attribute1=value1 … .attributen=valuen]
             [property1=value1 … propertyn=valuen]

Parameters

endpoint_catalog_name

Specifies the name of a global catalog to contain the service end point appliance.

endpoint_name

Specifies the name of the service end point appliance.

endpoint_type_catalog_name

Specifies the name of the global catalog that contains the service end point type.

endpoint_type_name

Specifies the name of the service end point type on which to base the appliance you want to create. The svcpt_type list command lists the available types.

.attribute1=value1 … .attributen=valuen

(Optional) Specifies values for the attributes of the appliance you want to create. Currently, only the following attribute is valid:

.description

If a value contains spaces, enclose the value in double quotation marks.

property1=value1 … propertyn=valuen

(Optional) Specifies values for service end point appliance properties. These properties are inherited from the service end point type. The svcpt_type config command lists the properties. Mandatory properties must have values.

If a value contains spaces, enclose the value in double quotation marks.

Example: Build a Gateway Appliance for a CICS Subsystem

This example builds a gateway appliance (of the CICS_GW type) for Customer Information Control System (CICS) with an address of 10.102.7.104:8601.

svcpt create /zos_svcpt:CICS_SYS01 /zos_svcpt_type:CICS_GW
             .description="Production CICS"
             service_host=10.102.7.104 service_port=8601

Example: Build a Gateway Appliance for an IMS Subsystem

This example builds a gateway appliance (of the IMS_GW type) for Information Management System (IMS) with a host name of www.sys01.com and port number of 1234. The appliance also has properties that you have defined through the svcpt_type create command.

svcpt create /zos_svcpt:IMS_SYS01 /zos_svcpt_type:IMS_GW
             .description="Production IMS"
             service_host=www.sys01.com service_port=1234
             datastoreName=IO1A 
             metadataURL=class://samples.ims.openDb.AUTPSB11DatabaseView 
             userID=IMSCTLR password=IMSCTLR

svcpt destroy

The svcpt destroy command deletes a service end point from a catalog.

Syntax

This command has the following format:

svcpt destroy /endpoint_catalog_name:endpoint_name [--force]

Parameters

endpoint_catalog_name: Specifies the name of the global catalog that contains the service end point appliance.
endpoint_name: Specifies the name of the service end point appliance.
--force: (Optional) Specifies that the deletion requires no confirmation.

Example: Delete a Service End Point Appliance Class

This example deletes the MYDB2 service end point appliance class from the zos_svcpt global catalog without asking for confirmation.

svcpt destroy /zos_svcpt:MYDB2 --force

svcpt list

The svcpt list command lists the service end points.

Syntax

This command has the following format:

svcpt list /endpoint_catalog_name [--batch]

Parameters

endpoint_catalog_name: Specifies the name of the global catalog from which you want to retrieve the list of service end point appliances.
--batch: (Optional) Displays output in UDL format. The format facilitates programmatic interpretation of the result.

Example: List the Service End Point Appliances in the svcpt Global Catalog

This example lists the service end point appliances in the svcpt catalog.

svcpt list /svcpt

This section contains the following topics:

svcpt list Command Output Specification

svcpt list output

Without the --batch option, the output of this command is a table that contains the following columns:

Endpoint

Is the name of the service end point appliance.

Type

Identifies the service end point type that is used to create the appliance.

This value has the following format:

endpoint_type_catalog_name.endpoint_type_name

Service Host

Identifies the host name or IP address of the service end point.

Service Port

Identifies the port number of the service end point.

Category

Identifies the catalog category that contains the appliance.

Description

Describes the appliance.

If the --batch option is specified, this command has the following output:

catalog endpoint_catalog_name
   {
   class endpoint_name : type = "endpoint_type_catalog_name.endpoint_type_name", service_host = "hostname_or_address", service_port = "port_number", category = "svcpt Templates", description = "endpoint_dscrp"
   …
   }

svcpt lock

The svcpt lock command prevents a service end point from modification.

Syntax

This command has the following format:

svcpt lock /endpoint_catalog_name:endpoint_name [pwd=-]

Parameters

endpoint_catalog_name

Specifies the name of the global catalog that contains the service end point appliance.

endpoint_name

Specifies the name of the service end point appliance.

pwd=-

(Optional) Prompts for a password for unlocking the service end point appliance. If you are not a maintainer, specify this parameter and provide an unlocking password. If you are a maintainer, you can lock the appliance without providing an unlocking password.

Note: If the standard input (stdin) is not a terminal device, the command does not prompt and expects only one copy of the password on stdin. (This feature can be used for batch operations to set the password from a file.)

Examples: Lock a Service End Point Appliance

This example locks the MYDB2 service end point appliance in the zos_svcpt global catalog:
```
svcpt lock /zos_svcpt:MYDB2
```
This example locks the MYDB2 service end point appliance in the zos_svcpt global catalog and prompts for a password:
```
svcpt lock /zos_svcpt:MYDB2 pwd=-
```

svcpt unlock

The svcpt unlock command unlocks a service end point.

Syntax

This command has the following format:

svcpt unlock /endpoint_catalog_name:endpoint_name [pwd=-] [--override]

Parameters

endpoint_catalog_name

Specifies the name of the global catalog that contains the service end point appliance.

endpoint_name

Specifies the name of the service end point appliance.

pwd=-

(Optional) Prompts for the password for unlocking the service end point appliance. If the appliance is locked with a password, specify this parameter. If the appliance is locked without a password, then only a maintainer can unlock the appliance.

--override

(Maintainers only) Overrides the lock on the service end point appliance.

Examples: Unlock a Service End Point Appliance

This example unlocks the MYDB2 service end point appliance in the zos_svcpt global catalog:
```
svcpt unlock /zos_svcpt:MYDB2
```
This example prompts for the password to unlock the MYDB2 service end point appliance in the zos_svcpt global catalog:
```
svcpt unlock /zos_svcpt:MYDB2 pwd=-
```
This example unlocks the MYDB2 service end point appliance in the zos_svcpt global catalog by overriding the lock:
```
svcpt unlock /zos_svcpt:MYDB2 --override
```