Managing Integrations with MI CLI¶ The WSO2 Integrator: MI CLI allows you to monitor the Synapse artifacts (deployed in a specified WSO2 Integrator: MI server) and perform various management and administration tasks from the command line. Download and initialize the MI CLI¶ Download MI CLI based on your preferred platform (i.e., Mac, Windows, Linux). For Mac with Intel Chip For Mac with Apple Silicon For Linux 32-bit For Linux 64-bit with AMD processor For Linux 64-bit with ARM processor For Windows 32-bit For Windows 64-bit Extract the downloaded archive of the mi to the desired location. Navigate to the working directory where the executable mi resides. Add the current working directory to your system's $PATH variable to be able to access the executable from anywhere. Execute the following command to start the MI CLI. Warn If you have previously used an MI CLI old version, backup and remove /home/<user>/.wso2mi directory and reconfigure the environments using the commands as explained below in Add an environment section. mi The directory structure for the configuration files (<USER_HOME>/.wso2mi) will be created upon the execution of the mi command. Tip For further instructions, execute the following command. mi --help Global flags for MI CLI¶ The following are some global flags that you can use with any MI CLI command. --verbose Enable verbose logs (Provides more information on execution) --insecure, -k Allow connections to SSL sites without certs --help, -h Display information and example usage of a command Check the version of the MI CLI¶ Run the following MI CLI command to check the version. Command mi version Response Version: 4.7.0 Build Date: 2025-02-07 12:58:05 UTC Set proxy environment variables for MI CLI¶ You can set proxy related HTTP_PROXY, HTTPS_PROXY, http_proxy, and https_proxy standard environment variables, with or without basic authentication as shown below to send the requests initiated from CLI via a proxy server. After one of the following environment variables is set in your environment where CLI is used, all the requests will go through the proxy server specified. Formats Without Basic AuthenticationWith Basic Authentication export HTTP_PROXY="http://<host-name>:<port>" export HTTPS_PROXY="https://<host-name>:<port>" export http_proxy="http://<host-name>:<port>" export https_proxy="https://<host-name>:<port>" export HTTP_PROXY="http://<username>:<password>@<host-name>:<port>" export HTTPS_PROXY="https://<username>:<password>@<host-name>:<port>" export http_proxy="http://<username>:<password>@<host-name>:<port>" export https_proxy="https://<username>:<password>@<host-name>:<port>" Examples Without Basic AuthenticationWith Basic Authentication export HTTP_PROXY="http://localhost:3128" export HTTPS_PROXY="https://localhost:3128" export http_proxy="http://localhost:3128" export https_proxy="https://localhost:3128" export HTTP_PROXY="http://testuser:password@localhost:3128" export HTTPS_PROXY="https://testuser:password@localhost:3128" export http_proxy="http://testuser:password@localhost:3128" export https_proxy="https://testuser:password@localhost:3128" Add an environment¶ You can add environments by either manually editing the <USER_HOME>/.wso2mi/main_config.yaml file or by running the following MI CLI command. mi add env <environment-name> Make sure that the WSO2 Integrator: MI (WSO2 MI) 4.7.0 version is started and that the 4.7.0 version of MI CLI is set up. For more information, see Download and Initialize the MI CLI. Run the following MI CLI command to add an environment. Command mi add env <environment-name> <mi-management-endpoint> Example mi add env dev https://localhost:9164 Response Response FormatExample Response Successfully added environment '<environment-name>' Successfully added environment 'production' Delete an environment¶ Make sure that the WSO2 Integrator: MI (WSO2 MI) 4.7.0 version is started and that the 4.7.0 version of MI CLI is set up. For more information, see Download and Initialize the MI CLI. Run the following MI CLI command to delete an environment. Command mi delete env <environment-name> Example mi delete env production Response Response FormatExample Response Successfully deleted environment '<environment-name>' Execute 'mi add env --help' to see how to add a new environment Successfully deleted environment 'production' Execute 'mi add env --help' to see how to add a new environment Get environments¶ Make sure that the WSO2 Integrator: MI (WSO2 MI) 4.7.0 version is started and that the 4.7.0 version of MI CLI is set up. For more information, see Download and Initialize the MI CLI. Run the following MI CLI command to list the environments. Command mi get envs Info Flags: Optional : --format : pretty-print environments using Go templates Response Response FormatExample Response NAME MI MANAGEMENT ENDPOINT <environment-name> <mi-management-endpoint> NAME MI MANAGEMENT ENDPOINT dev-mi https://localhost:9164 Info Before you begin Ensure that WSO2 Integrator: MI is started. See the instructions on installing the WSO2 Integrator: MI. Make sure the MI CLI is downloaded and initialized, if not follow the steps in Download and Initialize the MI CLI. Ensure that the WSO2 Integrator: MI management endpoint is added to the environment configurations of CLI, before you start working with the following CLI commands. For more information, see Add an environment section. Login to a WSO2 Integrator: MI¶ After adding an environment, you can login to the WSO2 Integrator: MI instance of that environment using credentials. Run any of the following CLI commands to login to a WSO2 Integrator: MI. Command mi login <environment-name> -k mi login <environment-name> -u <username> -k mi login <environment-name> -u <username> -p <password> -k Tip If you run mi login <environment-name> you are prompted to provide both the username and the password. If you run mi login <environment-name> --username <username>, you are prompted to provide the password. Info Flags: Optional : --username or -u : Username for login --password or -p : Password for login --password-stdin : Get password from stdin Example mi login dev -k mi login dev -u admin -p admin -k mi login dev --username admin --password admin -k Response Response FormatExample Response Logged into MI in '<environment-name>' environment Logged into MI in dev environment Warning Using --password in CLI is not secure. You can use --password-stdin instead. For example, cat ~/.mypassword | ./mi login dev --username admin --password-stdin -k Logout from a WSO2 Integrator: MI¶ Run the following command to logout from the current session of the WSO2 Integrator: MI. Command mi logout <environment-name> Example mi logout dev Response Response FormatExample Response Logged out from MI in '<environment-name>' environment Logged out from MI in dev environment Manage Users¶ You can view details of users stored in the external user store. If you are logged in to the MI CLI with administrator credentials, you can also add new users, and remove users from the user store. Get information about users¶ List users of the WSO2 Integrator: MI. Command mi get users -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates --pattern or -p : Filter users by regex --role or -r : Filter users by role Example mi get users -e dev mi get users -r admin -e dev mi get users -p *tester* -e dev Response USER ID admin capp-tester Get information on a specific user. Command mi get users [user-name] -d [domain] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --domain or -d : Domain name of the secondary user store to be searched --format : pretty-print using templates Example mi get users capp-tester -d testing.com -e dev Response Name - TESTING.COM/capp-tester Is Admin - false Roles - TESTING.COM/tester, Application/applicationRole1 Add a new user¶ You can use the command below to add a new user to a WSO2 Integrator: MI. Command mi add user [user-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi add user capp-tester -e dev Response Adding new user [ capp-tester ] status: Added Note To add a new user to a secondary user store, provide the corresponding user store domain when prompted. Delete a user¶ You can use the command below to remove a user from the WSO2 Integrator: MI. Command mi delete user [user-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI Optional : --domain or -d : The domain of the secondary user store from which the user should be deleted Example mi delete user capp-tester -d testing.com -e dev Response Deleting user [ capp-tester ] status: Deleted Manage Roles¶ The WSO2 Integrator: MI has limited role support without fine-grained permission tree support as in the Enterprise Integrator. In WSO2 Integrator: MI, we have one admin role and all the other roles from primary and secondary user stores are considered non-admin roles. Get information about roles¶ List roles of the WSO2 Integrator: MI. Command mi get roles -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi get roles -e dev Response ROLE admin primaryRole1 Application/applicationRole1 Internal/everyone Internal/internalRole1 TEST.COM/testRole1 Get information on a specific role. Command mi get roles [role-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --domain or -d : Domain of the secondary user store to be searched Example mi get roles tester -d testing.com -e dev Response Role Name - TESTING.COM/tester Users - TESTING.COM/capp-tester Note To get hybrid roles (application/internal) specify the role type as the domain. mi get roles tester -d application -e dev Add a new role¶ Command bash mi add role [role-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI Example bash mi add role tester -e dev Response Adding new role [ tester ] status: Added Note To add a new role to a secondary user store, provide the corresponding user store domain when prompted. Note To add hybrid roles (application/internal) specify the type in the role name. mi add role internal/InternalRole -e dev Delete a role¶ Command mi delete role [role-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI Optional : --domain or -d : The domain of the secondary user store from which the role should be deleted Example mi delete role tester -d testing.com -e dev Response Deleting new role [ tester ] status: Deleted Note To delete hybrid roles (application/internal) specify the role type as domain. mi delete role InternalRole -d internal -e dev Assign/revoke roles to/from users¶ Command mi update user [user-name] -e <environment> Info Flags: - Required : `--environment` or `-e` : Environment of the WSO2 Integrator: MI Example mi update user capp-tester -e dev Response Added/removed the roles Note Use a space-separated list of role names when entering the added/removed roles Monitor Integration Artifacts¶ Follow the instructions below to display a list of artifacts or get information about a specific artifact in an environment using CLI: Composite Applications (CApps)¶ List composite applications (CApps) in an environment. Command mi get composite-apps -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get composite-apps -e dev Response NAME VERSION HealthCareCompositeExporter 1.0.0 FoodServiceCApp 2.0.0 Get information on a specific composite application in an environment. Command mi get composite-apps [capp-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get composite-apps HealthCareCompositeExporter -e dev Response Name - HealthCareCompositeExporter Version - 1.0.0 Artifacts : NAME TYPE sample-local-entry local-entry email-connector lib in-memory-message-store message-store GrandOakEndpoint endpoint sample_seq_template template scheduled-msg-processor message-processors sample_template template HealthcareAPI api sample-sequence sequence PineValleyEndpoint endpoint StockQuoteProxy proxy-service sample-cron-task task httpInboundEP inbound-endpoint Integration APIs¶ List integration APIs in an environment. Command mi get apis -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get apis -e dev Response NAME URL HealthcareAPI http://localhost:8290/healthcare FoodService http://localhost:8480/foodservice Get information on a specific integration API in an environment. Command mi get apis [api-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get apis HealthcareAPI -e dev Response Name - HealthcareAPI Version - N/A Url - http://localhost:8290/healthcare Stats - disabled Tracing - disabled Resources : URL METHOD /doctor/{doctorType} [GET] /report [GET] Connectors¶ List connectors in an environment. Command mi get connectors -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get connectors -e dev Response NAME STATS PACKAGE DESCRIPTION email enabled org.wso2.carbon.connector WSO2 email connector library Data Services¶ List data services in an environment. Command mi get data-services -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get data-services -e dev Response NAME WSDL 1.1 WSDL 2.0 RESTDataService http://localhost:8290/services/RESTDataService?wsdl http://localhost:8290/services/RESTDataService?wsdl2 Get information on a specific data service in an environment. Command mi get data-services [data-service-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get data-services RESTDataService -e dev Response Name - RESTDataService Group Name - RESTDataService Description - Exposing the data service as a REST service. WSDL 1.1 - http://localhost:8290/services/RESTDataService?wsdl WSDL 2.0 - http://localhost:8290/services/RESTDataService?wsdl2 Queries : ID NAMESPACE ReadStudents http://ws.wso2.org/dataservice/ReadStudents DeleteStudent http://ws.wso2.org/dataservice Endpoints¶ List endpoints in an environment. Command mi get endpoints -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get endpoints -e dev Response NAME TYPE ACTIVE GrandOakEndpoint http true PineValleyEndpoint http true Get information on a specific endpoint in an environment. Command mi get endpoints [endpoint-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get endpoints GrandOakEndpoint -e dev Response Name - GrandOakEndpoint Type - HTTP Endpoint Active - true Method - GET URI Template - http://localhost:9091/grand/doctors Inbound Endpoints¶ List inbound endpoints in an environment. Command mi get inbound-endpoints -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get inbound-endpoints -e dev Response NAME TYPE STATUS httpInboundEP http active Get information on a specific inbound endpoint in an environment. Command mi get inbound-endpoints [inbound-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get inbound-endpoints httpInboundEP -e dev Response Name - httpInboundEP Type - http Stats - enabled Tracing - enabled Status - active Parameters : NAME VALUE inbound.http.port 8697 inbound.worker.pool.size.core 400 inbound.worker.pool.size.max 500 inbound.worker.thread.keep.alive.sec 60 inbound.worker.pool.queue.length -1 inbound.thread.id PassThroughInboundWorkerPool Activate/deactivate a specific inbound endpoint in an environment. Command mi activate inbound-endpoint [inbound-name] -e <environment> mi deactivate inbound-endpoint [inbound-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi deactivate inbound-endpoint sampleFileInboundEndpoint -e dev Response sampleFileInboundEndpoint : is deactivated Note The activate/deactivate capability of inbound endpoints is currently supported only for the file inbound endpoint protocol. Local Entries¶ List local entries in an environment. Command mi get local-entries -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get local-entries -e dev Response NAME TYPE sample-local-entry Inline Text Get information on a specific local entry in an environment. Command mi get local-entries [local-entry-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get local-entries sample-local-entry -e dev Response Name - sample-local-entry Type - Inline Text Value - 0, 1 Message Processors¶ List message processors in an environment. Command mi get message-processors -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get message-processors -e dev Response NAME TYPE STATUS scheduled-msg-processor Scheduled-message-forwarding-processor active Get information on a specific message processor in an environment. Command mi get message-processors [message-processor-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get message-processors scheduled-msg-processor -e dev Response Name - scheduled-msg-processor Type - Scheduled-message-forwarding-processor File Name - scheduled-msg-processor-1.0.0.xml Message Store - in-memory-message-store Artifact Container - [ Deployed From Artifact Container: HealthCareCompositeExporter ] Status - active Parameters : client.retry.interval = 1000 interval = 1000 is.active = true max.delivery.attempts = 4 max.delivery.drop = Disabled max.store.connection.attempts = -1 member.count = 1 store.connection.retry.interval = 1000 target.endpoint = PineValleyEndpoint throttle = false Message Stores¶ List message stores in an environment. Command mi get message-stores -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get message-stores -e dev Response NAME TYPE SIZE in-memory-message-store in-memory-message-store 0 Get information on a specific message store in an environment. Command mi get message-stores [message-store-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get message-stores in-memory-message-store -e dev Response Name - in-memory-message-store File Name - in-memory-message-store-1.0.0.xml Container - [ Deployed From Artifact Container: HealthCareCompositeExporter ] Producer - org.apache.synapse.message.store.impl.memory.InMemoryProducer@3d288f9e Consumer - org.apache.synapse.message.store.impl.memory.InMemoryConsumer@5e6443d6 Size - 0 Properties : No Properties found Proxy Services¶ List proxy services in an environment. Command mi get proxy-services -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get proxy-services -e dev Response NAME WSDL 1.1 WSDL 2.0 StockQuoteProxy http://localhost:8290/services/StockQuoteProxy?wsdl http://localhost:8290/services/StockQuoteProxy?wsdl2 Get information on a specific proxy service in an environment. Command mi get proxy-services [proxy-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get proxy-services StockQuoteProxy -e dev Response Name - StockQuoteProxy WSDL 1.1 - http://localhost:8290/services/StockQuoteProxy?wsdl WSDL 2.0 - http://localhost:8290/services/StockQuoteProxy?wsdl2 Stats - disabled Tracing - disabled Sequences¶ List sequences in an environment. Command mi get sequences -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get sequences -e dev Response NAME STATS TRACING fault disabled disabled main disabled disabled sample-sequence disabled disabled Get information on a specific sequence in an environment. Command mi get sequences [sequence-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get sequences sample-sequence -e dev Response Name - sample-sequence Container - [ Deployed From Artifact Container: HealthCareCompositeExporter ] Stats - disabled Tracing - disabled Mediators - LogMediator, STRING Scheduled triggers¶ List Scheduled triggers in an environment. Command mi get tasks -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get tasks -e dev Response NAME sample-cron-task CheckPriceTask Get information on a specific Scheduled trigger in an environment. Command mi get tasks [task-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get tasks sample-cron-task -e dev Response Name - sample-cron-task Trigger Type - cron Cron Expression - 0 30 1 * * ? Templates¶ List all templates in an environment. Command mi get templates -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get templates -e dev Response NAME TYPE sample_seq_template Sequence sample_template Endpoint List a specific type of template in an environment. Command mi get templates [template-type] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get templates endpoint -e dev mi get templates sequence -e dev Response NAME sample_seq_template Get information on a specific template in an environment. Command mi get templates [template-type] [template-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get templates endpoint sample_template -e dev Response Name - sample_template Parameters : name, uri Change status of an Artifact¶ You can use the commands below to activate or deactivate endpoints, message processors or proxy services deployed in a WSO2 Integrator: MI. Endpoint¶ Activate an endpoint deployed in a WSO2 Integrator: MI. Command mi activate endpoint [endpoint-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi activate endpoint GrandOakEndpoint -e dev Response GrandOakEndpoint is switched On Deactivate an endpoint deployed in a WSO2 Integrator: MI. Command mi deactivate endpoint [endpoint-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi deactivate endpoint GrandOakEndpoint -e dev Response GrandOakEndpoint is switched Off Message Processor¶ Activate a message processor deployed in a WSO2 Integrator: MI. Command mi activate message-processor [message-processor-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi activate message-processor scheduled-msg-processor -e dev Response scheduled-msg-processor : is activated Deactivate a message processor deployed in a WSO2 Integrator: MI. Command mi deactivate message-processor [message-processor-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi deactivate message-processor scheduled-msg-processor -e dev Response scheduled-msg-processor : is deactivated Proxy Service¶ Activate a proxy service deployed in a WSO2 Integrator: MI. Command mi activate proxy-service [proxy-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi activate proxy-service StockQuoteProxy -e dev Response Proxy service StockQuoteProxy started successfully Deactivate a proxy service deployed in a WSO2 Integrator: MI. Command mi deactivate proxy-service [proxy-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi deactivate proxy-service StockQuoteProxy -e dev Response Proxy service StockQuoteProxy stopped successfully Manage Loggers used in WSO2 Integrator: MI¶ Get information on a specific logger¶ Command mi get log-levels [logger-name] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get log-levels org-apache-coyote -e dev Response NAME LOG LEVEL COMPONENT org-apache-coyote WARN org.apache.coyote Add a new logger¶ You can use the command below to add a new logger to a WSO2 Integrator: MI. Command mi add log-level [logger-name] [class-name] [log-level] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi add log-level synapse-api org.apache.synapse.rest.API DEBUG -e dev Response Successfully added logger for ('synapse-api') with level DEBUG for class org.apache.synapse.rest.API Update a logger¶ You can use the command below to update the log level of an existing logger. Command mi update log-level [logger-name] [log-level] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Example mi update log-level org-apache-coyote DEBUG -e dev Response Successfully added logger for ('org-apache-coyote') with level DEBUG Download log files¶ List available log files¶ Command mi get logs -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --format : pretty-print using templates Example mi get logs -e dev Response NAME SIZE wso2carbon.log 429.5 KB correlation.log 0 B wso2carbon-trace-messages.log 0 B wso2-mi-api.log 11.9 KB patches.log 15.7 KB audit.log 0 B wso2-mi-service.log 10.3 KB http_access_.log 35.8 KB wso2error.log 156.2 KB Download a specific log file¶ Command mi get logs [file-name] -p [download-location] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI to be searched Optional : --path or -p : Path the file should be downloaded (default is current executable directory) Example mi get logs wso2carbon.log -p log-files -e dev Response Log file downloaded to log-files/wso2carbon.log Encrypting Secrets with MI CLI¶ WSO2 MI CLI (mi) allows you to encrypt a plain-text secret. You can use this feature to export secrets as environment variables, system properties, Docker secrets, or Kubernetes secrets. For more information on using dynamic secrets refer Dynamic secrets. Initialize MI CLI with a key store¶ Note Secret encryption supports only JKS Key Stores. Note Key Store used in this step needs to be the same Key Store which is used by the WSO2 Integrator: MI (WSO2 MI) to decrypt secrets. Run the following command to initialize the MI CLI with the Key Store used to encrypt the secrets. It will prompt you to input the following, Key Store location Path to the Key Store used by the WSO2 MI to decrypt secrets Key Store password The password of the Key Store Key alias The alias of the key used to encrypt the secrets Key password The password of the key used to encrypt the secrets Command mi secret init Example mi secret init Enter Key Store location: /home/wso2mi-4.2.0/repository/resources/security/wso2carbon.jks Enter Key Store password: Enter Key alias: wso2carbon Enter Key password: Response Key Store initialization completed Encrypt secrets¶ Note Secret encryption supports only RSA/ECB/OAEPWithSHA1AndMGF1Padding (default) or RSA/ECB/PKCS1Padding as encryption algorithm. Note Encrypting algorithm used in this step needs to be the same algorithm used by the WSO2 MI to decrypt secrets. Run the following command to encrypt secrets with the MI CLI, Command mi secret create Info Flags: Optional : --cipher or -c : Encryption algorithm (default is RSA/ECB/OAEPWithSHA1AndMGF1Padding) --output or -o : Get the output in yaml (k8) or properties (file) format. By default the output is printed to the console --from-file or -f : Path to the properties file which contains secrets to be encrypted Encrypt a secret and get output on console Example mi secret create Enter plain alias for secret:db_password Enter plain text secret: Repeat plain text secret: Response db_password : eKALmLVA+HFVl7vqLUUhm6o0Vwsap+L6czwyEKWKomX+AcRmOCAHmiujPXPAZUboWJlZi4k0CwZYAvwD4BflbU8j5CCrtESzOlOrkJaJPormf/ViixRbftae2RqaDozPSEp9zSnfDKlKDXRq== Encrypt secrets defined in a properties file Example mi secret create -f ./keys/secrets.properties Response db_password : JVlyw8j9TQqoPFTQUnKxNoGJn9p4+gGCHkkyHt2jXGVZoe60xndi2GjBJ1roR6667dlynhABXbcv434DFjz3ZI0iRjg1QhJLoXNtttSFl7KtyNDk5VtRMPDqAckheJAJe02KjWgdZXszEzjtBd6o2mY1nipsWBat3cOq0kt== admin_password : gPImOAX1zwHu3malMHm0+Zy5WEcfKpUSmxJ2ZXfI3bi1yIZbHjrHUxiY+MKurTWRN8GJ6+EVL== Encrypt secrets defined in a properties file and get a .yaml file Example mi secret create -o k8 -f ./keys/secrets.properties Response Kubernetes secret file created in mi/security/wso2-secrets.yaml with default name and namespace You can change the default values as required before applying. Update HashiCorp AppRole Pull secret ID¶ You can use the command below to update the HashiCorp AppRole Pull secret ID that is used by the WSO2 Integrator: MI to connect with HashiCorp. Note The HashiCorp secret ID is only applicable when AppRole Pull authentication is used between the WSO2 Integrator: MI and HashiCorp. This command only updates the SecretId for the current session of the WSO2 Integrator: MI. To persist the Secret Id, you need to update the deployment.toml file and restart the WSO2 Integrator: MI. See Using HashiCorp Secrets for details. Command mi update hashicorp-secret [secret_id] -e <environment> Info Flags: Required : --environment or -e : Environment of the WSO2 Integrator: MI for which the HashiCorp secret ID should be updated. Example mi update hashicorp-secret 47c39b09-c0a9-6ebf-196e-038eb7aad336 -e dev Response SecretId value is updated in HashiCorp vault runtime configurations. To persist the new SecretId in the next server startup, please update the deployment.toml file