Axway Open Documentation Save PDF Selected topic Selected topic and subtopics All content Go to Amplify Platform getting started and onboarding roadmap YAML CLI overview YAML CLI tool overview 2 minute read The yamles CLI tool is available in the apigateway/posix/bin directory. It is installed with a standard server-side install or with client tooling, when the Package & Deploy Tools only option is selected during the installation. You can run the yamles script with --help to see all the available options: ./yamles --help The following lists the CLI options and their descriptions: fed2yaml: Convert an XML federated configuration to a YAML configuration. frag2yaml: Convert an XML configuration fragment to a YAML configuration fragment. validate: Validate a YAML configuration. export: Export part of a YAML configuration to create another YAML configuration. import: Import a YAML configuration or a YAML configuration fragment into another YAML configuration. encrypt: Encrypt an unencrypted YAML configuration, a string, or a file. For more information. change-passphrase: Change the passphrase of a YAML configuration. upgrade: Upgrade a YAML configuration. To get help with a specific option, run: ./yamles <option> --help All script parameters have shorthand parameter names. Check the relevant help for more information. All script options generate a trace file in the current directory by default. You can use --tracedir to write trace to another directory, or --tracelevel to change the level of tracing. The yamles script returns the following exit codes: 0 for success 2 for invalid parameters 1 for all other failures Note For Windows systems, the CLI tool is located in the apigateway\Win32\bin directory. You must replace all ./yamles ... with yamles.bat .... Also, all options with URLs must be set as follows: FED: --source federated:file:/C:\Users\...\configs.xml or --source federated:file:/C:/Users/.../configs.xml YAML: --source yaml:file:/C:\Users\... or --source yaml:file:/C:/Users/... Convert API Gateway configuration using CLI Learn how to use the YAML configuration CLI to convert API Gateway configuration to YAML format. Validate YAML configuration using CLI Learn how to use the YAML configuration CLI to validate a YAML configuration. Import and export YAML configuration using CLI Learn how to use the YAML configuration CLI to import and export YAML configuration. Encrypt YAML configuration using CLI Learn how to use the YAML configuration CLI to encrypt, decrypt, and re-encrypt a YAML configuration. Upgrade YAML configuration using CLI Learn how to use the YAML configuration CLI to upgrade a YAML configuration. Last modified June 4, 2021: 7.7 May 21 Merge developmay21 branch into master (#1922) (4c2c396d) Related Links
Go to Amplify Platform getting started and onboarding roadmap YAML CLI overview YAML CLI tool overview 2 minute read The yamles CLI tool is available in the apigateway/posix/bin directory. It is installed with a standard server-side install or with client tooling, when the Package & Deploy Tools only option is selected during the installation. You can run the yamles script with --help to see all the available options: ./yamles --help The following lists the CLI options and their descriptions: fed2yaml: Convert an XML federated configuration to a YAML configuration. frag2yaml: Convert an XML configuration fragment to a YAML configuration fragment. validate: Validate a YAML configuration. export: Export part of a YAML configuration to create another YAML configuration. import: Import a YAML configuration or a YAML configuration fragment into another YAML configuration. encrypt: Encrypt an unencrypted YAML configuration, a string, or a file. For more information. change-passphrase: Change the passphrase of a YAML configuration. upgrade: Upgrade a YAML configuration. To get help with a specific option, run: ./yamles <option> --help All script parameters have shorthand parameter names. Check the relevant help for more information. All script options generate a trace file in the current directory by default. You can use --tracedir to write trace to another directory, or --tracelevel to change the level of tracing. The yamles script returns the following exit codes: 0 for success 2 for invalid parameters 1 for all other failures Note For Windows systems, the CLI tool is located in the apigateway\Win32\bin directory. You must replace all ./yamles ... with yamles.bat .... Also, all options with URLs must be set as follows: FED: --source federated:file:/C:\Users\...\configs.xml or --source federated:file:/C:/Users/.../configs.xml YAML: --source yaml:file:/C:\Users\... or --source yaml:file:/C:/Users/... Convert API Gateway configuration using CLI Learn how to use the YAML configuration CLI to convert API Gateway configuration to YAML format. Validate YAML configuration using CLI Learn how to use the YAML configuration CLI to validate a YAML configuration. Import and export YAML configuration using CLI Learn how to use the YAML configuration CLI to import and export YAML configuration. Encrypt YAML configuration using CLI Learn how to use the YAML configuration CLI to encrypt, decrypt, and re-encrypt a YAML configuration. Upgrade YAML configuration using CLI Learn how to use the YAML configuration CLI to upgrade a YAML configuration. Last modified June 4, 2021: 7.7 May 21 Merge developmay21 branch into master (#1922) (4c2c396d)