Get service (optimcmd -service)

Use the Get service command to get a list of services or to get detailed information about a specific service. A list of services contains the service ID, the service name, the path of the service, and the service type.

Command structure

The following diagram indicates the structure of the command and its parameters.

Read syntax diagramSkip visual syntax diagram
>>-optimcmd--+- -service-+--+-connection=-+--connection_name--+---------------------------+-><
             '- -s-------'  '-cn=---------'                   +-+-reqtype=-+--+-extract-+-+   
                                                              | '-r=-------'  +-e-------+ |   
                                                              |               +-restore-+ |   
                                                              |               +-r-------+ |   
                                                              |               +-insert--+ |   
                                                              |               +-i-------+ |   
                                                              |               +-load----+ |   
                                                              |               +-l-------+ |   
                                                              |               +-delete--+ |   
                                                              |               +-d-------+ |   
                                                              |               +-convert-+ |   
                                                              |               '-c-------' |   
                                                              '-+------------+------------'   
                                                                '-service_id-'                

Input

The following information can be entered with the command.

optimcmd
The optimcmd tool.
-service or -s
The Get service command.
connection=connection_name or cn=connection_name
The connection name of the Optim™ directory in which the services are located.
reqtype= or r=
The service type whose services you want to list. Use any of the following values:
  • extract or e: Extract
  • restore or r: Restore
  • insert or i: Insert
  • load or l: Load
  • delete or d: Delete
  • convert or c: Convert
service_id
The ID for the service that you want to view.

Output

The output depends on whether you specify a service ID.
  • If you specify a service ID, the command returns detailed information about the service.
  • If you do not specify a service ID, the command returns a list of services. Each line contains information for a service (the service ID, the service name, the path of the service, and the service type). You can optionally limit the services in this list to services with a specified service type.


Feedback