diff --git a/.github/workflows/validate_docs.yaml b/.github/workflows/validate_docs.yaml index 776c8ec..ad09837 100644 --- a/.github/workflows/validate_docs.yaml +++ b/.github/workflows/validate_docs.yaml @@ -2,7 +2,7 @@ on: pull_request: permissions: - contents: read + contents: write pull-requests: write jobs: @@ -10,10 +10,27 @@ jobs: name: Validate CLI Docs runs-on: ubuntu-latest steps: + - name: Determine if PR is from Renovate + id: author_check + run: | + is_renovate=${{github.actor == 'ctreatma' && startsWith(github.head_ref, 'auto')}} + echo "is_renovate=$is_renovate" | tee $GITHUB_OUTPUT + + + - name: Debug step outputs + run: echo "${{ toJSON(steps.author_check) }}" + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + if: steps.author_check.outputs.is_renovate != 'true' with: fetch-depth: 1 + # If this is a Renovate PR, check out the PR head ref so we can commit and push + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 + if: steps.author_check.outputs.is_renovate == 'true' + with: + ref: ${{ github.event.pull_request.head.ref }} + - name: Set up Go uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c # v6.1.0 with: @@ -26,8 +43,26 @@ jobs: id: validate_docs run: make docs-check + # Push docs changes to Renovate PRs since Renovate + # can't respond to comments + - if: | + always() && + steps.author_check.outputs.is_renovate == 'true' && + steps.validate_docs.outcome == 'failure' + run: | + git config --global user.name 'equinix-labs@auto-commit-workflow' + git config --global user.email 'bot@equinix.noreply.github.com' + git add docs + git commit -m "chore(docs): automated commit of updated documentation" || echo "No changes to commit" + git push + + # Post a sticky comment on non-Renovate PRs to direct + # contributors to update docs when needed - uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 - if: always() && (steps.validate_docs.outcome == 'failure') + if: | + always() && + steps.author_check.outputs.is_renovate == 'false' && + (steps.validate_docs.outcome == 'failure') with: header: pr-docs-error message: | diff --git a/.github/workflows/validate_pr_title.yaml b/.github/workflows/validate_pr_title.yaml index b8053c8..f9ef029 100644 --- a/.github/workflows/validate_pr_title.yaml +++ b/.github/workflows/validate_pr_title.yaml @@ -5,7 +5,6 @@ on: types: - opened - edited - - synchronize permissions: pull-requests: write diff --git a/docs/equinix_fabricv4.md b/docs/equinix_fabricv4.md index 6bae8aa..6b68468 100644 --- a/docs/equinix_fabricv4.md +++ b/docs/equinix_fabricv4.md @@ -26,10 +26,16 @@ providing access to all available API services. ### SEE ALSO * [equinix](equinix.md) - Equinix CLI +* [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources +* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources * [equinix fabricv4 cloud-events](equinix_fabricv4_cloud-events.md) - Manage cloud-events resources * [equinix fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources * [equinix fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources * [equinix fabricv4 health](equinix_fabricv4_health.md) - Manage health resources +* [equinix fabricv4 internet-access-services](equinix_fabricv4_internet-access-services.md) - Manage internet-access-services resources +* [equinix fabricv4 ip-blocks](equinix_fabricv4_ip-blocks.md) - Manage ip-blocks resources +* [equinix fabricv4 logos](equinix_fabricv4_logos.md) - Manage logos resources * [equinix fabricv4 marketplace-subscriptions](equinix_fabricv4_marketplace-subscriptions.md) - Manage marketplace-subscriptions resources * [equinix fabricv4 metrics](equinix_fabricv4_metrics.md) - Manage metrics resources * [equinix fabricv4 metros](equinix_fabricv4_metros.md) - Manage metros resources @@ -49,4 +55,5 @@ providing access to all available API services. * [equinix fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources * [equinix fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources * [equinix fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources +* [equinix fabricv4 tags](equinix_fabricv4_tags.md) - Manage tags resources diff --git a/docs/equinix_fabricv4_agent-templates.md b/docs/equinix_fabricv4_agent-templates.md new file mode 100644 index 0000000..e5124f0 --- /dev/null +++ b/docs/equinix_fabricv4_agent-templates.md @@ -0,0 +1,28 @@ +## equinix fabricv4 agent-templates + +Manage agent-templates resources + +### Synopsis + +Commands for managing agent-templates resources in the API + +### Options + +``` + -h, --help help for agent-templates +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 agent-templates get-agent-template-by-uuid](equinix_fabricv4_agent-templates_get-agent-template-by-uuid.md) - Execute get-agent-template-by-uuid operation +* [equinix fabricv4 agent-templates get-agent-templates](equinix_fabricv4_agent-templates_get-agent-templates.md) - Execute get-agent-templates operation + diff --git a/docs/equinix_fabricv4_agent-templates_get-agent-template-by-uuid.md b/docs/equinix_fabricv4_agent-templates_get-agent-template-by-uuid.md new file mode 100644 index 0000000..5f99d23 --- /dev/null +++ b/docs/equinix_fabricv4_agent-templates_get-agent-template-by-uuid.md @@ -0,0 +1,39 @@ +## equinix fabricv4 agent-templates get-agent-template-by-uuid + +Execute get-agent-template-by-uuid operation + +### Synopsis + +Execute the get-agent-template-by-uuid operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agent-templates get-agent-template-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-agent-template-by-uuid + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --uuid string uuid (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources + diff --git a/docs/equinix_fabricv4_agent-templates_get-agent-templates.md b/docs/equinix_fabricv4_agent-templates_get-agent-templates.md new file mode 100644 index 0000000..407d27a --- /dev/null +++ b/docs/equinix_fabricv4_agent-templates_get-agent-templates.md @@ -0,0 +1,38 @@ +## equinix fabricv4 agent-templates get-agent-templates + +Execute get-agent-templates operation + +### Synopsis + +Execute the get-agent-templates operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agent-templates get-agent-templates [flags] +``` + +### Options + +``` + -h, --help help for get-agent-templates + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources + diff --git a/docs/equinix_fabricv4_agents.md b/docs/equinix_fabricv4_agents.md new file mode 100644 index 0000000..51d4d5e --- /dev/null +++ b/docs/equinix_fabricv4_agents.md @@ -0,0 +1,32 @@ +## equinix fabricv4 agents + +Manage agents resources + +### Synopsis + +Commands for managing agents resources in the API + +### Options + +``` + -h, --help help for agents +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 agents create-agent](equinix_fabricv4_agents_create-agent.md) - Execute create-agent operation +* [equinix fabricv4 agents delete-agent-by-uuid](equinix_fabricv4_agents_delete-agent-by-uuid.md) - Execute delete-agent-by-uuid operation +* [equinix fabricv4 agents get-agent-activities](equinix_fabricv4_agents_get-agent-activities.md) - Execute get-agent-activities operation +* [equinix fabricv4 agents get-agent-by-uuid](equinix_fabricv4_agents_get-agent-by-uuid.md) - Execute get-agent-by-uuid operation +* [equinix fabricv4 agents get-agents](equinix_fabricv4_agents_get-agents.md) - Execute get-agents operation +* [equinix fabricv4 agents patch-agent-by-uuid](equinix_fabricv4_agents_patch-agent-by-uuid.md) - Execute patch-agent-by-uuid operation + diff --git a/docs/equinix_fabricv4_agents_create-agent.md b/docs/equinix_fabricv4_agents_create-agent.md new file mode 100644 index 0000000..d663800 --- /dev/null +++ b/docs/equinix_fabricv4_agents_create-agent.md @@ -0,0 +1,47 @@ +## equinix fabricv4 agents create-agent + +Execute create-agent operation + +### Synopsis + +Execute the create-agent operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agents create-agent [flags] +``` + +### Options + +``` + --agent-post-request-additional-properties string agent-post-request-additional-properties (JSON) + --agent-post-request-agent-template-additional-properties string agent-post-request-agent-template-additional-properties (JSON) + --agent-post-request-agent-template-uuid string agent-post-request-agent-template-uuid + --agent-post-request-configuration-additional-properties string agent-post-request-configuration-additional-properties (JSON) + --agent-post-request-configuration-prompt string agent-post-request-configuration-prompt + --agent-post-request-description string agent-post-request-description + --agent-post-request-enabled agent-post-request-enabled + --agent-post-request-name string agent-post-request-name + --agent-post-request-project-additional-properties string agent-post-request-project-additional-properties (JSON) + --agent-post-request-project-project-id string Subscriber-assigned project ID + --agent-post-request-type string agent-post-request-type + -h, --help help for create-agent + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources + diff --git a/docs/equinix_fabricv4_agents_delete-agent-by-uuid.md b/docs/equinix_fabricv4_agents_delete-agent-by-uuid.md new file mode 100644 index 0000000..157ba04 --- /dev/null +++ b/docs/equinix_fabricv4_agents_delete-agent-by-uuid.md @@ -0,0 +1,39 @@ +## equinix fabricv4 agents delete-agent-by-uuid + +Execute delete-agent-by-uuid operation + +### Synopsis + +Execute the delete-agent-by-uuid operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agents delete-agent-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-agent-by-uuid + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --uuid string uuid (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources + diff --git a/docs/equinix_fabricv4_agents_get-agent-activities.md b/docs/equinix_fabricv4_agents_get-agent-activities.md new file mode 100644 index 0000000..c43b094 --- /dev/null +++ b/docs/equinix_fabricv4_agents_get-agent-activities.md @@ -0,0 +1,39 @@ +## equinix fabricv4 agents get-agent-activities + +Execute get-agent-activities operation + +### Synopsis + +Execute the get-agent-activities operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agents get-agent-activities [flags] +``` + +### Options + +``` + -h, --help help for get-agent-activities + --limit int limit field + --offset int offset field + --param-1 string param-1 (required) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources + diff --git a/docs/equinix_fabricv4_agents_get-agent-by-uuid.md b/docs/equinix_fabricv4_agents_get-agent-by-uuid.md new file mode 100644 index 0000000..2fa89dd --- /dev/null +++ b/docs/equinix_fabricv4_agents_get-agent-by-uuid.md @@ -0,0 +1,39 @@ +## equinix fabricv4 agents get-agent-by-uuid + +Execute get-agent-by-uuid operation + +### Synopsis + +Execute the get-agent-by-uuid operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agents get-agent-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-agent-by-uuid + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --uuid string uuid (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources + diff --git a/docs/equinix_fabricv4_agents_get-agents.md b/docs/equinix_fabricv4_agents_get-agents.md new file mode 100644 index 0000000..cc1760d --- /dev/null +++ b/docs/equinix_fabricv4_agents_get-agents.md @@ -0,0 +1,38 @@ +## equinix fabricv4 agents get-agents + +Execute get-agents operation + +### Synopsis + +Execute the get-agents operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agents get-agents [flags] +``` + +### Options + +``` + -h, --help help for get-agents + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources + diff --git a/docs/equinix_fabricv4_agents_patch-agent-by-uuid.md b/docs/equinix_fabricv4_agents_patch-agent-by-uuid.md new file mode 100644 index 0000000..0d4dedb --- /dev/null +++ b/docs/equinix_fabricv4_agents_patch-agent-by-uuid.md @@ -0,0 +1,41 @@ +## equinix fabricv4 agents patch-agent-by-uuid + +Execute patch-agent-by-uuid operation + +### Synopsis + +Execute the patch-agent-by-uuid operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 agents patch-agent-by-uuid [flags] +``` + +### Options + +``` + --agent-patch-request-additional-properties string agent-patch-request-additional-properties (JSON) + --agent-patch-request-op string agent-patch-request-op + --agent-patch-request-path string agent-patch-request-path + --agent-patch-request-value string agent-patch-request-value (JSON) + -h, --help help for patch-agent-by-uuid + --request string JSON payload for additional optional fields not exposed as flags + --uuid string uuid (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources + diff --git a/docs/equinix_fabricv4_cloud-routers.md b/docs/equinix_fabricv4_cloud-routers.md index 774c4eb..d8b348a 100644 --- a/docs/equinix_fabricv4_cloud-routers.md +++ b/docs/equinix_fabricv4_cloud-routers.md @@ -35,8 +35,6 @@ Commands for managing cloud-routers resources in the API * [equinix fabricv4 cloud-routers get-cloud-router-command](equinix_fabricv4_cloud-routers_get-cloud-router-command.md) - Get Command * [equinix fabricv4 cloud-routers get-cloud-router-package-by-code](equinix_fabricv4_cloud-routers_get-cloud-router-package-by-code.md) - Get Package Details * [equinix fabricv4 cloud-routers get-cloud-router-packages](equinix_fabricv4_cloud-routers_get-cloud-router-packages.md) - List Packages -* [equinix fabricv4 cloud-routers get-gateway-attachment-to-cloud-router-by-uuid](equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md) - Get Gateway Attachment details to a Cloud Router -* [equinix fabricv4 cloud-routers list-gateway-attachments-to-cloud-router](equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md) - List Cloud Routers of a Gateway Attachment. * [equinix fabricv4 cloud-routers search-cloud-router-commands](equinix_fabricv4_cloud-routers_search-cloud-router-commands.md) - Search Commands * [equinix fabricv4 cloud-routers search-cloud-router-routes](equinix_fabricv4_cloud-routers_search-cloud-router-routes.md) - Search Route Table * [equinix fabricv4 cloud-routers search-cloud-routers](equinix_fabricv4_cloud-routers_search-cloud-routers.md) - Search Routers diff --git a/docs/equinix_fabricv4_cloud-routers_create-cloud-router.md b/docs/equinix_fabricv4_cloud-routers_create-cloud-router.md index 9af1f67..652cab6 100644 --- a/docs/equinix_fabricv4_cloud-routers_create-cloud-router.md +++ b/docs/equinix_fabricv4_cloud-routers_create-cloud-router.md @@ -42,6 +42,7 @@ equinix fabricv4 cloud-routers create-cloud-router [flags] --cloud-router-post-request-notifications string Preferences for notifications on connection configuration or status changes (JSON array) --cloud-router-post-request-order-additional-properties string cloud-router-post-request-order-additional-properties (JSON) --cloud-router-post-request-order-billing-tier string Billing tier for connection bandwidth + --cloud-router-post-request-order-contracted-bandwidth int cloud-router-post-request-order-contracted-bandwidth --cloud-router-post-request-order-customer-reference-number string Customer reference number --cloud-router-post-request-order-order-id string Order Identification --cloud-router-post-request-order-order-number string Order Reference Number diff --git a/docs/equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md b/docs/equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md deleted file mode 100644 index fcb804e..0000000 --- a/docs/equinix_fabricv4_cloud-routers_get-gateway-attachment-to-cloud-router-by-uuid.md +++ /dev/null @@ -1,35 +0,0 @@ -## equinix fabricv4 cloud-routers get-gateway-attachment-to-cloud-router-by-uuid - -Get Gateway Attachment details to a Cloud Router - -### Synopsis - -Get details of a Specific Gateway Attachment to a Cloud Router. - -Use --request flag to provide optional JSON payload fields. - -``` -equinix fabricv4 cloud-routers get-gateway-attachment-to-cloud-router-by-uuid [flags] -``` - -### Options - -``` - --gateway-id string Gateway UUID (required) - -h, --help help for get-gateway-attachment-to-cloud-router-by-uuid - --request string JSON payload for request body fields - --router-id string Cloud Router UUID (required) -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources - diff --git a/docs/equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md b/docs/equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md deleted file mode 100644 index 3222bd7..0000000 --- a/docs/equinix_fabricv4_cloud-routers_list-gateway-attachments-to-cloud-router.md +++ /dev/null @@ -1,36 +0,0 @@ -## equinix fabricv4 cloud-routers list-gateway-attachments-to-cloud-router - -List Cloud Routers of a Gateway Attachment. - -### Synopsis - -Get all Cloud Routers attached on a Gateway. - -Use --request flag to provide optional JSON payload fields. - -``` -equinix fabricv4 cloud-routers list-gateway-attachments-to-cloud-router [flags] -``` - -### Options - -``` - --gateway-id string Gateway UUID (required) - -h, --help help for list-gateway-attachments-to-cloud-router - --limit int limit field - --offset int offset field - --request string JSON payload for additional optional fields not exposed as flags -``` - -### Options inherited from parent commands - -``` - --config string config file (default is $HOME/.config/equinix/equinix.yaml) - --debug Enable debug logging for HTTP requests - -f, --format string Format to use for output (json or yaml) (default "json") -``` - -### SEE ALSO - -* [equinix fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources - diff --git a/docs/equinix_fabricv4_company-profiles.md b/docs/equinix_fabricv4_company-profiles.md new file mode 100644 index 0000000..36f71e4 --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles.md @@ -0,0 +1,39 @@ +## equinix fabricv4 company-profiles + +Manage company-profiles resources + +### Synopsis + +Commands for managing company-profiles resources in the API + +### Options + +``` + -h, --help help for company-profiles +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 company-profiles attach-private-service-to-profile](equinix_fabricv4_company-profiles_attach-private-service-to-profile.md) - Execute attach-private-service-to-profile operation +* [equinix fabricv4 company-profiles attach-service-profile-to-profile](equinix_fabricv4_company-profiles_attach-service-profile-to-profile.md) - Execute attach-service-profile-to-profile operation +* [equinix fabricv4 company-profiles attach-tag-to-profile](equinix_fabricv4_company-profiles_attach-tag-to-profile.md) - Execute attach-tag-to-profile operation +* [equinix fabricv4 company-profiles create-company-profile](equinix_fabricv4_company-profiles_create-company-profile.md) - Execute create-company-profile operation +* [equinix fabricv4 company-profiles delete-company-profile](equinix_fabricv4_company-profiles_delete-company-profile.md) - Execute delete-company-profile operation +* [equinix fabricv4 company-profiles detach-private-service-from-profile](equinix_fabricv4_company-profiles_detach-private-service-from-profile.md) - Execute detach-private-service-from-profile operation +* [equinix fabricv4 company-profiles detach-service-profile-from-profile](equinix_fabricv4_company-profiles_detach-service-profile-from-profile.md) - Execute detach-service-profile-from-profile operation +* [equinix fabricv4 company-profiles detach-tag-from-profile](equinix_fabricv4_company-profiles_detach-tag-from-profile.md) - Execute detach-tag-from-profile operation +* [equinix fabricv4 company-profiles get-company-profile](equinix_fabricv4_company-profiles_get-company-profile.md) - Execute get-company-profile operation +* [equinix fabricv4 company-profiles get-company-profile-private-services](equinix_fabricv4_company-profiles_get-company-profile-private-services.md) - Execute get-company-profile-private-services operation +* [equinix fabricv4 company-profiles get-company-profile-service-profiles](equinix_fabricv4_company-profiles_get-company-profile-service-profiles.md) - Execute get-company-profile-service-profiles operation +* [equinix fabricv4 company-profiles get-tags](equinix_fabricv4_company-profiles_get-tags.md) - Execute get-tags operation +* [equinix fabricv4 company-profiles search-company-profile](equinix_fabricv4_company-profiles_search-company-profile.md) - Execute search-company-profile operation + diff --git a/docs/equinix_fabricv4_company-profiles_attach-private-service-to-profile.md b/docs/equinix_fabricv4_company-profiles_attach-private-service-to-profile.md new file mode 100644 index 0000000..3f9f42c --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_attach-private-service-to-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles attach-private-service-to-profile + +Execute attach-private-service-to-profile operation + +### Synopsis + +Execute the attach-private-service-to-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles attach-private-service-to-profile [flags] +``` + +### Options + +``` + -h, --help help for attach-private-service-to-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_attach-service-profile-to-profile.md b/docs/equinix_fabricv4_company-profiles_attach-service-profile-to-profile.md new file mode 100644 index 0000000..3ed50e1 --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_attach-service-profile-to-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles attach-service-profile-to-profile + +Execute attach-service-profile-to-profile operation + +### Synopsis + +Execute the attach-service-profile-to-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles attach-service-profile-to-profile [flags] +``` + +### Options + +``` + -h, --help help for attach-service-profile-to-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_attach-tag-to-profile.md b/docs/equinix_fabricv4_company-profiles_attach-tag-to-profile.md new file mode 100644 index 0000000..48a34f4 --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_attach-tag-to-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles attach-tag-to-profile + +Execute attach-tag-to-profile operation + +### Synopsis + +Execute the attach-tag-to-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles attach-tag-to-profile [flags] +``` + +### Options + +``` + -h, --help help for attach-tag-to-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_create-company-profile.md b/docs/equinix_fabricv4_company-profiles_create-company-profile.md new file mode 100644 index 0000000..e9c037b --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_create-company-profile.md @@ -0,0 +1,44 @@ +## equinix fabricv4 company-profiles create-company-profile + +Execute create-company-profile operation + +### Synopsis + +Execute the create-company-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles create-company-profile [flags] +``` + +### Options + +``` + --company-profile-request-additional-properties string company-profile-request-additional-properties (JSON) + --company-profile-request-contact-url string company-profile-request-contact-url + --company-profile-request-description string company-profile-request-description + --company-profile-request-name string company-profile-request-name + --company-profile-request-notifications string company-profile-request-notifications (JSON array) + --company-profile-request-summary string company-profile-request-summary + --company-profile-request-type string company-profile-request-type + --company-profile-request-web-url string company-profile-request-web-url + -h, --help help for create-company-profile + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_delete-company-profile.md b/docs/equinix_fabricv4_company-profiles_delete-company-profile.md new file mode 100644 index 0000000..308c85c --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_delete-company-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles delete-company-profile + +Execute delete-company-profile operation + +### Synopsis + +Execute the delete-company-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles delete-company-profile [flags] +``` + +### Options + +``` + -h, --help help for delete-company-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_detach-private-service-from-profile.md b/docs/equinix_fabricv4_company-profiles_detach-private-service-from-profile.md new file mode 100644 index 0000000..1935695 --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_detach-private-service-from-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles detach-private-service-from-profile + +Execute detach-private-service-from-profile operation + +### Synopsis + +Execute the detach-private-service-from-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles detach-private-service-from-profile [flags] +``` + +### Options + +``` + -h, --help help for detach-private-service-from-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_detach-service-profile-from-profile.md b/docs/equinix_fabricv4_company-profiles_detach-service-profile-from-profile.md new file mode 100644 index 0000000..fced41b --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_detach-service-profile-from-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles detach-service-profile-from-profile + +Execute detach-service-profile-from-profile operation + +### Synopsis + +Execute the detach-service-profile-from-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles detach-service-profile-from-profile [flags] +``` + +### Options + +``` + -h, --help help for detach-service-profile-from-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_detach-tag-from-profile.md b/docs/equinix_fabricv4_company-profiles_detach-tag-from-profile.md new file mode 100644 index 0000000..651092b --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_detach-tag-from-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles detach-tag-from-profile + +Execute detach-tag-from-profile operation + +### Synopsis + +Execute the detach-tag-from-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles detach-tag-from-profile [flags] +``` + +### Options + +``` + -h, --help help for detach-tag-from-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_get-company-profile-private-services.md b/docs/equinix_fabricv4_company-profiles_get-company-profile-private-services.md new file mode 100644 index 0000000..36483b6 --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_get-company-profile-private-services.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles get-company-profile-private-services + +Execute get-company-profile-private-services operation + +### Synopsis + +Execute the get-company-profile-private-services operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles get-company-profile-private-services [flags] +``` + +### Options + +``` + -h, --help help for get-company-profile-private-services + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_get-company-profile-service-profiles.md b/docs/equinix_fabricv4_company-profiles_get-company-profile-service-profiles.md new file mode 100644 index 0000000..0088296 --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_get-company-profile-service-profiles.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles get-company-profile-service-profiles + +Execute get-company-profile-service-profiles operation + +### Synopsis + +Execute the get-company-profile-service-profiles operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles get-company-profile-service-profiles [flags] +``` + +### Options + +``` + -h, --help help for get-company-profile-service-profiles + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_get-company-profile.md b/docs/equinix_fabricv4_company-profiles_get-company-profile.md new file mode 100644 index 0000000..01d390b --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_get-company-profile.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles get-company-profile + +Execute get-company-profile operation + +### Synopsis + +Execute the get-company-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles get-company-profile [flags] +``` + +### Options + +``` + -h, --help help for get-company-profile + --profile-id string profile-id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_get-tags.md b/docs/equinix_fabricv4_company-profiles_get-tags.md new file mode 100644 index 0000000..364b69f --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_get-tags.md @@ -0,0 +1,37 @@ +## equinix fabricv4 company-profiles get-tags + +Execute get-tags operation + +### Synopsis + +Execute the get-tags operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles get-tags [flags] +``` + +### Options + +``` + -h, --help help for get-tags + --param-1 string param-1 (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_company-profiles_search-company-profile.md b/docs/equinix_fabricv4_company-profiles_search-company-profile.md new file mode 100644 index 0000000..429324a --- /dev/null +++ b/docs/equinix_fabricv4_company-profiles_search-company-profile.md @@ -0,0 +1,53 @@ +## equinix fabricv4 company-profiles search-company-profile + +Execute search-company-profile operation + +### Synopsis + +Execute the search-company-profile operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 company-profiles search-company-profile [flags] +``` + +### Options + +``` + --company-profile-search-request-additional-properties string company-profile-search-request-additional-properties (JSON) + --company-profile-search-request-filter-additional-properties string company-profile-search-request-filter-additional-properties (JSON) + --company-profile-search-request-filter-and string company-profile-search-request-filter-and (JSON array) + --company-profile-search-request-filter-operator string company-profile-search-request-filter-operator + --company-profile-search-request-filter-or string company-profile-search-request-filter-or (JSON array) + --company-profile-search-request-filter-property string company-profile-search-request-filter-property + --company-profile-search-request-filter-values string company-profile-search-request-filter-values (JSON array) + --company-profile-search-request-pagination-additional-properties string company-profile-search-request-pagination-additional-properties (JSON) + --company-profile-search-request-pagination-limit int Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. + --company-profile-search-request-pagination-next string URL relative to the next item in the response. + --company-profile-search-request-pagination-offset int Index of the first item returned in the response. The default is 0. + --company-profile-search-request-pagination-previous string URL relative to the previous item in the response. + --company-profile-search-request-pagination-total int Total number of elements returned. + --company-profile-search-request-sort-additional-properties string company-profile-search-request-sort-additional-properties (JSON) + --company-profile-search-request-sort-direction string company-profile-search-request-sort-direction + --company-profile-search-request-sort-property string company-profile-search-request-sort-property + -h, --help help for search-company-profile + --request string JSON payload for additional optional fields not exposed as flags + --view-point string view-point field +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources + diff --git a/docs/equinix_fabricv4_connections_create-connection.md b/docs/equinix_fabricv4_connections_create-connection.md index 4b1241e..13ea70b 100644 --- a/docs/equinix_fabricv4_connections_create-connection.md +++ b/docs/equinix_fabricv4_connections_create-connection.md @@ -18,9 +18,6 @@ equinix fabricv4 connections create-connection [flags] --connection-post-request-a-side-access-point string connection-post-request-a-side-access-point (JSON) --connection-post-request-a-side-additional-info string Any additional information, which is not part of connection metadata or configuration (JSON array) --connection-post-request-a-side-additional-properties string connection-post-request-a-side-additional-properties (JSON) - --connection-post-request-a-side-company-profile string connection-post-request-a-side-company-profile (JSON) - --connection-post-request-a-side-internet-access string connection-post-request-a-side-internet-access (JSON) - --connection-post-request-a-side-invitation string connection-post-request-a-side-invitation (JSON) --connection-post-request-a-side-service-token string connection-post-request-a-side-service-token (JSON) --connection-post-request-additional-info string Connection additional information (JSON array) --connection-post-request-additional-properties string connection-post-request-additional-properties (JSON) @@ -38,6 +35,7 @@ equinix fabricv4 connections create-connection [flags] --connection-post-request-notifications string Preferences for notifications on connection configuration or status changes (JSON array) --connection-post-request-order-additional-properties string connection-post-request-order-additional-properties (JSON) --connection-post-request-order-billing-tier string Billing tier for connection bandwidth + --connection-post-request-order-contracted-bandwidth int connection-post-request-order-contracted-bandwidth --connection-post-request-order-customer-reference-number string Customer reference number --connection-post-request-order-order-id string Order Identification --connection-post-request-order-order-number string Order Reference Number @@ -52,9 +50,6 @@ equinix fabricv4 connections create-connection [flags] --connection-post-request-z-side-access-point string connection-post-request-z-side-access-point (JSON) --connection-post-request-z-side-additional-info string Any additional information, which is not part of connection metadata or configuration (JSON array) --connection-post-request-z-side-additional-properties string connection-post-request-z-side-additional-properties (JSON) - --connection-post-request-z-side-company-profile string connection-post-request-z-side-company-profile (JSON) - --connection-post-request-z-side-internet-access string connection-post-request-z-side-internet-access (JSON) - --connection-post-request-z-side-invitation string connection-post-request-z-side-invitation (JSON) --connection-post-request-z-side-service-token string connection-post-request-z-side-service-token (JSON) --dry-run dry-run field -h, --help help for create-connection diff --git a/docs/equinix_fabricv4_internet-access-services.md b/docs/equinix_fabricv4_internet-access-services.md new file mode 100644 index 0000000..2e0c44c --- /dev/null +++ b/docs/equinix_fabricv4_internet-access-services.md @@ -0,0 +1,31 @@ +## equinix fabricv4 internet-access-services + +Manage internet-access-services resources + +### Synopsis + +Commands for managing internet-access-services resources in the API + +### Options + +``` + -h, --help help for internet-access-services +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 internet-access-services create-eia-service](equinix_fabricv4_internet-access-services_create-eia-service.md) - Execute create-eia-service operation +* [equinix fabricv4 internet-access-services delete-eia-service](equinix_fabricv4_internet-access-services_delete-eia-service.md) - Execute delete-eia-service operation +* [equinix fabricv4 internet-access-services get-eia-service](equinix_fabricv4_internet-access-services_get-eia-service.md) - Execute get-eia-service operation +* [equinix fabricv4 internet-access-services patch-eia-service](equinix_fabricv4_internet-access-services_patch-eia-service.md) - Execute patch-eia-service operation +* [equinix fabricv4 internet-access-services search-eia-services](equinix_fabricv4_internet-access-services_search-eia-services.md) - Execute search-eia-services operation + diff --git a/docs/equinix_fabricv4_internet-access-services_create-eia-service.md b/docs/equinix_fabricv4_internet-access-services_create-eia-service.md new file mode 100644 index 0000000..aa7b6d2 --- /dev/null +++ b/docs/equinix_fabricv4_internet-access-services_create-eia-service.md @@ -0,0 +1,55 @@ +## equinix fabricv4 internet-access-services create-eia-service + +Execute create-eia-service operation + +### Synopsis + +Execute the create-eia-service operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 internet-access-services create-eia-service [flags] +``` + +### Options + +``` + -h, --help help for create-eia-service + --internet-access-post-request-account-account-number string internet-access-post-request-account-account-number + --internet-access-post-request-account-additional-properties string internet-access-post-request-account-additional-properties (JSON) + --internet-access-post-request-account-href string internet-access-post-request-account-href + --internet-access-post-request-additional-properties string internet-access-post-request-additional-properties (JSON) + --internet-access-post-request-bandwidth int internet-access-post-request-bandwidth + --internet-access-post-request-bandwidth-commit int internet-access-post-request-bandwidth-commit + --internet-access-post-request-billing-additional-properties string internet-access-post-request-billing-additional-properties (JSON) + --internet-access-post-request-billing-type string internet-access-post-request-billing-type + --internet-access-post-request-name string internet-access-post-request-name + --internet-access-post-request-order-additional-properties string internet-access-post-request-order-additional-properties (JSON) + --internet-access-post-request-order-order-line string internet-access-post-request-order-order-line (JSON) + --internet-access-post-request-order-order-number string internet-access-post-request-order-order-number (JSON) + --internet-access-post-request-order-purchase-order-number string internet-access-post-request-order-purchase-order-number (JSON) + --internet-access-post-request-project-additional-properties string internet-access-post-request-project-additional-properties (JSON) + --internet-access-post-request-project-project-id string Subscriber-assigned project ID + --internet-access-post-request-routing-protocol-additional-properties string internet-access-post-request-routing-protocol-additional-properties (JSON) + --internet-access-post-request-routing-protocol-customer-routes string internet-access-post-request-routing-protocol-customer-routes (JSON array) + --internet-access-post-request-routing-protocol-type string internet-access-post-request-routing-protocol-type + --internet-access-post-request-type string internet-access-post-request-type + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 internet-access-services](equinix_fabricv4_internet-access-services.md) - Manage internet-access-services resources + diff --git a/docs/equinix_fabricv4_internet-access-services_delete-eia-service.md b/docs/equinix_fabricv4_internet-access-services_delete-eia-service.md new file mode 100644 index 0000000..afe2dd2 --- /dev/null +++ b/docs/equinix_fabricv4_internet-access-services_delete-eia-service.md @@ -0,0 +1,37 @@ +## equinix fabricv4 internet-access-services delete-eia-service + +Execute delete-eia-service operation + +### Synopsis + +Execute the delete-eia-service operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 internet-access-services delete-eia-service [flags] +``` + +### Options + +``` + -h, --help help for delete-eia-service + --param-1 string param-1 (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 internet-access-services](equinix_fabricv4_internet-access-services.md) - Manage internet-access-services resources + diff --git a/docs/equinix_fabricv4_internet-access-services_get-eia-service.md b/docs/equinix_fabricv4_internet-access-services_get-eia-service.md new file mode 100644 index 0000000..c6f15f0 --- /dev/null +++ b/docs/equinix_fabricv4_internet-access-services_get-eia-service.md @@ -0,0 +1,37 @@ +## equinix fabricv4 internet-access-services get-eia-service + +Execute get-eia-service operation + +### Synopsis + +Execute the get-eia-service operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 internet-access-services get-eia-service [flags] +``` + +### Options + +``` + -h, --help help for get-eia-service + --param-1 string param-1 (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 internet-access-services](equinix_fabricv4_internet-access-services.md) - Manage internet-access-services resources + diff --git a/docs/equinix_fabricv4_internet-access-services_patch-eia-service.md b/docs/equinix_fabricv4_internet-access-services_patch-eia-service.md new file mode 100644 index 0000000..58d4024 --- /dev/null +++ b/docs/equinix_fabricv4_internet-access-services_patch-eia-service.md @@ -0,0 +1,38 @@ +## equinix fabricv4 internet-access-services patch-eia-service + +Execute patch-eia-service operation + +### Synopsis + +Execute the patch-eia-service operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 internet-access-services patch-eia-service [flags] +``` + +### Options + +``` + -h, --help help for patch-eia-service + --internet-access-patch-operation-update string internet-access-patch-operation-update field (JSON or string) + --param-1 string param-1 (required) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 internet-access-services](equinix_fabricv4_internet-access-services.md) - Manage internet-access-services resources + diff --git a/docs/equinix_fabricv4_internet-access-services_search-eia-services.md b/docs/equinix_fabricv4_internet-access-services_search-eia-services.md new file mode 100644 index 0000000..a834e86 --- /dev/null +++ b/docs/equinix_fabricv4_internet-access-services_search-eia-services.md @@ -0,0 +1,47 @@ +## equinix fabricv4 internet-access-services search-eia-services + +Execute search-eia-services operation + +### Synopsis + +Execute the search-eia-services operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 internet-access-services search-eia-services [flags] +``` + +### Options + +``` + -h, --help help for search-eia-services + --internet-access-search-request-additional-properties string internet-access-search-request-additional-properties (JSON) + --internet-access-search-request-filter-additional-properties string internet-access-search-request-filter-additional-properties (JSON) + --internet-access-search-request-filter-and string internet-access-search-request-filter-and (JSON array) + --internet-access-search-request-filter-operator string internet-access-search-request-filter-operator + --internet-access-search-request-filter-or string internet-access-search-request-filter-or (JSON array) + --internet-access-search-request-filter-property string internet-access-search-request-filter-property + --internet-access-search-request-filter-values string internet-access-search-request-filter-values (JSON array) + --internet-access-search-request-pagination-additional-properties string internet-access-search-request-pagination-additional-properties (JSON) + --internet-access-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --internet-access-search-request-pagination-offset int Index of the first element. + --internet-access-search-request-sort string internet-access-search-request-sort (JSON array) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 internet-access-services](equinix_fabricv4_internet-access-services.md) - Manage internet-access-services resources + diff --git a/docs/equinix_fabricv4_ip-blocks.md b/docs/equinix_fabricv4_ip-blocks.md new file mode 100644 index 0000000..c7669dc --- /dev/null +++ b/docs/equinix_fabricv4_ip-blocks.md @@ -0,0 +1,31 @@ +## equinix fabricv4 ip-blocks + +Manage ip-blocks resources + +### Synopsis + +Commands for managing ip-blocks resources in the API + +### Options + +``` + -h, --help help for ip-blocks +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 ip-blocks delete-ip-block-by-id](equinix_fabricv4_ip-blocks_delete-ip-block-by-id.md) - Execute delete-ip-block-by-id operation +* [equinix fabricv4 ip-blocks get-ip-block](equinix_fabricv4_ip-blocks_get-ip-block.md) - Execute get-ip-block operation +* [equinix fabricv4 ip-blocks patch-ip-block-by-id](equinix_fabricv4_ip-blocks_patch-ip-block-by-id.md) - Execute patch-ip-block-by-id operation +* [equinix fabricv4 ip-blocks search-ip-blocks](equinix_fabricv4_ip-blocks_search-ip-blocks.md) - Execute search-ip-blocks operation +* [equinix fabricv4 ip-blocks submit-ip-block](equinix_fabricv4_ip-blocks_submit-ip-block.md) - Execute submit-ip-block operation + diff --git a/docs/equinix_fabricv4_ip-blocks_delete-ip-block-by-id.md b/docs/equinix_fabricv4_ip-blocks_delete-ip-block-by-id.md new file mode 100644 index 0000000..a1998de --- /dev/null +++ b/docs/equinix_fabricv4_ip-blocks_delete-ip-block-by-id.md @@ -0,0 +1,37 @@ +## equinix fabricv4 ip-blocks delete-ip-block-by-id + +Execute delete-ip-block-by-id operation + +### Synopsis + +Execute the delete-ip-block-by-id operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 ip-blocks delete-ip-block-by-id [flags] +``` + +### Options + +``` + -h, --help help for delete-ip-block-by-id + --id string id (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 ip-blocks](equinix_fabricv4_ip-blocks.md) - Manage ip-blocks resources + diff --git a/docs/equinix_fabricv4_ip-blocks_get-ip-block.md b/docs/equinix_fabricv4_ip-blocks_get-ip-block.md new file mode 100644 index 0000000..cbd5fb8 --- /dev/null +++ b/docs/equinix_fabricv4_ip-blocks_get-ip-block.md @@ -0,0 +1,37 @@ +## equinix fabricv4 ip-blocks get-ip-block + +Execute get-ip-block operation + +### Synopsis + +Execute the get-ip-block operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 ip-blocks get-ip-block [flags] +``` + +### Options + +``` + -h, --help help for get-ip-block + --param-1 string param-1 (required) + --request string JSON payload for request body fields +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 ip-blocks](equinix_fabricv4_ip-blocks.md) - Manage ip-blocks resources + diff --git a/docs/equinix_fabricv4_ip-blocks_patch-ip-block-by-id.md b/docs/equinix_fabricv4_ip-blocks_patch-ip-block-by-id.md new file mode 100644 index 0000000..f453905 --- /dev/null +++ b/docs/equinix_fabricv4_ip-blocks_patch-ip-block-by-id.md @@ -0,0 +1,38 @@ +## equinix fabricv4 ip-blocks patch-ip-block-by-id + +Execute patch-ip-block-by-id operation + +### Synopsis + +Execute the patch-ip-block-by-id operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 ip-blocks patch-ip-block-by-id [flags] +``` + +### Options + +``` + -h, --help help for patch-ip-block-by-id + --id string id (required) + --patch-ip-block-request-body-item string patch-ip-block-request-body-item field (JSON or string) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 ip-blocks](equinix_fabricv4_ip-blocks.md) - Manage ip-blocks resources + diff --git a/docs/equinix_fabricv4_ip-blocks_search-ip-blocks.md b/docs/equinix_fabricv4_ip-blocks_search-ip-blocks.md new file mode 100644 index 0000000..81a6392 --- /dev/null +++ b/docs/equinix_fabricv4_ip-blocks_search-ip-blocks.md @@ -0,0 +1,43 @@ +## equinix fabricv4 ip-blocks search-ip-blocks + +Execute search-ip-blocks operation + +### Synopsis + +Execute the search-ip-blocks operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 ip-blocks search-ip-blocks [flags] +``` + +### Options + +``` + -h, --help help for search-ip-blocks + --ip-blocks-search-request-body-additional-properties string ip-blocks-search-request-body-additional-properties (JSON) + --ip-blocks-search-request-body-filter-additional-properties string ip-blocks-search-request-body-filter-additional-properties (JSON) + --ip-blocks-search-request-body-filter-and string ip-blocks-search-request-body-filter-and (JSON array) + --ip-blocks-search-request-body-pagination-additional-properties string ip-blocks-search-request-body-pagination-additional-properties (JSON) + --ip-blocks-search-request-body-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --ip-blocks-search-request-body-pagination-offset int Index of the first element. + --ip-blocks-search-request-body-sort string ip-blocks-search-request-body-sort (JSON array) + --request string JSON payload for additional optional fields not exposed as flags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 ip-blocks](equinix_fabricv4_ip-blocks.md) - Manage ip-blocks resources + diff --git a/docs/equinix_fabricv4_ip-blocks_submit-ip-block.md b/docs/equinix_fabricv4_ip-blocks_submit-ip-block.md new file mode 100644 index 0000000..ef6655b --- /dev/null +++ b/docs/equinix_fabricv4_ip-blocks_submit-ip-block.md @@ -0,0 +1,54 @@ +## equinix fabricv4 ip-blocks submit-ip-block + +Execute submit-ip-block operation + +### Synopsis + +Execute the submit-ip-block operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 ip-blocks submit-ip-block [flags] +``` + +### Options + +``` + -h, --help help for submit-ip-block + --request string JSON payload for additional optional fields not exposed as flags + --submit-ip-block-request-body-account-account-number string submit-ip-block-request-body-account-account-number + --submit-ip-block-request-body-account-additional-properties string submit-ip-block-request-body-account-additional-properties (JSON) + --submit-ip-block-request-body-additional-properties string submit-ip-block-request-body-additional-properties (JSON) + --submit-ip-block-request-body-location-additional-properties string submit-ip-block-request-body-location-additional-properties (JSON) + --submit-ip-block-request-body-location-metro-code string submit-ip-block-request-body-location-metro-code + --submit-ip-block-request-body-location-metro-href string submit-ip-block-request-body-location-metro-href + --submit-ip-block-request-body-order-additional-properties string submit-ip-block-request-body-order-additional-properties (JSON) + --submit-ip-block-request-body-order-order-line string submit-ip-block-request-body-order-order-line (JSON) + --submit-ip-block-request-body-order-order-number string submit-ip-block-request-body-order-order-number (JSON) + --submit-ip-block-request-body-order-purchase-order-number string submit-ip-block-request-body-order-purchase-order-number (JSON) + --submit-ip-block-request-body-prefix string submit-ip-block-request-body-prefix + --submit-ip-block-request-body-prefix-length int submit-ip-block-request-body-prefix-length + --submit-ip-block-request-body-project-additional-properties string submit-ip-block-request-body-project-additional-properties (JSON) + --submit-ip-block-request-body-project-project-id string submit-ip-block-request-body-project-project-id + --submit-ip-block-request-body-regulations-additional-properties string submit-ip-block-request-body-regulations-additional-properties (JSON) + --submit-ip-block-request-body-regulations-addressing-plans string submit-ip-block-request-body-regulations-addressing-plans (JSON array) + --submit-ip-block-request-body-regulations-questions string submit-ip-block-request-body-regulations-questions (JSON) + --submit-ip-block-request-body-type string submit-ip-block-request-body-type +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 ip-blocks](equinix_fabricv4_ip-blocks.md) - Manage ip-blocks resources + diff --git a/docs/equinix_fabricv4_logos.md b/docs/equinix_fabricv4_logos.md new file mode 100644 index 0000000..767472d --- /dev/null +++ b/docs/equinix_fabricv4_logos.md @@ -0,0 +1,28 @@ +## equinix fabricv4 logos + +Manage logos resources + +### Synopsis + +Commands for managing logos resources in the API + +### Options + +``` + -h, --help help for logos +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 logos delete-logo-by-uuid](equinix_fabricv4_logos_delete-logo-by-uuid.md) - Execute delete-logo-by-uuid operation +* [equinix fabricv4 logos get-logo-by-uuid](equinix_fabricv4_logos_get-logo-by-uuid.md) - Execute get-logo-by-uuid operation + diff --git a/docs/equinix_fabricv4_logos_delete-logo-by-uuid.md b/docs/equinix_fabricv4_logos_delete-logo-by-uuid.md new file mode 100644 index 0000000..d24b843 --- /dev/null +++ b/docs/equinix_fabricv4_logos_delete-logo-by-uuid.md @@ -0,0 +1,37 @@ +## equinix fabricv4 logos delete-logo-by-uuid + +Execute delete-logo-by-uuid operation + +### Synopsis + +Execute the delete-logo-by-uuid operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 logos delete-logo-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for delete-logo-by-uuid + --request string JSON payload for request body fields + --uuid string uuid (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 logos](equinix_fabricv4_logos.md) - Manage logos resources + diff --git a/docs/equinix_fabricv4_logos_get-logo-by-uuid.md b/docs/equinix_fabricv4_logos_get-logo-by-uuid.md new file mode 100644 index 0000000..aabb465 --- /dev/null +++ b/docs/equinix_fabricv4_logos_get-logo-by-uuid.md @@ -0,0 +1,37 @@ +## equinix fabricv4 logos get-logo-by-uuid + +Execute get-logo-by-uuid operation + +### Synopsis + +Execute the get-logo-by-uuid operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 logos get-logo-by-uuid [flags] +``` + +### Options + +``` + -h, --help help for get-logo-by-uuid + --request string JSON payload for request body fields + --uuid string uuid (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 logos](equinix_fabricv4_logos.md) - Manage logos resources + diff --git a/docs/equinix_fabricv4_metrics.md b/docs/equinix_fabricv4_metrics.md index f963746..d20dc35 100644 --- a/docs/equinix_fabricv4_metrics.md +++ b/docs/equinix_fabricv4_metrics.md @@ -24,5 +24,6 @@ Commands for managing metrics resources in the API * [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources * [equinix fabricv4 metrics get-metric-by-asset-id](equinix_fabricv4_metrics_get-metric-by-asset-id.md) - Get Metrics by Asset Id +* [equinix fabricv4 metrics get-metric-by-name](equinix_fabricv4_metrics_get-metric-by-name.md) - Execute get-metric-by-name operation * [equinix fabricv4 metrics search-metrics](equinix_fabricv4_metrics_search-metrics.md) - Search Metrics diff --git a/docs/equinix_fabricv4_metrics_get-metric-by-name.md b/docs/equinix_fabricv4_metrics_get-metric-by-name.md new file mode 100644 index 0000000..d68816c --- /dev/null +++ b/docs/equinix_fabricv4_metrics_get-metric-by-name.md @@ -0,0 +1,40 @@ +## equinix fabricv4 metrics get-metric-by-name + +Execute get-metric-by-name operation + +### Synopsis + +Execute the get-metric-by-name operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 metrics get-metric-by-name [flags] +``` + +### Options + +``` + -h, --help help for get-metric-by-name + --limit int limit field + --name string name field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --value string value field +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 metrics](equinix_fabricv4_metrics.md) - Manage metrics resources + diff --git a/docs/equinix_fabricv4_ports_create-port.md b/docs/equinix_fabricv4_ports_create-port.md index 6948777..51f5e24 100644 --- a/docs/equinix_fabricv4_ports_create-port.md +++ b/docs/equinix_fabricv4_ports_create-port.md @@ -17,48 +17,12 @@ equinix fabricv4 ports create-port [flags] ``` --dry-run dry-run field -h, --help help for create-port - --port-request-account-account-name string Account name - --port-request-account-account-number int Account number + --port-request-account-account-number int port-request-account-account-number --port-request-account-additional-properties string port-request-account-additional-properties (JSON) - --port-request-account-global-cust-id string Account name - --port-request-account-global-org-id string Global organization identifier - --port-request-account-global-organization-name string Global organization name - --port-request-account-org-id int Customer organization identifier - --port-request-account-organization-name string Customer organization name - --port-request-account-reseller-account-name string Reseller account name - --port-request-account-reseller-account-number int Reseller account number - --port-request-account-reseller-org-id int Reseller customer organization identifier - --port-request-account-reseller-ucm-id string Reseller account ucmId - --port-request-account-ucm-id string Account ucmId - --port-request-additional-info string Port additional information (JSON array) --port-request-additional-properties string port-request-additional-properties (JSON) - --port-request-asn int Port ASN - --port-request-available-bandwidth int Equinix assigned response attribute for Port available bandwidth in Mbps --port-request-bandwidth int Equinix assigned response attribute for Port bandwidth in Mbps Deprecated --port-request-bmmr-type string port-request-bmmr-type - --port-request-change-additional-properties string port-request-change-additional-properties (JSON) - --port-request-change-created-date-time string port-request-change-created-date-time (JSON) - --port-request-change-data string port-request-change-data (JSON) - --port-request-change-information string Additional information - --port-request-change-log-additional-properties string port-request-change-log-additional-properties (JSON) - --port-request-change-log-created-by string Created by User Key - --port-request-change-log-created-by-email string Created by User Email Address - --port-request-change-log-created-by-full-name string Created by User Full Name - --port-request-change-log-created-date-time string port-request-change-log-created-date-time (JSON) - --port-request-change-log-deleted-by string Deleted by User Key - --port-request-change-log-deleted-by-email string Deleted by User Email Address - --port-request-change-log-deleted-by-full-name string Deleted by User Full Name - --port-request-change-log-deleted-date-time string port-request-change-log-deleted-date-time (JSON) - --port-request-change-log-updated-by string Updated by User Key - --port-request-change-log-updated-by-email string Updated by User Email Address - --port-request-change-log-updated-by-full-name string Updated by User Full Name - --port-request-change-log-updated-date-time string port-request-change-log-updated-date-time (JSON) - --port-request-change-status string port-request-change-status - --port-request-change-type string port-request-change-type - --port-request-change-updated-date-time string port-request-change-updated-date-time (JSON) - --port-request-change-uuid string Uniquely identifies a change - --port-request-connections-count int Equinix assigned response attribute for Connection count --port-request-connectivity-source-type string port-request-connectivity-source-type --port-request-demarcation-point-additional-properties string port-request-demarcation-point-additional-properties (JSON) --port-request-demarcation-point-cabinet-unique-space-id string Port cabinet unique space id @@ -70,56 +34,20 @@ equinix fabricv4 ports create-port [flags] Deprecated --port-request-demarcation-point-patch-panel-port-a string Port patch panel port A --port-request-demarcation-point-patch-panel-port-b string Port patch panel port B - --port-request-description string Equinix assigned response attribute for Port description - --port-request-device-additional-properties string port-request-device-additional-properties (JSON) - --port-request-device-name string Device name - Deprecated - --port-request-device-redundancy string port-request-device-redundancy (JSON) - --port-request-device-vc-bandwidth-max int Maximum bandwidth allowed for connection. --port-request-encapsulation-additional-properties string port-request-encapsulation-additional-properties (JSON) --port-request-encapsulation-tag-protocol-id string Port encapsulation tag protocol identifier --port-request-encapsulation-type string port-request-encapsulation-type - --port-request-end-customer-additional-properties string port-request-end-customer-additional-properties (JSON) - --port-request-end-customer-is-disclosed Indicate if endCustomer info should be disclosed or not - --port-request-end-customer-mdm-id string port-request-end-customer-mdm-id - --port-request-end-customer-name string port-request-end-customer-name - --port-request-href string Equinix assigned response attribute for an absolute URL that is the subject of the link's context. - --port-request-id int Equinix assigned response attribute for Port Id - --port-request-interface-additional-properties string port-request-interface-additional-properties (JSON) - --port-request-interface-type string Port interface type - --port-request-lag-additional-properties string port-request-lag-additional-properties (JSON) --port-request-lag-enabled If LAG enabled - --port-request-lag-id string id - --port-request-lag-member-status string member status - --port-request-lag-name string name --port-request-loas string Port Loas (JSON array) --port-request-location-additional-properties string port-request-location-additional-properties (JSON) - --port-request-location-ibx string Deprecated --port-request-location-metro-code string port-request-location-metro-code - --port-request-location-metro-href string port-request-location-metro-href - --port-request-location-metro-name string port-request-location-metro-name - --port-request-location-region string port-request-location-region - --port-request-name string Equinix assigned response attribute for Port name --port-request-notifications string Notification preferences (JSON array) - --port-request-operation-access-v-c-count int Total number of connections. - --port-request-operation-additional-properties string port-request-operation-additional-properties (JSON) - --port-request-operation-connection-count int Total number of connections. - --port-request-operation-evpl-v-c-count int Total number of connections. - --port-request-operation-fg-v-c-count int Total number of connections. - --port-request-operation-op-status-changed-at string port-request-operation-op-status-changed-at (JSON) - --port-request-operation-operational-status string port-request-operation-operational-status --port-request-order-additional-properties string port-request-order-additional-properties (JSON) --port-request-order-customer-reference-id string Customer order reference Id - --port-request-order-order-id string Order Identification - --port-request-order-order-number string Order Reference Number --port-request-order-purchase-order string port-request-order-purchase-order (JSON) --port-request-order-signature string port-request-order-signature (JSON) - --port-request-order-uuid string Equinix-assigned order identifier, this is a derived response atrribute - Deprecated --port-request-package-additional-properties string port-request-package-additional-properties (JSON) --port-request-package-code string port-request-package-code - --port-request-package-type string port-request-package-type - --port-request-physical-port-quantity int Number of physical ports --port-request-physical-ports string Physical ports that implement this port (JSON array) --port-request-physical-ports-count int port-request-physical-ports-count --port-request-physical-ports-speed int Physical Ports Speed in Mbps @@ -131,20 +59,16 @@ equinix fabricv4 ports create-port [flags] --port-request-redundancy-group string Port UUID of respective primary port Deprecated --port-request-redundancy-priority string port-request-redundancy-priority + --port-request-service-code string port-request-service-code --port-request-service-type string Deprecated --port-request-settings-additional-properties string port-request-settings-additional-properties (JSON) --port-request-settings-buyout Deprecated --port-request-settings-layer3-enabled Deprecated --port-request-settings-package-type string Deprecated --port-request-settings-place-vc-order-permission Deprecated - --port-request-settings-shared-port-product string port-request-settings-shared-port-product - --port-request-settings-shared-port-type port-request-settings-shared-port-type --port-request-settings-view-port-permission Deprecated - --port-request-state string port-request-state --port-request-tether-ibx string z-side/Equinix ibx --port-request-type string port-request-type - --port-request-used-bandwidth int Equinix assigned response attribute for Port used bandwidth in Mbps - --port-request-uuid string Equinix assigned response attribute for port identifier --request string JSON payload for additional optional fields not exposed as flags ``` diff --git a/docs/equinix_fabricv4_route-aggregation-rules.md b/docs/equinix_fabricv4_route-aggregation-rules.md index 2fd61a7..3b4dd96 100644 --- a/docs/equinix_fabricv4_route-aggregation-rules.md +++ b/docs/equinix_fabricv4_route-aggregation-rules.md @@ -32,4 +32,5 @@ Commands for managing route-aggregation-rules resources in the API * [equinix fabricv4 route-aggregation-rules get-route-aggregation-rules](equinix_fabricv4_route-aggregation-rules_get-route-aggregation-rules.md) - GetRARules * [equinix fabricv4 route-aggregation-rules patch-route-aggregation-rule-by-uuid](equinix_fabricv4_route-aggregation-rules_patch-route-aggregation-rule-by-uuid.md) - PatchRARule * [equinix fabricv4 route-aggregation-rules replace-route-aggregation-rule-by-uuid](equinix_fabricv4_route-aggregation-rules_replace-route-aggregation-rule-by-uuid.md) - ReplaceRARule +* [equinix fabricv4 route-aggregation-rules search-route-aggregation-rules](equinix_fabricv4_route-aggregation-rules_search-route-aggregation-rules.md) - Execute search-route-aggregation-rules operation diff --git a/docs/equinix_fabricv4_route-aggregation-rules_search-route-aggregation-rules.md b/docs/equinix_fabricv4_route-aggregation-rules_search-route-aggregation-rules.md new file mode 100644 index 0000000..d8432c5 --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregation-rules_search-route-aggregation-rules.md @@ -0,0 +1,44 @@ +## equinix fabricv4 route-aggregation-rules search-route-aggregation-rules + +Execute search-route-aggregation-rules operation + +### Synopsis + +Execute the search-route-aggregation-rules operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 route-aggregation-rules search-route-aggregation-rules [flags] +``` + +### Options + +``` + -h, --help help for search-route-aggregation-rules + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregation-rules-search-request-additional-properties string route-aggregation-rules-search-request-additional-properties (JSON) + --route-aggregation-rules-search-request-filter-route-aggregation-rule-and-expression string route-aggregation-rules-search-request-filter-route-aggregation-rule-and-expression (JSON) + --route-aggregation-rules-search-request-filter-route-aggregation-rule-or-expression string route-aggregation-rules-search-request-filter-route-aggregation-rule-or-expression (JSON) + --route-aggregation-rules-search-request-pagination-additional-properties string route-aggregation-rules-search-request-pagination-additional-properties (JSON) + --route-aggregation-rules-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --route-aggregation-rules-search-request-pagination-offset int Index of the first element. + --route-aggregation-rules-search-request-sort string route-aggregation-rules-search-request-sort (JSON array) + --rule-id string rule-id (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 route-aggregation-rules](equinix_fabricv4_route-aggregation-rules.md) - Manage route-aggregation-rules resources + diff --git a/docs/equinix_fabricv4_route-aggregations.md b/docs/equinix_fabricv4_route-aggregations.md index 45e3ada..0c25b3a 100644 --- a/docs/equinix_fabricv4_route-aggregations.md +++ b/docs/equinix_fabricv4_route-aggregations.md @@ -34,5 +34,6 @@ Commands for managing route-aggregations resources in the API * [equinix fabricv4 route-aggregations get-route-aggregation-changes](equinix_fabricv4_route-aggregations_get-route-aggregation-changes.md) - Get All Changes * [equinix fabricv4 route-aggregations get-route-aggregation-connections](equinix_fabricv4_route-aggregations_get-route-aggregation-connections.md) - Get All Connections on Route Aggregation * [equinix fabricv4 route-aggregations patch-route-aggregation-by-uuid](equinix_fabricv4_route-aggregations_patch-route-aggregation-by-uuid.md) - Patch Aggregation +* [equinix fabricv4 route-aggregations search-cloud-router-route-aggregation-attachments](equinix_fabricv4_route-aggregations_search-cloud-router-route-aggregation-attachments.md) - Execute search-cloud-router-route-aggregation-attachments operation * [equinix fabricv4 route-aggregations search-route-aggregations](equinix_fabricv4_route-aggregations_search-route-aggregations.md) - Search Aggregations diff --git a/docs/equinix_fabricv4_route-aggregations_search-cloud-router-route-aggregation-attachments.md b/docs/equinix_fabricv4_route-aggregations_search-cloud-router-route-aggregation-attachments.md new file mode 100644 index 0000000..f4f2b2a --- /dev/null +++ b/docs/equinix_fabricv4_route-aggregations_search-cloud-router-route-aggregation-attachments.md @@ -0,0 +1,47 @@ +## equinix fabricv4 route-aggregations search-cloud-router-route-aggregation-attachments + +Execute search-cloud-router-route-aggregation-attachments operation + +### Synopsis + +Execute the search-cloud-router-route-aggregation-attachments operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 route-aggregations search-cloud-router-route-aggregation-attachments [flags] +``` + +### Options + +``` + --cloud-router-route-aggregations-search-base-additional-properties string cloud-router-route-aggregations-search-base-additional-properties (JSON) + --cloud-router-route-aggregations-search-base-filter-cloud-router-route-aggregation-and-expression string cloud-router-route-aggregations-search-base-filter-cloud-router-route-aggregation-and-expression (JSON) + --cloud-router-route-aggregations-search-base-filter-cloud-router-route-aggregation-or-expression string cloud-router-route-aggregations-search-base-filter-cloud-router-route-aggregation-or-expression (JSON) + --cloud-router-route-aggregations-search-base-pagination-additional-properties string cloud-router-route-aggregations-search-base-pagination-additional-properties (JSON) + --cloud-router-route-aggregations-search-base-pagination-limit int Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. + --cloud-router-route-aggregations-search-base-pagination-next string URL relative to the next item in the response. + --cloud-router-route-aggregations-search-base-pagination-offset int Index of the first item returned in the response. The default is 0. + --cloud-router-route-aggregations-search-base-pagination-previous string URL relative to the previous item in the response. + --cloud-router-route-aggregations-search-base-pagination-total int Total number of elements returned. + --cloud-router-route-aggregations-search-base-sort string cloud-router-route-aggregations-search-base-sort (JSON array) + -h, --help help for search-cloud-router-route-aggregation-attachments + --request string JSON payload for additional optional fields not exposed as flags + --router-id string router-id (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 route-aggregations](equinix_fabricv4_route-aggregations.md) - Manage route-aggregations resources + diff --git a/docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md b/docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md index 41f48ea..d31c5b7 100644 --- a/docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md +++ b/docs/equinix_fabricv4_route-aggregations_search-route-aggregations.md @@ -15,18 +15,15 @@ equinix fabricv4 route-aggregations search-route-aggregations [flags] ### Options ``` - -h, --help help for search-route-aggregations - --request string JSON payload for additional optional fields not exposed as flags - --route-aggregations-search-base-additional-properties string route-aggregations-search-base-additional-properties (JSON) - --route-aggregations-search-base-filter-additional-properties string route-aggregations-search-base-filter-additional-properties (JSON) - --route-aggregations-search-base-filter-and string route-aggregations-search-base-filter-and (JSON array) - --route-aggregations-search-base-pagination-additional-properties string route-aggregations-search-base-pagination-additional-properties (JSON) - --route-aggregations-search-base-pagination-limit int Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. - --route-aggregations-search-base-pagination-next string URL relative to the next item in the response. - --route-aggregations-search-base-pagination-offset int Index of the first item returned in the response. The default is 0. - --route-aggregations-search-base-pagination-previous string URL relative to the previous item in the response. - --route-aggregations-search-base-pagination-total int Total number of elements returned. - --route-aggregations-search-base-sort string route-aggregations-search-base-sort (JSON array) + -h, --help help for search-route-aggregations + --request string JSON payload for additional optional fields not exposed as flags + --route-aggregations-search-request-additional-properties string route-aggregations-search-request-additional-properties (JSON) + --route-aggregations-search-request-filter-search-and-expression string route-aggregations-search-request-filter-search-and-expression (JSON) + --route-aggregations-search-request-filter-search-or-expression string route-aggregations-search-request-filter-search-or-expression (JSON) + --route-aggregations-search-request-pagination-additional-properties string route-aggregations-search-request-pagination-additional-properties (JSON) + --route-aggregations-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --route-aggregations-search-request-pagination-offset int Index of the first element. + --route-aggregations-search-request-sort string route-aggregations-search-request-sort (JSON array) ``` ### Options inherited from parent commands diff --git a/docs/equinix_fabricv4_route-filter-rules.md b/docs/equinix_fabricv4_route-filter-rules.md index 5a81113..ee0edce 100644 --- a/docs/equinix_fabricv4_route-filter-rules.md +++ b/docs/equinix_fabricv4_route-filter-rules.md @@ -32,4 +32,5 @@ Commands for managing route-filter-rules resources in the API * [equinix fabricv4 route-filter-rules get-route-filter-rules](equinix_fabricv4_route-filter-rules_get-route-filter-rules.md) - Get Route Filter Rules * [equinix fabricv4 route-filter-rules patch-route-filter-rule-by-uuid](equinix_fabricv4_route-filter-rules_patch-route-filter-rule-by-uuid.md) - Patch Route Filter Rule * [equinix fabricv4 route-filter-rules replace-route-filter-rule-by-uuid](equinix_fabricv4_route-filter-rules_replace-route-filter-rule-by-uuid.md) - Replace Route Filter Rule +* [equinix fabricv4 route-filter-rules search-route-filter-rules](equinix_fabricv4_route-filter-rules_search-route-filter-rules.md) - Execute search-route-filter-rules operation diff --git a/docs/equinix_fabricv4_route-filter-rules_search-route-filter-rules.md b/docs/equinix_fabricv4_route-filter-rules_search-route-filter-rules.md new file mode 100644 index 0000000..2120719 --- /dev/null +++ b/docs/equinix_fabricv4_route-filter-rules_search-route-filter-rules.md @@ -0,0 +1,44 @@ +## equinix fabricv4 route-filter-rules search-route-filter-rules + +Execute search-route-filter-rules operation + +### Synopsis + +Execute the search-route-filter-rules operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 route-filter-rules search-route-filter-rules [flags] +``` + +### Options + +``` + -h, --help help for search-route-filter-rules + --request string JSON payload for additional optional fields not exposed as flags + --route-filter-rules-search-request-additional-properties string route-filter-rules-search-request-additional-properties (JSON) + --route-filter-rules-search-request-filter-route-filter-rule-and-expression string route-filter-rules-search-request-filter-route-filter-rule-and-expression (JSON) + --route-filter-rules-search-request-filter-route-filter-rule-or-expression string route-filter-rules-search-request-filter-route-filter-rule-or-expression (JSON) + --route-filter-rules-search-request-pagination-additional-properties string route-filter-rules-search-request-pagination-additional-properties (JSON) + --route-filter-rules-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --route-filter-rules-search-request-pagination-offset int Index of the first element. + --route-filter-rules-search-request-sort string route-filter-rules-search-request-sort (JSON array) + --rule-id string rule-id (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 route-filter-rules](equinix_fabricv4_route-filter-rules.md) - Manage route-filter-rules resources + diff --git a/docs/equinix_fabricv4_route-filters.md b/docs/equinix_fabricv4_route-filters.md index d7722f3..b554e09 100644 --- a/docs/equinix_fabricv4_route-filters.md +++ b/docs/equinix_fabricv4_route-filters.md @@ -34,5 +34,6 @@ Commands for managing route-filters resources in the API * [equinix fabricv4 route-filters get-route-filter-changes](equinix_fabricv4_route-filters_get-route-filter-changes.md) - Get All Changes * [equinix fabricv4 route-filters get-route-filter-connections](equinix_fabricv4_route-filters_get-route-filter-connections.md) - Get All Connections on Route Filter * [equinix fabricv4 route-filters patch-route-filter-by-uuid](equinix_fabricv4_route-filters_patch-route-filter-by-uuid.md) - Patch Route Filter +* [equinix fabricv4 route-filters search-cloud-router-route-filter-attachments](equinix_fabricv4_route-filters_search-cloud-router-route-filter-attachments.md) - Execute search-cloud-router-route-filter-attachments operation * [equinix fabricv4 route-filters search-route-filters](equinix_fabricv4_route-filters_search-route-filters.md) - Search Route Filters diff --git a/docs/equinix_fabricv4_route-filters_search-cloud-router-route-filter-attachments.md b/docs/equinix_fabricv4_route-filters_search-cloud-router-route-filter-attachments.md new file mode 100644 index 0000000..eebac60 --- /dev/null +++ b/docs/equinix_fabricv4_route-filters_search-cloud-router-route-filter-attachments.md @@ -0,0 +1,47 @@ +## equinix fabricv4 route-filters search-cloud-router-route-filter-attachments + +Execute search-cloud-router-route-filter-attachments operation + +### Synopsis + +Execute the search-cloud-router-route-filter-attachments operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 route-filters search-cloud-router-route-filter-attachments [flags] +``` + +### Options + +``` + --cloud-router-route-filters-search-base-additional-properties string cloud-router-route-filters-search-base-additional-properties (JSON) + --cloud-router-route-filters-search-base-filter-cloud-router-route-filter-and-expression string cloud-router-route-filters-search-base-filter-cloud-router-route-filter-and-expression (JSON) + --cloud-router-route-filters-search-base-filter-cloud-router-route-filter-or-expression string cloud-router-route-filters-search-base-filter-cloud-router-route-filter-or-expression (JSON) + --cloud-router-route-filters-search-base-pagination-additional-properties string cloud-router-route-filters-search-base-pagination-additional-properties (JSON) + --cloud-router-route-filters-search-base-pagination-limit int Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. + --cloud-router-route-filters-search-base-pagination-next string URL relative to the next item in the response. + --cloud-router-route-filters-search-base-pagination-offset int Index of the first item returned in the response. The default is 0. + --cloud-router-route-filters-search-base-pagination-previous string URL relative to the previous item in the response. + --cloud-router-route-filters-search-base-pagination-total int Total number of elements returned. + --cloud-router-route-filters-search-base-sort string cloud-router-route-filters-search-base-sort (JSON array) + -h, --help help for search-cloud-router-route-filter-attachments + --request string JSON payload for additional optional fields not exposed as flags + --router-id string router-id (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 route-filters](equinix_fabricv4_route-filters.md) - Manage route-filters resources + diff --git a/docs/equinix_fabricv4_route-filters_search-route-filters.md b/docs/equinix_fabricv4_route-filters_search-route-filters.md index cc5aca0..4fe94fd 100644 --- a/docs/equinix_fabricv4_route-filters_search-route-filters.md +++ b/docs/equinix_fabricv4_route-filters_search-route-filters.md @@ -15,18 +15,15 @@ equinix fabricv4 route-filters search-route-filters [flags] ### Options ``` - -h, --help help for search-route-filters - --request string JSON payload for additional optional fields not exposed as flags - --route-filters-search-base-additional-properties string route-filters-search-base-additional-properties (JSON) - --route-filters-search-base-filter-additional-properties string route-filters-search-base-filter-additional-properties (JSON) - --route-filters-search-base-filter-and string route-filters-search-base-filter-and (JSON array) - --route-filters-search-base-pagination-additional-properties string route-filters-search-base-pagination-additional-properties (JSON) - --route-filters-search-base-pagination-limit int Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. - --route-filters-search-base-pagination-next string URL relative to the next item in the response. - --route-filters-search-base-pagination-offset int Index of the first item returned in the response. The default is 0. - --route-filters-search-base-pagination-previous string URL relative to the previous item in the response. - --route-filters-search-base-pagination-total int Total number of elements returned. - --route-filters-search-base-sort string route-filters-search-base-sort (JSON array) + -h, --help help for search-route-filters + --request string JSON payload for additional optional fields not exposed as flags + --route-filters-search-request-additional-properties string route-filters-search-request-additional-properties (JSON) + --route-filters-search-request-filter-search-and-expression string route-filters-search-request-filter-search-and-expression (JSON) + --route-filters-search-request-filter-search-or-expression string route-filters-search-request-filter-search-or-expression (JSON) + --route-filters-search-request-pagination-additional-properties string route-filters-search-request-pagination-additional-properties (JSON) + --route-filters-search-request-pagination-limit int Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. + --route-filters-search-request-pagination-offset int Index of the first element. + --route-filters-search-request-sort string route-filters-search-request-sort (JSON array) ``` ### Options inherited from parent commands diff --git a/docs/equinix_fabricv4_service-profiles.md b/docs/equinix_fabricv4_service-profiles.md index f813308..ef1ee95 100644 --- a/docs/equinix_fabricv4_service-profiles.md +++ b/docs/equinix_fabricv4_service-profiles.md @@ -24,6 +24,7 @@ Commands for managing service-profiles resources in the API * [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources * [equinix fabricv4 service-profiles create-service-profile](equinix_fabricv4_service-profiles_create-service-profile.md) - Create Profile +* [equinix fabricv4 service-profiles create-service-profile-action](equinix_fabricv4_service-profiles_create-service-profile-action.md) - Execute create-service-profile-action operation * [equinix fabricv4 service-profiles delete-service-profile-by-uuid](equinix_fabricv4_service-profiles_delete-service-profile-by-uuid.md) - Delete Profile * [equinix fabricv4 service-profiles get-service-profile-by-uuid](equinix_fabricv4_service-profiles_get-service-profile-by-uuid.md) - Get Profile * [equinix fabricv4 service-profiles get-service-profile-metros-by-uuid](equinix_fabricv4_service-profiles_get-service-profile-metros-by-uuid.md) - Get Profile Metros diff --git a/docs/equinix_fabricv4_service-profiles_create-service-profile-action.md b/docs/equinix_fabricv4_service-profiles_create-service-profile-action.md new file mode 100644 index 0000000..d8d2e7e --- /dev/null +++ b/docs/equinix_fabricv4_service-profiles_create-service-profile-action.md @@ -0,0 +1,40 @@ +## equinix fabricv4 service-profiles create-service-profile-action + +Execute create-service-profile-action operation + +### Synopsis + +Execute the create-service-profile-action operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 service-profiles create-service-profile-action [flags] +``` + +### Options + +``` + -h, --help help for create-service-profile-action + --profile-id string profile-id (required) + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-action-request-additional-properties string service-profile-action-request-additional-properties (JSON) + --service-profile-action-request-description string service-profile-action-request-description + --service-profile-action-request-type string service-profile-action-request-type +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 service-profiles](equinix_fabricv4_service-profiles.md) - Manage service-profiles resources + diff --git a/docs/equinix_fabricv4_service-profiles_create-service-profile.md b/docs/equinix_fabricv4_service-profiles_create-service-profile.md index eec8e68..0c9d8c6 100644 --- a/docs/equinix_fabricv4_service-profiles_create-service-profile.md +++ b/docs/equinix_fabricv4_service-profiles_create-service-profile.md @@ -15,31 +15,36 @@ equinix fabricv4 service-profiles create-service-profile [flags] ### Options ``` - -h, --help help for create-service-profile - --request string JSON payload for additional optional fields not exposed as flags - --service-profile-request-access-point-type-configs string service-profile-request-access-point-type-configs (JSON array) - --service-profile-request-additional-properties string service-profile-request-additional-properties (JSON) - --service-profile-request-allowed-emails string service-profile-request-allowed-emails (JSON array) - --service-profile-request-custom-fields string service-profile-request-custom-fields (JSON array) - --service-profile-request-description string User-provided service description should be of maximum length 375 - --service-profile-request-href string Service Profile URI response attribute - --service-profile-request-marketing-info-additional-properties string service-profile-request-marketing-info-additional-properties (JSON) - --service-profile-request-marketing-info-logo string Logo file name - --service-profile-request-marketing-info-process-steps string service-profile-request-marketing-info-process-steps (JSON array) - --service-profile-request-marketing-info-promotion Profile promotion on marketplace - --service-profile-request-metros string Derived response attribute. (JSON array) - --service-profile-request-name string Customer-assigned service profile name - --service-profile-request-notifications string Recipients of notifications on service profile change (JSON array) - --service-profile-request-ports string service-profile-request-ports (JSON array) - --service-profile-request-project-additional-properties string service-profile-request-project-additional-properties (JSON) - --service-profile-request-project-id string service-profile-request-project-id - --service-profile-request-project-project-id string Subscriber-assigned project ID - --service-profile-request-self-profile response attribute indicates whether the profile belongs to the same organization as the api-invoker. - --service-profile-request-tags string service-profile-request-tags (JSON array) - --service-profile-request-type string service-profile-request-type - --service-profile-request-uuid string Equinix-assigned service profile identifier - --service-profile-request-virtual-devices string service-profile-request-virtual-devices (JSON array) - --service-profile-request-visibility string service-profile-request-visibility + -h, --help help for create-service-profile + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-request-access-point-type-configs string service-profile-request-access-point-type-configs (JSON array) + --service-profile-request-additional-properties string service-profile-request-additional-properties (JSON) + --service-profile-request-allowed-emails string service-profile-request-allowed-emails (JSON array) + --service-profile-request-custom-fields string service-profile-request-custom-fields (JSON array) + --service-profile-request-description string User-provided service description should be of maximum length 375 + --service-profile-request-environments string service-profile-request-environments (JSON array) + --service-profile-request-href string Service Profile URI response attribute + --service-profile-request-last-mile-config-additional-properties string service-profile-request-last-mile-config-additional-properties (JSON) + --service-profile-request-last-mile-config-address string service-profile-request-last-mile-config-address (JSON) + --service-profile-request-last-mile-config-notifications string service-profile-request-last-mile-config-notifications (JSON array) + --service-profile-request-last-mile-config-product-catalogs string service-profile-request-last-mile-config-product-catalogs (JSON array) + --service-profile-request-marketing-info-additional-properties string service-profile-request-marketing-info-additional-properties (JSON) + --service-profile-request-marketing-info-logo string Logo file name + --service-profile-request-marketing-info-process-steps string service-profile-request-marketing-info-process-steps (JSON array) + --service-profile-request-marketing-info-promotion Profile promotion on marketplace + --service-profile-request-metros string Derived response attribute. (JSON array) + --service-profile-request-name string Customer-assigned service profile name + --service-profile-request-notifications string Recipients of notifications on service profile change (JSON array) + --service-profile-request-ports string service-profile-request-ports (JSON array) + --service-profile-request-project-additional-properties string service-profile-request-project-additional-properties (JSON) + --service-profile-request-project-id string service-profile-request-project-id + --service-profile-request-project-project-id string Subscriber-assigned project ID + --service-profile-request-self-profile response attribute indicates whether the profile belongs to the same organization as the api-invoker. + --service-profile-request-tags string service-profile-request-tags (JSON array) + --service-profile-request-type string service-profile-request-type + --service-profile-request-uuid string Equinix-assigned service profile identifier + --service-profile-request-virtual-devices string service-profile-request-virtual-devices (JSON array) + --service-profile-request-visibility string service-profile-request-visibility ``` ### Options inherited from parent commands diff --git a/docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md b/docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md index 97419f3..3cc1077 100644 --- a/docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md +++ b/docs/equinix_fabricv4_service-profiles_put-service-profile-by-uuid.md @@ -15,33 +15,38 @@ equinix fabricv4 service-profiles put-service-profile-by-uuid [flags] ### Options ``` - -h, --help help for put-service-profile-by-uuid - --if-match string if-match field - --request string JSON payload for additional optional fields not exposed as flags - --service-profile-id string Service Profile UUID (required) - --service-profile-request-access-point-type-configs string service-profile-request-access-point-type-configs (JSON array) - --service-profile-request-additional-properties string service-profile-request-additional-properties (JSON) - --service-profile-request-allowed-emails string service-profile-request-allowed-emails (JSON array) - --service-profile-request-custom-fields string service-profile-request-custom-fields (JSON array) - --service-profile-request-description string User-provided service description should be of maximum length 375 - --service-profile-request-href string Service Profile URI response attribute - --service-profile-request-marketing-info-additional-properties string service-profile-request-marketing-info-additional-properties (JSON) - --service-profile-request-marketing-info-logo string Logo file name - --service-profile-request-marketing-info-process-steps string service-profile-request-marketing-info-process-steps (JSON array) - --service-profile-request-marketing-info-promotion Profile promotion on marketplace - --service-profile-request-metros string Derived response attribute. (JSON array) - --service-profile-request-name string Customer-assigned service profile name - --service-profile-request-notifications string Recipients of notifications on service profile change (JSON array) - --service-profile-request-ports string service-profile-request-ports (JSON array) - --service-profile-request-project-additional-properties string service-profile-request-project-additional-properties (JSON) - --service-profile-request-project-id string service-profile-request-project-id - --service-profile-request-project-project-id string Subscriber-assigned project ID - --service-profile-request-self-profile response attribute indicates whether the profile belongs to the same organization as the api-invoker. - --service-profile-request-tags string service-profile-request-tags (JSON array) - --service-profile-request-type string service-profile-request-type - --service-profile-request-uuid string Equinix-assigned service profile identifier - --service-profile-request-virtual-devices string service-profile-request-virtual-devices (JSON array) - --service-profile-request-visibility string service-profile-request-visibility + -h, --help help for put-service-profile-by-uuid + --if-match string if-match field + --request string JSON payload for additional optional fields not exposed as flags + --service-profile-id string Service Profile UUID (required) + --service-profile-request-access-point-type-configs string service-profile-request-access-point-type-configs (JSON array) + --service-profile-request-additional-properties string service-profile-request-additional-properties (JSON) + --service-profile-request-allowed-emails string service-profile-request-allowed-emails (JSON array) + --service-profile-request-custom-fields string service-profile-request-custom-fields (JSON array) + --service-profile-request-description string User-provided service description should be of maximum length 375 + --service-profile-request-environments string service-profile-request-environments (JSON array) + --service-profile-request-href string Service Profile URI response attribute + --service-profile-request-last-mile-config-additional-properties string service-profile-request-last-mile-config-additional-properties (JSON) + --service-profile-request-last-mile-config-address string service-profile-request-last-mile-config-address (JSON) + --service-profile-request-last-mile-config-notifications string service-profile-request-last-mile-config-notifications (JSON array) + --service-profile-request-last-mile-config-product-catalogs string service-profile-request-last-mile-config-product-catalogs (JSON array) + --service-profile-request-marketing-info-additional-properties string service-profile-request-marketing-info-additional-properties (JSON) + --service-profile-request-marketing-info-logo string Logo file name + --service-profile-request-marketing-info-process-steps string service-profile-request-marketing-info-process-steps (JSON array) + --service-profile-request-marketing-info-promotion Profile promotion on marketplace + --service-profile-request-metros string Derived response attribute. (JSON array) + --service-profile-request-name string Customer-assigned service profile name + --service-profile-request-notifications string Recipients of notifications on service profile change (JSON array) + --service-profile-request-ports string service-profile-request-ports (JSON array) + --service-profile-request-project-additional-properties string service-profile-request-project-additional-properties (JSON) + --service-profile-request-project-id string service-profile-request-project-id + --service-profile-request-project-project-id string Subscriber-assigned project ID + --service-profile-request-self-profile response attribute indicates whether the profile belongs to the same organization as the api-invoker. + --service-profile-request-tags string service-profile-request-tags (JSON array) + --service-profile-request-type string service-profile-request-type + --service-profile-request-uuid string Equinix-assigned service profile identifier + --service-profile-request-virtual-devices string service-profile-request-virtual-devices (JSON array) + --service-profile-request-visibility string service-profile-request-visibility ``` ### Options inherited from parent commands diff --git a/docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md b/docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md index 9cca04a..23b690a 100644 --- a/docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md +++ b/docs/equinix_fabricv4_service-profiles_update-service-profile-by-uuid.md @@ -16,7 +16,6 @@ equinix fabricv4 service-profiles update-service-profile-by-uuid [flags] ``` -h, --help help for update-service-profile-by-uuid - --if-match string if-match field --json-patch-operation string json-patch-operation field (JSON or string) --request string JSON payload for additional optional fields not exposed as flags --service-profile-id string Service Profile UUID (required) diff --git a/docs/equinix_fabricv4_service-tokens_search-service-tokens.md b/docs/equinix_fabricv4_service-tokens_search-service-tokens.md index 26d28b9..b005692 100644 --- a/docs/equinix_fabricv4_service-tokens_search-service-tokens.md +++ b/docs/equinix_fabricv4_service-tokens_search-service-tokens.md @@ -23,6 +23,7 @@ equinix fabricv4 service-tokens search-service-tokens [flags] --service-token-search-request-filter-additional-properties string service-token-search-request-filter-additional-properties (JSON) --service-token-search-request-filter-and string service-token-search-request-filter-and (JSON array) --service-token-search-request-filter-operator string service-token-search-request-filter-operator + --service-token-search-request-filter-or string service-token-search-request-filter-or (JSON array) --service-token-search-request-filter-property string service-token-search-request-filter-property --service-token-search-request-filter-values string service-token-search-request-filter-values (JSON array) --service-token-search-request-pagination-additional-properties string service-token-search-request-pagination-additional-properties (JSON) diff --git a/docs/equinix_fabricv4_tags.md b/docs/equinix_fabricv4_tags.md new file mode 100644 index 0000000..3ce49b1 --- /dev/null +++ b/docs/equinix_fabricv4_tags.md @@ -0,0 +1,28 @@ +## equinix fabricv4 tags + +Manage tags resources + +### Synopsis + +Commands for managing tags resources in the API + +### Options + +``` + -h, --help help for tags +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources +* [equinix fabricv4 tags create-tag](equinix_fabricv4_tags_create-tag.md) - Execute create-tag operation +* [equinix fabricv4 tags list-tags](equinix_fabricv4_tags_list-tags.md) - Execute list-tags operation + diff --git a/docs/equinix_fabricv4_tags_create-tag.md b/docs/equinix_fabricv4_tags_create-tag.md new file mode 100644 index 0000000..7fc07ec --- /dev/null +++ b/docs/equinix_fabricv4_tags_create-tag.md @@ -0,0 +1,40 @@ +## equinix fabricv4 tags create-tag + +Execute create-tag operation + +### Synopsis + +Execute the create-tag operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 tags create-tag [flags] +``` + +### Options + +``` + -h, --help help for create-tag + --request string JSON payload for additional optional fields not exposed as flags + --tag-request-additional-properties string tag-request-additional-properties (JSON) + --tag-request-display-name string tag-request-display-name + --tag-request-name string tag-request-name + --tag-request-type string tag-request-type +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 tags](equinix_fabricv4_tags.md) - Manage tags resources + diff --git a/docs/equinix_fabricv4_tags_list-tags.md b/docs/equinix_fabricv4_tags_list-tags.md new file mode 100644 index 0000000..e9f1fdb --- /dev/null +++ b/docs/equinix_fabricv4_tags_list-tags.md @@ -0,0 +1,39 @@ +## equinix fabricv4 tags list-tags + +Execute list-tags operation + +### Synopsis + +Execute the list-tags operation on this service. + +Use --request flag to provide a JSON payload for the request body. +Example: --request '{"field":"value"}' + +The command accepts parameters based on the SDK method signature. + +``` +equinix fabricv4 tags list-tags [flags] +``` + +### Options + +``` + -h, --help help for list-tags + --limit int limit field + --offset int offset field + --request string JSON payload for additional optional fields not exposed as flags + --type_ string type_ field (JSON or string) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/.config/equinix/equinix.yaml) + --debug Enable debug logging for HTTP requests + -f, --format string Format to use for output (json or yaml) (default "json") +``` + +### SEE ALSO + +* [equinix fabricv4 tags](equinix_fabricv4_tags.md) - Manage tags resources + diff --git a/go.mod b/go.mod index 58bedb1..bfb0d55 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/equinix/cli go 1.24.5 require ( - github.com/equinix/equinix-sdk-go v0.61.0 + github.com/equinix/equinix-sdk-go v0.66.0 github.com/spf13/cobra v1.10.2 github.com/spf13/pflag v1.0.10 github.com/spf13/viper v1.21.0 diff --git a/go.sum b/go.sum index 11f0555..0508cab 100644 --- a/go.sum +++ b/go.sum @@ -4,6 +4,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/equinix/equinix-sdk-go v0.61.0 h1:7pSLMfcrpH9Gkj9qYs1Ul7Lg/EYKiC+ImbXpmKwvmCE= github.com/equinix/equinix-sdk-go v0.61.0/go.mod h1:QokAmUtlYlD4gJ1s5UL1nZ4e6XALV0ftl5ZCwdPYp5M= +github.com/equinix/equinix-sdk-go v0.66.0 h1:2t0espzvXMKrskOEGCGILXYI+hU4DtWe20m55C1tIDI= +github.com/equinix/equinix-sdk-go v0.66.0/go.mod h1:QokAmUtlYlD4gJ1s5UL1nZ4e6XALV0ftl5ZCwdPYp5M= github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8= github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0= github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k=