IICS Asset Management CLI V2 Utility: Command Reference Guide

Version 21

    Contents


    Overview

    You can use the IICS Asset Management CLI V2 Utility to use the IICS REST API and perform SDLC operations on IICS artifacts. The utility is a standalone, command line based utility.

     

    Downloading the IICS Asset Management CLI V2 Utility

    Access the following URL to download the IICS Asset Management CLI V2 utility:

    https://github.com/InformaticaCloudApplicationIntegration/Tools/tree/master/IICS%20Asset%20Management%20CLI/v2

    Download the utility based on the operating system that you use.

     

    Running the IICS Asset Management CLI V2 Utility

    Perform the following steps to run the utility:

    1. From the command prompt, navigate to the directory where you downloaded the utility.
    2. Run the required command.

    IICS Asset Management CLI Utility Commands

    You can use the following commands with the IICS Asset Management CLI V2 utility:

    • IICS
    • Export
    • Export Download
    • Export Status
    • Extract
    • Import
    • Import Status
    • List
    • Package
    • Publish
    • Publish Status
    • Version

    IICS

    Command line interface for the IICS application.

    Synopsis

    This command line interface provides commands to deal with SDLC for IICS artifacts.

    Options

    -h--helphelp for iics
    -v--logLevel string Log level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")

    IICS Export Command

    Exports artifacts from IICS

     

    Synopsis

    Exports artifacts from IICS.iics export [flags]

    Options

    -a--artifacts stringArrayDefines the list of artifacts to be used. The artifacts are to be represented in a normalized form, as explained below. It will be the path of the artifact from the root, followed by a period (.) character and then artifact type. The following are the list of available artifact types:
    •   AI_CONNECTION (for application integration connections)
    •   AI_SERVICE_CONNECTOR (for service connectors)
    •   DTEMPLATE (for mappings)
    •   GUIDE (for guides)
    •   PROCESS (for processes)
    •   PROCESS_OBJECT (for process objects)
    •   MAPPLET (for mapplets)
    •   MTT (for mapping tasks)
    •   DSS (for synchronization tasks)
    •   DRS (for replication tasks)
    •   DMASK (for masking tasks)
    •   FWCONFIG (for fixed width file formats)
    •   VISIOTEMPLATE (for visio templates)
    •   PCS (for powercenter tasks)
    •   CustomSource (for saved query)
    •   TASKFLOW (for taskflows)
    •   FOLDER (for folders)
    •   PROJECT (for projects)
    Examples:
    •   Explore/ProjectName/FolderName/MyProcess.PROCESS
    •   Explore/ProjectName/MyConnection.AI_CONNECTION
    •   Explore/ProjectName/MyFolderName.Folder
    •   Explore/MyProjectName.Project
    If you want to specify multiple artifacts, use the flag multiple times (for example, -a artifact1 -a artifact2)Note: The -a and -f arguments are mutually exclusive. If the path values contain spaces, you must enclose them within double quotes.
    -f--artifactsFile stringDefines the path and file name of the file that contains a list of artifacts to be used. Refer to the artifacts file for more details.
    -h--helphelp for export
    -m--maxWaitTime intOptional. Indicates the maximum time (in seconds) to wait for the request to complete. Applicable only with --sync. (default 120)
    -n--name stringName of the request. This is used as the name of the export job.
    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
      -P--pollingInterval intOptional. Indicates how often to poll for status (in seconds). Applicable only with --sync. (default 10)
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -s--syncOptional. Controls whether the command is blocking or non-blocking.If set to true, the command will be a blocking call. The command will issue the request and wait for the action to be  completed.If set to false, the command will be a non-blocking call. The command will issue the request, but not wait for the action to complete. It will return the request id. You can use the request id in subsequent operations such as checking the status of the request.(default true)
    -u--username stringUser name to log in with.
    -z--zipFilePath stringLocation (including name) of the zip file to create. The location can be a relative path or absolute path.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")

    IICS Export Download Command

    Downloads the IICS export zip file.

    Synopsis

    Downloads the IICS export zip file.iics export download [flags]

    Options

    -h--helphelp for export
    -I--id string Id of the original request.
    -z--zipFilePath stringLocation (including name) of the zip file to create. The location can be a relative path or absolute path.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")
    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -u--username stringUser name to log in with.

    IICS Export Status Command

    Gets the status of an export from IICS.

    Synopsis

    Gets the status of an export from IICS.iics export status [flags]

    Options

    -h--helphelp for status
    -I--id string  Id of the original request.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")
    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -u--username stringUser name to log in with.

    IICS Extract Command

    Extracts an IICS zip file into a local workspace folder.

     

    Synopsis

    Run this command to extract an IICS zip file into a local workspace directory. The command extracts the zip file contents into individual assets.On extraction, the utility creates one metadata file in the local workspace directory for each project, folder, or artifact. The metadata file resides alongside the project, folder, or artifact file and will have a period character (.) before the file name. For example, if you extract the file /Explore/MyProject/a.PROCESS.xml, a corresponding metadata file /Explore/MyProject/.a.PROCESS.xml is created. Note the period character before the file name.

    Note: The metadata files might be hidden by default in some file systems because the file names start with a period character. The metadata files must be preserved along with the project, folder, or artifact file. For example, if you add the workspace contents to a version control system, you must also add the metadata files to the version control system. Similarly, when you check out the contents from a version control system, you must also check out the metadata files from the version control system.

     

    iics extract [flags]

     

    Options

    -h--helphelp for extract
    -w--workspaceDir string Directory into which the artifacts will be exported.
    -z--zipFilePath stringLocation (including name) of the zip file that contains the artifacts. The location can be a relative path or absolute path.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")

    IICS Import Command

    Imports artifacts into IICS.

    Synopsis

    Imports artifacts into IICS.iics import [flags]

    Options

    -h--helphelp for import
    -m--maxWaitTime intOptional. Indicates the maximum time (in seconds) to wait for the request to complete. Applicable only with --sync. (default 120)
    -n--name stringName of the request. This is used as the name of the import job.
    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
      -P--pollingInterval intOptional. Indicates how often to poll for status (in seconds). Applicable only with --sync. (default 10)
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -s--syncOptional. Controls whether the command is blocking or non-blocking.If set to true, the command will be a blocking call. The command will issue the request and wait for the action to be  completed.If set to false, the command will be a non-blocking call. The command will issue the request, but not wait for the action to complete. It will return the request id. You can use the request id in subsequent operations such as checking the status of the request.(default true)
    -u--username stringUser name to log in with.
    -z--zipFilePath stringLocation of the zip file containing artifacts to be imported. The location can be a relative path or absolute path.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")

    IICS Import Status Command

    Gets the status of an import into IICS.

    Synopsis

    Gets the status of an import into IICS.iics import status [flags]

    Options

    -h--helphelp for status
    -I--id string  Id of the original request.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")
    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -u--username stringUser name to log in with.

    IICS List Command

    Lists artifacts in IICS

    Synopsis

    Lists artifacts in IICS.iics list [flags]

    Options

    -h--helphelp for list
    -o--outputFile stringLocation (including name) of the artifacts list file to create. The location can be a relative path or absolute path. If you do not specify this argument, the command prints the list of IICS artifacts to the standard output.
    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
    -q--query stringArraySpecifies the queries to filter the IICS artifacts that you want to include in the artifacts list. You can define multiple query parameters separated with a space character. The command performs an AND operation when you define multiple query parameters.You can use the following parameters to construct the query:location: Defines where the artifact is stored in IICS. Include the project and folder name in the location.tag: Defines the tag associated with the asset.type: Defines the artifact type. Use one of the following values:
    • AI_CONNECTION (for application integration connections)
    • AI_SERVICE_CONNECTOR (for service connectors)
    • DTEMPLATE (for mappings)
    • GUIDE (for guides)
    • PROCESS (for processes)
    • PROCESS_OBJECT (for process objects)
    • MAPPLET (for mapplets)
    • MTT (for mapping tasks)
    • DSS (for synchronization tasks)
    • DRS (for replication tasks)
    • DMASK (for masking tasks)
    • FWCONFIG (for fixed width file formats)
    • VISIOTEMPLATE (for visio templates)
    • PCS (for powercenter tasks)
    • CustomSource (for saved query)
    • TASKFLOW (for taskflows)
    • FOLDER (for folders)
    • PROJECT (for projects)
    updateTime: Defines a filter condition based on the last updated time for the artifact. You can use operators such as <, <=, >, >=, and = in conjunction with the last updated time.Note: You must specify the URL-encoded value when using operators such as >= or <= in the query. For example:
    • Query parameter "updateTime>=2018-05-28T13:54:11Z" must be replaced with "updateTime%3E%3D2018-05-28T13:54:11Z"
    • Query parameter "updateTime<=2018-05-28T13:54:11Z" must be replaced with "updateTime%3C%3D 2018-05-28T13:54:11Z"
    updatedBy: Defines the user name of the user account that last updated the artifact.Use the following syntax to define the query parameters:-q "location==<value>" -q "tag==<value>" -q "type==<value>" -q "updateTime==<value>" -q "updatedBy==<value>"Note: You must use two == operators between the parameter name and value. If any value contains space characters, you must enclose the parameter-value pair within double quotes.
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -u--username stringUser name to log in with.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")

    IICS Package Command

    Packages artifacts from a local workspace folder into a zip file.

    Synopsis

    Packages artifacts and metadata from a local workspace folder into a zip file. This zip file can then be imported into IICS.iics package [flags]

    Options

    -a--artifacts stringArrayDefines the list of artifacts to be used. The artifacts are to be represented in a normalized form, as explained below. It will be the path of the artifact from the root, followed by a period (.) character and then artifact type. The following are the list of available artifact types:
    •   AI_CONNECTION (for application integration connections)
    •   AI_SERVICE_CONNECTOR (for service connectors)
    •   DTEMPLATE (for mappings)
    •   GUIDE (for guides)
    •   PROCESS (for processes)
    •   PROCESS_OBJECT (for process objects)
    •   MAPPLET (for mapplets)
    •   MTT (for mapping tasks)
    •   DSS (for synchronization tasks)
    •   DRS (for replication tasks)
    •   DMASK (for masking tasks)
    •   FWCONFIG (for fixed width file formats)
    •   VISIOTEMPLATE (for visio templates)
    •   PCS (for powercenter tasks)
    •   CustomSource (for saved query)
    •   TASKFLOW (for taskflows)
    •   FOLDER (for folders)
    •   PROJECT (for projects)
    Examples:
    •   Explore/ProjectName/FolderName/MyProcess.PROCESS
    •   Explore/ProjectName/MyConnection.AI_CONNECTION
    •   Explore/ProjectName/MyFolderName.Folder
    •   Explore/MyProjectName.Project
    If you want to specify multiple artifacts, use the flag multiple times (for example, -a artifact1 -a artifact2)Note: The -a and -f arguments are mutually exclusive. If the path values contain spaces, you must enclose them within double quotes.
    -f--artifactsFile stringDefines the path and file name of the file that contains a list of artifacts to be used. Refer to the artifacts file for more details.
    -h--helphelp for package
    -w--workspaceDir stringDirectory that contains the artifacts to be packaged. Note that this should be the root workspace directory.

    -z--zipFilePath stringFile path for the zip file to be created.

    Options Inherited from Parent Commands

    -v,--logLevel stringLog level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.(default "info")

    IICS Publish Command

    Publishes artifacts in IICS.

    Synopsis

    Publishes artifacts in IICS. You can publish connections, service connectors, guides, processes, and taskflows. After the command runs successfully, the status of the artifact changes to Published in IICS. You can view and copy the generated service URLs from IICS.

     

    iics publish [flags]

    Options

    -a--artifacts stringArrayDefines the list of artifacts to be used. The artifacts are to be represented in a normalized form, as explained below. It will be the path of the artifact from the root, followed by a period (.) character and then artifact type. The following are the list of available artifact types:
    •   AI_CONNECTION (for application integration connections)
    •   AI_SERVICE_CONNECTOR (for service connectors)
    •   DTEMPLATE (for mappings)
    •   GUIDE (for guides)
    •   PROCESS (for processes)
    •   PROCESS_OBJECT (for process objects)
    •   MAPPLET (for mapplets)
    •   MTT (for mapping tasks)
    •   DSS (for synchronization tasks)
    •   DRS (for replication tasks)
    •   DMASK (for masking tasks)
    •   FWCONFIG (for fixed width file formats)
    •   VISIOTEMPLATE (for visio templates)
    •   PCS (for powercenter tasks)
    •   CustomSource (for saved query)
    •   TASKFLOW (for taskflows)
    •   FOLDER (for folders)
    •   PROJECT (for projects)
    Examples:
    •   Explore/ProjectName/FolderName/MyProcess.PROCESS
    •   Explore/ProjectName/MyConnection.AI_CONNECTION
    •   Explore/ProjectName/MyFolderName.Folder
    •   Explore/MyProjectName.Project

     

    If you want to specify multiple artifacts, use the flag multiple times (for example, -a artifact1 -a artifact2)

     

    Note: The -a and -f arguments are mutually exclusive. If the path values contain spaces, you must enclose them within double quotes.

    -f

    --artifactsFile string

    Defines the path and file name of the file that contains a list of artifacts to be used. Refer to the artifacts file for more details.

    -h

    --help

    help for publish

    -m
    --maxWaitTime intOptional. Indicates the maximum time (in seconds) to wait for the request to complete. Applicable only with --sync. (default 120)
    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
    -P--pollingInterval intOptional. Indicates how often to poll for status (in seconds). Applicable only with --sync. (default 10)
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -s--sync

    Optional. Controls whether the command is blocking or non-blocking.

    If set to true, the command will be a blocking call. The command will issue the request and wait for the action to be  completed.

    If set to false, the command will be a non-blocking call. The command will issue the request, but not wait for the action to complete. It will return the request id. You can use the request id in subsequent operations such as checking the status of the request.

    (default true)

    -u--username stringUser name to log in with.

     

    Options Inherited from Parent Commands

    -v,--logLevel string

    Log level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.

     

    (default "info")

     

    IICS Publish Status Command

    Gets the status of a publish job.

     

    Synopsis

    Gets the status of a publish job.

     

    iics publish status [flags]

     

    Options

    -h

    --help

    help for status

    -I

    --id string  Id of the original request.

     

    Options Inherited from Parent Commands

    -v,--logLevel string

    Log level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.

     

    (default "info")

    -p--password stringPassword to log in with.
    --podHostName stringHost name of the pod to be used for IICS interactions.
    -r--region stringIICS region to which the org belongs. For example, us, eu, ap.
    -u--username stringUser name to log in with.

     

    IICS Version Command

    Prints the application version.

     

    Synopsis

    Prints the application version.

     

    iics version [flags]

     

    Options

    -h

    --help

    help for version

     

    Options Inherited from Parent Commands

    -v,--logLevel string

    Log level with which the command is run. The value can be error, warn, info, or trace. The value indicates the maximum log level. For example, if set to warn, both warn and error messages will be displayed. If set to trace, all log messages will be displayed.

     

    (default "info")

     

    Use Case References

    https://network.informatica.com/docs/DOC-18262

    https://network.informatica.com/docs/DOC-18287