apic gateway-extensions:create extension_zip_file --scope org --org admin --gateway-service gateway_service --availability-zone availability-zone --server mgmt_endpoint_url
where:
- extension_zip_file is the Gateway extension .zip file
that you want to upload.
- gateway_service is the name of the Gateway service that you want add the
extension to.
- availability-zone is the name of the availability zone that contains the
Gateway service.
- mgmt_endpoint_url is the platform API endpoint URL.
For
example:
apic gateway-extensions:create myextension.zip --scope org --org admin --gateway-service mygatewayservice --availability-zone availability-zone-default --server platform-api.myserver.com
This
example uses the default supplied availability zone name of
availability-zone-default
, which will be the required value if you have not
configured your own availability zones. To check the names of the currently configured availability
zones, use the following
command:
apic availability-zones:list --org admin --server mgmt_endpoint_url
For
details on configuring availability zones, see
Creating an Availability Zone.
To check the
names of the currently configured gateway services, use the following
command:
apic gateway-services:list --org admin --availability-zone availability-zone --server mgmt_endpoint_url
You
can confirm that the extension has been added to the Gateway service by using the
gateway-extensions:get
command; for
example:
apic gateway-extensions:get --scope org --org admin --gateway-service mygatewayservice --availability-zone amyavailabilityzone --server platform-api.myserver.com --output -
(the
parameter setting
--output -
writes the details of the Gateway extension object to
the command window. You can specify the name of an existing folder to have the details written to a
.yaml
file in that folder.)
For reference details of the apic
gateway-extensions
commands, see apic
gateway-extensions.
Note: You cannot upload more than one Gateway extension
.zip file to the same Gateway service. If you want add further extensions
later, update the original
.zip file, then use the
apic
gateway-extensions:update
command to replace the previous gateway extensions file with the
revised one; for
example:
apic gateway-extensions:update mynewextension.zip --scope org --org admin --gateway-service mygatewayservice --availability-zone myavailabilityzone --server platform-api.myserver.com