From 3726eefb4a6ca3ccf99f589a4d7cfa6de391cfb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Czoma?= Date: Wed, 20 Dec 2023 14:10:57 -0500 Subject: [PATCH] Updated Beta release 0.9.1 (#62) * Updated SEMP schema to 2.39 * Improvements and fixes: * SOL-109405 Upgrade Terraform provider to Go v1.21 * SOL-100797 Objects that dont have dependancies dont follow the 'request_min_interval' provider attribute * SOL-100812 The request_min_interval attribute seems to wait before the first SEMP request is sent * SOL-101839 Improved retry mechanism in provider SEMP client * SOL-104984 Generator needs to escape certain charaters in attribute names * SOL-105581 Removed `id` attribute as it is no longer needed by the Terraform test framework v1.5 * SOL-105859 broker provider makes API calls at configure time * SOL-105867 Generator needs to handle terraform interpolation in string outputs --- .github/workflows/cli-test-pipeline.yml | 40 +- .github/workflows/core-pipeline-dev.yml | 50 +- .../core-pipeline-main-branch-only.yml | 9 +- .github/workflows/prep-internal-release.yml | 129 ++ .../workflows/provider-acceptance-test.yml | 4 +- .github/workflows/provider-test-pipeline.yml | 73 +- .github/workflows/verify-registry-release.yml | 84 + Makefile | 9 +- README.md | 4 +- ci/bigtest/test.tf | 1195 +++++++++++++ ...swagger-config-extended.10.6.1.30.vm.json} | 841 +++++----- ci/whitesource/whitesource-agent.config | 72 + cmd/broker/client.go | 4 +- cmd/command/configgenerator.go | 81 +- cmd/command/configwriter.go | 10 +- cmd/command/configwriter_test.go | 2 +- cmd/command/templates/terraform.template | 5 +- cmd/command/util.go | 53 +- cmd/command/util_test.go | 83 + cmd/generate.go | 43 +- cmd/root.go | 2 +- cmd/versioncmd.go | 9 +- docs/data-sources/about_api.md | 1 - docs/data-sources/about_user.md | 1 - docs/data-sources/about_user_msg_vpn.md | 13 +- docs/data-sources/broker.md | 33 +- docs/data-sources/client_cert_authority.md | 13 +- ..._authority_ocsp_tls_trusted_common_name.md | 20 +- docs/data-sources/dmr_cluster.md | 1 - .../dmr_cluster_cert_matching_rule.md | 17 +- ...ter_cert_matching_rule_attribute_filter.md | 21 +- ...mr_cluster_cert_matching_rule_condition.md | 21 +- docs/data-sources/dmr_cluster_link.md | 23 +- .../dmr_cluster_link_attribute.md | 28 +- .../dmr_cluster_link_remote_address.md | 24 +- docs/data-sources/domain_cert_authority.md | 13 +- docs/data-sources/msg_vpn.md | 8 +- docs/data-sources/msg_vpn_acl_profile.md | 17 +- ...pn_acl_profile_client_connect_exception.md | 24 +- ...vpn_acl_profile_publish_topic_exception.md | 28 +- ..._profile_subscribe_share_name_exception.md | 28 +- ...n_acl_profile_subscribe_topic_exception.md | 28 +- .../msg_vpn_authentication_oauth_profile.md | 21 +- ...ion_oauth_profile_client_required_claim.md | 21 +- ..._profile_resource_server_required_claim.md | 21 +- .../msg_vpn_authorization_group.md | 25 +- docs/data-sources/msg_vpn_bridge.md | 33 +- .../msg_vpn_bridge_remote_msg_vpn.md | 37 +- .../msg_vpn_bridge_remote_subscription.md | 25 +- .../msg_vpn_cert_matching_rule.md | 17 +- ...vpn_cert_matching_rule_attribute_filter.md | 21 +- .../msg_vpn_cert_matching_rule_condition.md | 21 +- docs/data-sources/msg_vpn_client_profile.md | 31 +- docs/data-sources/msg_vpn_client_username.md | 21 +- .../msg_vpn_client_username_attribute.md | 28 +- .../data-sources/msg_vpn_distributed_cache.md | 17 +- .../msg_vpn_distributed_cache_cluster.md | 21 +- ...che_cluster_global_caching_home_cluster.md | 28 +- ...lobal_caching_home_cluster_topic_prefix.md | 32 +- ..._vpn_distributed_cache_cluster_instance.md | 25 +- ...msg_vpn_distributed_cache_cluster_topic.md | 28 +- docs/data-sources/msg_vpn_dmr_bridge.md | 17 +- .../msg_vpn_jndi_connection_factory.md | 17 +- docs/data-sources/msg_vpn_jndi_queue.md | 17 +- docs/data-sources/msg_vpn_jndi_topic.md | 17 +- docs/data-sources/msg_vpn_kafka_receiver.md | 114 +- .../msg_vpn_kafka_receiver_topic_binding.md | 35 +- docs/data-sources/msg_vpn_kafka_sender.md | 102 +- .../msg_vpn_kafka_sender_queue_binding.md | 41 +- .../data-sources/msg_vpn_mqtt_retain_cache.md | 17 +- docs/data-sources/msg_vpn_mqtt_session.md | 21 +- .../msg_vpn_mqtt_session_subscription.md | 25 +- docs/data-sources/msg_vpn_proxy.md | 21 +- docs/data-sources/msg_vpn_queue.md | 17 +- .../msg_vpn_queue_subscription.md | 24 +- docs/data-sources/msg_vpn_queue_template.md | 17 +- docs/data-sources/msg_vpn_replay_log.md | 17 +- ...pn_replay_log_topic_filter_subscription.md | 24 +- docs/data-sources/msg_vpn_replicated_topic.md | 17 +- .../msg_vpn_rest_delivery_point.md | 17 +- ...g_vpn_rest_delivery_point_queue_binding.md | 21 +- ..._queue_binding_protected_request_header.md | 32 +- ...very_point_queue_binding_request_header.md | 25 +- ...g_vpn_rest_delivery_point_rest_consumer.md | 49 +- ...ery_point_rest_consumer_oauth_jwt_claim.md | 25 +- docs/data-sources/msg_vpn_sequenced_topic.md | 20 +- .../data-sources/msg_vpn_telemetry_profile.md | 17 +- ..._profile_receiver_acl_connect_exception.md | 24 +- .../msg_vpn_telemetry_profile_trace_filter.md | 21 +- ...metry_profile_trace_filter_subscription.md | 32 +- docs/data-sources/msg_vpn_topic_endpoint.md | 17 +- .../msg_vpn_topic_endpoint_template.md | 17 +- docs/data-sources/oauth_profile.md | 17 +- .../oauth_profile_access_level_group.md | 17 +- ...el_group_msg_vpn_access_level_exception.md | 21 +- .../oauth_profile_client_allowed_host.md | 20 +- ..._profile_client_authorization_parameter.md | 17 +- .../oauth_profile_client_required_claim.md | 17 +- ..._default_msg_vpn_access_level_exception.md | 17 +- ..._profile_resource_server_required_claim.md | 17 +- docs/data-sources/virtual_hostname.md | 13 +- docs/guides/config-generator.md | 51 +- docs/guides/provider.md | 10 +- docs/index.md | 7 +- docs/resources/broker.md | 36 +- docs/resources/client_cert_authority.md | 16 +- ..._authority_ocsp_tls_trusted_common_name.md | 20 +- docs/resources/dmr_cluster.md | 4 - .../dmr_cluster_cert_matching_rule.md | 20 +- ...ter_cert_matching_rule_attribute_filter.md | 24 +- ...mr_cluster_cert_matching_rule_condition.md | 24 +- docs/resources/dmr_cluster_link.md | 26 +- docs/resources/dmr_cluster_link_attribute.md | 28 +- .../dmr_cluster_link_remote_address.md | 24 +- docs/resources/domain_cert_authority.md | 16 +- docs/resources/msg_vpn.md | 11 +- docs/resources/msg_vpn_acl_profile.md | 20 +- ...pn_acl_profile_client_connect_exception.md | 24 +- ...vpn_acl_profile_publish_topic_exception.md | 28 +- ..._profile_subscribe_share_name_exception.md | 28 +- ...n_acl_profile_subscribe_topic_exception.md | 28 +- .../msg_vpn_authentication_oauth_profile.md | 24 +- ...ion_oauth_profile_client_required_claim.md | 24 +- ..._profile_resource_server_required_claim.md | 24 +- docs/resources/msg_vpn_authorization_group.md | 28 +- docs/resources/msg_vpn_bridge.md | 36 +- .../msg_vpn_bridge_remote_msg_vpn.md | 40 +- .../msg_vpn_bridge_remote_subscription.md | 28 +- docs/resources/msg_vpn_cert_matching_rule.md | 20 +- ...vpn_cert_matching_rule_attribute_filter.md | 24 +- .../msg_vpn_cert_matching_rule_condition.md | 24 +- docs/resources/msg_vpn_client_profile.md | 34 +- docs/resources/msg_vpn_client_username.md | 24 +- .../msg_vpn_client_username_attribute.md | 28 +- docs/resources/msg_vpn_distributed_cache.md | 20 +- .../msg_vpn_distributed_cache_cluster.md | 24 +- ...che_cluster_global_caching_home_cluster.md | 28 +- ...lobal_caching_home_cluster_topic_prefix.md | 32 +- ..._vpn_distributed_cache_cluster_instance.md | 28 +- ...msg_vpn_distributed_cache_cluster_topic.md | 28 +- docs/resources/msg_vpn_dmr_bridge.md | 20 +- .../msg_vpn_jndi_connection_factory.md | 20 +- docs/resources/msg_vpn_jndi_queue.md | 20 +- docs/resources/msg_vpn_jndi_topic.md | 20 +- docs/resources/msg_vpn_kafka_receiver.md | 127 +- .../msg_vpn_kafka_receiver_topic_binding.md | 36 +- docs/resources/msg_vpn_kafka_sender.md | 115 +- .../msg_vpn_kafka_sender_queue_binding.md | 42 +- docs/resources/msg_vpn_mqtt_retain_cache.md | 20 +- docs/resources/msg_vpn_mqtt_session.md | 24 +- .../msg_vpn_mqtt_session_subscription.md | 28 +- docs/resources/msg_vpn_proxy.md | 24 +- docs/resources/msg_vpn_queue.md | 20 +- docs/resources/msg_vpn_queue_subscription.md | 24 +- docs/resources/msg_vpn_queue_template.md | 20 +- docs/resources/msg_vpn_replay_log.md | 20 +- ...pn_replay_log_topic_filter_subscription.md | 24 +- docs/resources/msg_vpn_replicated_topic.md | 20 +- docs/resources/msg_vpn_rest_delivery_point.md | 20 +- ...g_vpn_rest_delivery_point_queue_binding.md | 24 +- ..._queue_binding_protected_request_header.md | 32 +- ...very_point_queue_binding_request_header.md | 28 +- ...g_vpn_rest_delivery_point_rest_consumer.md | 52 +- ...ery_point_rest_consumer_oauth_jwt_claim.md | 28 +- docs/resources/msg_vpn_sequenced_topic.md | 20 +- docs/resources/msg_vpn_telemetry_profile.md | 20 +- ..._profile_receiver_acl_connect_exception.md | 24 +- .../msg_vpn_telemetry_profile_trace_filter.md | 24 +- ...metry_profile_trace_filter_subscription.md | 32 +- docs/resources/msg_vpn_topic_endpoint.md | 20 +- .../msg_vpn_topic_endpoint_template.md | 20 +- docs/resources/oauth_profile.md | 20 +- .../oauth_profile_access_level_group.md | 20 +- ...el_group_msg_vpn_access_level_exception.md | 24 +- .../oauth_profile_client_allowed_host.md | 20 +- ..._profile_client_authorization_parameter.md | 20 +- .../oauth_profile_client_required_claim.md | 20 +- ..._default_msg_vpn_access_level_exception.md | 20 +- ..._profile_resource_server_required_claim.md | 20 +- docs/resources/virtual_hostname.md | 16 +- go.mod | 146 +- go.sum | 230 +-- internal/broker/conversions.go | 3 - internal/broker/datasource.go | 29 +- internal/broker/entity.go | 6 +- internal/broker/generated/AboutApi.go | 9 - internal/broker/generated/AboutUser.go | 9 - internal/broker/generated/AboutUserMsgVpn.go | 11 +- internal/broker/generated/Broker.go | 11 +- .../broker/generated/ClientCertAuthority.go | 11 +- ...ntCertAuthorityOcspTlsTrustedCommonName.go | 11 +- internal/broker/generated/DmrCluster.go | 9 - .../generated/DmrClusterCertMatchingRule.go | 11 +- ...rClusterCertMatchingRuleAttributeFilter.go | 11 +- .../DmrClusterCertMatchingRuleCondition.go | 11 +- internal/broker/generated/DmrClusterLink.go | 13 +- .../generated/DmrClusterLinkAttribute.go | 11 +- .../generated/DmrClusterLinkRemoteAddress.go | 11 +- .../broker/generated/DomainCertAuthority.go | 11 +- internal/broker/generated/MsgVpn.go | 25 +- internal/broker/generated/MsgVpnAclProfile.go | 11 +- .../MsgVpnAclProfileClientConnectException.go | 11 +- .../MsgVpnAclProfilePublishTopicException.go | 11 +- ...pnAclProfileSubscribeShareNameException.go | 11 +- ...MsgVpnAclProfileSubscribeTopicException.go | 11 +- .../MsgVpnAuthenticationOauthProfile.go | 11 +- ...ticationOauthProfileClientRequiredClaim.go | 11 +- ...OauthProfileResourceServerRequiredClaim.go | 11 +- .../generated/MsgVpnAuthorizationGroup.go | 11 +- internal/broker/generated/MsgVpnBridge.go | 11 +- .../generated/MsgVpnBridgeRemoteMsgVpn.go | 11 +- .../MsgVpnBridgeRemoteSubscription.go | 11 +- .../generated/MsgVpnCertMatchingRule.go | 11 +- .../MsgVpnCertMatchingRuleAttributeFilter.go | 11 +- .../MsgVpnCertMatchingRuleCondition.go | 11 +- .../broker/generated/MsgVpnClientProfile.go | 13 +- .../broker/generated/MsgVpnClientUsername.go | 11 +- .../MsgVpnClientUsernameAttribute.go | 11 +- .../generated/MsgVpnDistributedCache.go | 11 +- .../MsgVpnDistributedCacheCluster.go | 11 +- ...tedCacheClusterGlobalCachingHomeCluster.go | 11 +- ...sterGlobalCachingHomeClusterTopicPrefix.go | 11 +- .../MsgVpnDistributedCacheClusterInstance.go | 11 +- .../MsgVpnDistributedCacheClusterTopic.go | 11 +- internal/broker/generated/MsgVpnDmrBridge.go | 11 +- .../generated/MsgVpnJndiConnectionFactory.go | 11 +- internal/broker/generated/MsgVpnJndiQueue.go | 11 +- internal/broker/generated/MsgVpnJndiTopic.go | 11 +- .../broker/generated/MsgVpnKafkaReceiver.go | 53 +- .../MsgVpnKafkaReceiverTopicBinding.go | 17 +- .../broker/generated/MsgVpnKafkaSender.go | 49 +- .../MsgVpnKafkaSenderQueueBinding.go | 19 +- .../broker/generated/MsgVpnMqttRetainCache.go | 11 +- .../broker/generated/MsgVpnMqttSession.go | 11 +- .../MsgVpnMqttSessionSubscription.go | 11 +- internal/broker/generated/MsgVpnProxy.go | 11 +- internal/broker/generated/MsgVpnQueue.go | 11 +- .../generated/MsgVpnQueueSubscription.go | 11 +- .../broker/generated/MsgVpnQueueTemplate.go | 11 +- internal/broker/generated/MsgVpnReplayLog.go | 11 +- .../MsgVpnReplayLogTopicFilterSubscription.go | 11 +- .../broker/generated/MsgVpnReplicatedTopic.go | 11 +- .../generated/MsgVpnRestDeliveryPoint.go | 11 +- .../MsgVpnRestDeliveryPointQueueBinding.go | 11 +- ...PointQueueBindingProtectedRequestHeader.go | 11 +- ...tDeliveryPointQueueBindingRequestHeader.go | 11 +- .../MsgVpnRestDeliveryPointRestConsumer.go | 11 +- ...tDeliveryPointRestConsumerOauthJwtClaim.go | 11 +- .../broker/generated/MsgVpnSequencedTopic.go | 11 +- .../generated/MsgVpnTelemetryProfile.go | 11 +- ...metryProfileReceiverAclConnectException.go | 11 +- .../MsgVpnTelemetryProfileTraceFilter.go | 11 +- ...TelemetryProfileTraceFilterSubscription.go | 11 +- .../broker/generated/MsgVpnTopicEndpoint.go | 11 +- .../generated/MsgVpnTopicEndpointTemplate.go | 11 +- internal/broker/generated/OauthProfile.go | 11 +- .../generated/OauthProfileAccessLevelGroup.go | 11 +- ...essLevelGroupMsgVpnAccessLevelException.go | 11 +- .../OauthProfileClientAllowedHost.go | 11 +- ...authProfileClientAuthorizationParameter.go | 11 +- .../OauthProfileClientRequiredClaim.go | 11 +- ...rofileDefaultMsgVpnAccessLevelException.go | 11 +- ...OauthProfileResourceServerRequiredClaim.go | 11 +- internal/broker/generated/VersionDetails.go | 5 +- internal/broker/generated/VirtualHostname.go | 11 +- internal/broker/provider.go | 44 +- internal/broker/resource.go | 153 +- internal/broker/schema.go | 419 +++-- internal/broker/sempversion.go | 5 +- internal/broker/testacc/datasource_test.go | 52 +- internal/broker/testacc/provider_test.go | 111 +- internal/broker/testacc/resource_test.go | 43 +- internal/broker/utilities.go | 10 +- internal/semp/client.go | 92 +- main.go | 4 + source-address.go | 1 + templates/guides/config-generator.md | 51 +- templates/guides/provider.md | 10 +- templates/index.md.tmpl | 4 +- third-party-licenses.txt | 1494 ++++++++--------- version.go | 2 +- 281 files changed, 5656 insertions(+), 5014 deletions(-) create mode 100644 .github/workflows/prep-internal-release.yml create mode 100644 .github/workflows/verify-registry-release.yml create mode 100644 ci/bigtest/test.tf rename ci/swagger_spec/{semp-v2-swagger-config-extended.10.4.1.40.json => semp-v2-swagger-config-extended.10.6.1.30.vm.json} (90%) create mode 100644 ci/whitesource/whitesource-agent.config diff --git a/.github/workflows/cli-test-pipeline.yml b/.github/workflows/cli-test-pipeline.yml index 9e39b683..14519d15 100644 --- a/.github/workflows/cli-test-pipeline.yml +++ b/.github/workflows/cli-test-pipeline.yml @@ -10,10 +10,10 @@ jobs: - name: Set up Go uses: actions/setup-go@v3 with: - go-version: "1.20" + go-version: "1.21" - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Terraform latest uses: hashicorp/setup-terraform@v2 @@ -21,8 +21,8 @@ jobs: - name: Setup Test broker run: | mkdir -p $HOME/solace; chmod 777 $HOME/solace - docker run -d -p 8080:8080 -p 55555:55555 --shm-size=1g --env username_admin_globalaccesslevel=admin --env username_admin_password=admin --name=solace \ - --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard + docker run -d -p 8080:8080 -p 55555:55555 --shm-size=1g --env username_admin_globalaccesslevel=admin --env username_admin_password=admin --env system_scaling_maxkafkabridgecount="10" --name=solace \ + --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.6.1.52" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Use local provider @@ -35,36 +35,10 @@ jobs: direct {} }" > ~/.terraformrc - - name: Checkout generator - uses: actions/checkout@v3 - with: - repository: SolaceDev/broker-terraform-provider-generator - token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT - path: broker-terraform-provider-generator - ref: "v0.1.0" - - - name: Build and install generator - run: | - pushd broker-terraform-provider-generator - go mod tidy - go install . - ls ~/go/bin - popd - - - name: Generate provider code - run: | - SWAGGER_SPEC_NAME=`ls ci/swagger_spec` - echo "Generating code using spec $SWAGGER_SPEC_NAME" - BASE=`pwd` - pushd internal/broker/generated - rm ./* - SEMP_V2_SWAGGER_CONFIG_EXTENDED_JSON="$BASE/ci/swagger_spec/$SWAGGER_SPEC_NAME" ~/go/bin/broker-terraform-provider-generator all - popd - - name: Build provider run: | - go mod tidy - go install . + make test-coverage + make install ls ~/go/bin terraform-provider-solacebroker -h @@ -136,7 +110,7 @@ jobs: run: | SOLACEBROKER_REGISTRY_OVERRIDE=registry.terraform.io/solaceproducts/solacebroker SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=admin terraform-provider-solacebroker generate --url=http://localhost:8080 solacebroker_msg_vpn.qn another messageVpn.tf cat messageVpn.tf - grep -o 'solacebroker_msg_vpn_queue ' messageVpn.tf | wc -l | grep 21 + grep -o 'solacebroker_msg_vpn_queue" ' messageVpn.tf | wc -l | grep 21 - name: Create custom messageVPN with large config run: | diff --git a/.github/workflows/core-pipeline-dev.yml b/.github/workflows/core-pipeline-dev.yml index cd454de6..68d922fc 100644 --- a/.github/workflows/core-pipeline-dev.yml +++ b/.github/workflows/core-pipeline-dev.yml @@ -1,4 +1,6 @@ name: Build Terraform Provider in Development phase +# Branch naming convention assumes dev branches start with "dev" then semver release name, +# internal QA release candidate branches start with "v" then semver release name. on: push: @@ -13,10 +15,10 @@ jobs: - name: Set up Go uses: actions/setup-go@v3 with: - go-version: "1.20" + go-version: "1.21" - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Terraform latest uses: hashicorp/setup-terraform@v2 @@ -24,12 +26,12 @@ jobs: terraform_wrapper: false - name: Checkout generator - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: SolaceDev/broker-terraform-provider-generator token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT path: broker-terraform-provider-generator - ref: "v0.1.0" + ref: "v0.2.0" - name: Build and install generator run: | @@ -51,24 +53,30 @@ jobs: - name: Build provider run: | - go mod tidy - go fmt - go install . + make dep + make fmt + make install ~/go/bin/terraform-provider-solacebroker version ~/go/bin/terraform-provider-solacebroker help - name: Test Provider and generate documentations run: | - make test-coverage + make testacc make generate-docs + - name: Ensure version reflects release candidate version + run: | + if echo "${{ github.ref_name }}" | grep ^dev || echo "${{ github.ref_name }}" | grep ^v ; then + VERSION=$(echo "${{ github.ref_name }}" | cut -d'v' -f2) + sed -i "s/version =.*$/version = \"${VERSION}\"/g" version.go + fi + - name: Check changed files - uses: tj-actions/verify-changed-files@v14 + uses: tj-actions/verify-changed-files@v16 id: check-changed-files with: files: | - internal/broker/generated - docs + !broker-terraform-provider-generator - name: Run step only when any of the above files change. if: steps.check-changed-files.outputs.files_changed == 'true' @@ -81,17 +89,19 @@ jobs: with: committer_name: GitHub Actions committer_email: actions@github.com - message: 'Updating generated source [skip ci]' - add: 'internal/broker/generated/*.go' + message: 'Updating generated source' + add: ". ':!broker-terraform-provider-generator'" new_branch: GeneratedSourceUpdates-${{ github.ref_name }} - # - name: Create pull request - # if: steps.check-changed-files.outputs.files_changed == 'true' - # run: | - # CURRENT_BRANCH=${GITHUB_REF_NAME} - # gh pr create -B ${CURRENT_BRANCH} -H "GeneratedSourceUpdates-${CURRENT_BRANCH}" --title "Merge generated source updates into ${CURRENT_BRANCH}" --body 'Created by Github action' - # env: - # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Create pull request + if: steps.check-changed-files.outputs.files_changed == 'true' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + CURRENT_BRANCH=${GITHUB_REF_NAME} + gh pr create -B ${CURRENT_BRANCH} -H "GeneratedSourceUpdates-${CURRENT_BRANCH}" --title "Merge generated source updates into ${CURRENT_BRANCH}" --body 'Created by Github action' + echo Review and approve PR before push can continue + exit 1 // force actions stop here Plugin-Integration-Test: needs: build diff --git a/.github/workflows/core-pipeline-main-branch-only.yml b/.github/workflows/core-pipeline-main-branch-only.yml index e5c6c071..d3350ea0 100644 --- a/.github/workflows/core-pipeline-main-branch-only.yml +++ b/.github/workflows/core-pipeline-main-branch-only.yml @@ -13,10 +13,10 @@ jobs: - name: Set up Go uses: actions/setup-go@v3 with: - go-version: "1.20" + go-version: "1.21" - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Terraform latest uses: hashicorp/setup-terraform@v2 @@ -25,11 +25,8 @@ jobs: - name: Build provider run: | - go mod tidy - go fmt - go install . + make install ~/go/bin/terraform-provider-solacebroker version - ~/go/bin/terraform-provider-solacebroker help Plugin-Integration-Test: needs: build diff --git a/.github/workflows/prep-internal-release.yml b/.github/workflows/prep-internal-release.yml new file mode 100644 index 00000000..bca04251 --- /dev/null +++ b/.github/workflows/prep-internal-release.yml @@ -0,0 +1,129 @@ +# Launched manually +on: + workflow_dispatch: + inputs: + release_branch_name: + description: 'Release branch name, must start with v' + required: true + default: 'v0.1.0-rc.1' + + +jobs: + build: + name: Prep release + runs-on: ubuntu-latest + steps: + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: "1.21" + + - name: Checkout the code + uses: actions/checkout@v2 + + - name: Check release version and set next version + run: | + if ! echo "${{ github.event.inputs.release_branch_name }}" | grep ^v ; then + echo "Incorrect release branch name ${{ github.event.inputs.release_branch_name }}, must start with 'v'" ; exit 1 + fi + if echo "${{ github.ref_name }}" | grep ^dev ; then + # set next dev version GH env, otherwise set it empty + echo "NEXT_DEV_VERSION=$(echo ${{ github.ref_name }} | awk -F. -v OFS=. '{$NF += 1 ; print}')" >> $GITHUB_ENV + fi + + - name: Code format, dependencies, checks + run: | + make fmt + make dep + make vet + + - name: Check code builds and pass acceptance test + run: | + make install + make testacc + + - name: Ensure all docs have been generated + run: make generate-docs + + - name: Ensure version reflects release candidate version + run: | + VERSION=$(echo "${{ github.event.inputs.release_branch_name }}" | cut -d'v' -f2) + sed -i "s/version =.*$/version = \"${VERSION}\"/g" version.go + + - name: Check changed files + uses: tj-actions/verify-changed-files@v14 + id: check-changed-files + + - name: Run step only when any of the files change + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + echo "Changed files: ${{ steps.check-changed-files.outputs.changed_files }}" + + - name: Commit back updates when any of the files change + if: steps.check-changed-files.outputs.files_changed == 'true' + uses: EndBug/add-and-commit@v9 + with: + committer_name: GitHub Actions + committer_email: actions@github.com + message: 'Updating release candidate [skip ci]' + new_branch: GeneratedSourceUpdates-${{ github.ref_name }} + + - name: Create pull request if needed, then break here because manual approval of the changes is required + if: steps.check-changed-files.outputs.files_changed == 'true' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + CURRENT_BRANCH=${GITHUB_REF_NAME} + gh pr create -B ${CURRENT_BRANCH} -H "GeneratedSourceUpdates-${CURRENT_BRANCH}" --title "Merge generated source updates into release candidate ${CURRENT_BRANCH}" --body 'Created by Github action' + echo Review and approve PR before release can continue + exit 1 // force actions stop here + + - name: Prep product release for Whitesource + run: | + VERSION=$(cat version.go | grep version | cut -d'=' -f2 | xargs) + sed -i "s/productVersion=.*$/productVersion=v${VERSION}/g" ci/whitesource/whitesource-agent.config + sed -i "s/productName=.*$/productName=${{ github.event.repository.name }}/g" ci/whitesource/whitesource-agent.config + sed -i "s/projectName=.*$/projectName=${{ github.event.repository.name }}/g" ci/whitesource/whitesource-agent.config + cat ci/whitesource/whitesource-agent.config | grep productVersion + + - name: Run Whitesource Action to update licenses + uses: SolaceDev/Mend-Scan-GHA@v1.0.0 + with: + wssURL: https://saas.whitesourcesoftware.com/agent + apiKey: ${{ secrets.WSS_API_KEY }} + productName: ${{ github.event.repository.name }} + projectName: ${{ github.event.repository.name }} + configFile: 'ci/whitesource/whitesource-agent.config' + + - name: Create the release branch + uses: peterjgrainger/action-create-branch@v2.4.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + branch: "${{ github.event.inputs.release_branch_name }}" + + # - name: Create next dev branch + # if: env.NEXT_DEV_VERSION != '' + # uses: peterjgrainger/action-create-branch@v2.4.0 + # env: + # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # with: + # branch: ${{ env.NEXT_DEV_VERSION }} + + - name: Create next dev branch + if: env.NEXT_DEV_VERSION != '' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + git checkout -b ${{ env.NEXT_DEV_VERSION }} + VERSION=$(echo "${{ env.NEXT_DEV_VERSION }}" | cut -d'v' -f2) + sed -i "s/version =.*$/version = \"${VERSION}\"/g" version.go + git commit -a -m "Uprev'd version to ${VERSION}" + git push --set-upstream origin ${{ env.NEXT_DEV_VERSION }} + + - name: Delete last dev branch + if: env.NEXT_DEV_VERSION != '' + uses: dawidd6/action-delete-branch@v3 + with: + github_token: ${{github.token}} + branches: "${{ github.ref_name }}" diff --git a/.github/workflows/provider-acceptance-test.yml b/.github/workflows/provider-acceptance-test.yml index 1c77e433..bd402fc2 100644 --- a/.github/workflows/provider-acceptance-test.yml +++ b/.github/workflows/provider-acceptance-test.yml @@ -11,10 +11,10 @@ jobs: - name: Set up Go uses: actions/setup-go@v3 with: - go-version: "1.20" + go-version: "1.21" - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Acceptance test run: | diff --git a/.github/workflows/provider-test-pipeline.yml b/.github/workflows/provider-test-pipeline.yml index 4c711e07..822daecb 100644 --- a/.github/workflows/provider-test-pipeline.yml +++ b/.github/workflows/provider-test-pipeline.yml @@ -10,10 +10,10 @@ jobs: - name: Set up Go uses: actions/setup-go@v3 with: - go-version: "1.20" + go-version: "1.21" - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Terraform latest uses: hashicorp/setup-terraform@v2 @@ -21,8 +21,8 @@ jobs: - name: Setup test broker run: | mkdir -p $HOME/solace; chmod 777 $HOME/solace - docker run -d -p 8080:8080 -p 55555:55555 --shm-size=1g --env username_admin_globalaccesslevel=admin --env username_admin_password=admin --name=solace \ - --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard + docker run -d -p 8080:8080 -p 55555:55555 --shm-size=1g --env username_admin_globalaccesslevel=admin --env username_admin_password=admin --env system_scaling_maxkafkabridgecount="10" --name=solace \ + --env system_scaling_maxconnectioncount="1000" --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.6.1.52" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Use local provider @@ -35,36 +35,10 @@ jobs: direct {} }" > ~/.terraformrc - - name: Checkout generator - uses: actions/checkout@v3 - with: - repository: SolaceDev/broker-terraform-provider-generator - token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT - path: broker-terraform-provider-generator - ref: "v0.1.0" - - - name: Build and install generator - run: | - pushd broker-terraform-provider-generator - go mod tidy - go install . - ls ~/go/bin - popd - - - name: Generate provider code - run: | - SWAGGER_SPEC_NAME=`ls ci/swagger_spec` - echo "Generating code using spec $SWAGGER_SPEC_NAME" - BASE=`pwd` - pushd internal/broker/generated - rm ./* - SEMP_V2_SWAGGER_CONFIG_EXTENDED_JSON="$BASE/ci/swagger_spec/$SWAGGER_SPEC_NAME" ~/go/bin/broker-terraform-provider-generator all - popd - - name: Build provider run: | go mod tidy - go install . + make install ls ~/go/bin - name: Check provider available @@ -95,33 +69,10 @@ jobs: rm terraform.tfstate* terraform import solacebroker_msg_vpn.newone new popd - - # - name: Check changed files - # uses: tj-actions/verify-changed-files@v14 - # id: check-changed-files - # with: - # files: | - # internal/broker/generated - - # - name: Run step only when any of the above files change. - # if: steps.check-changed-files.outputs.files_changed == 'true' - # run: | - # echo "Changed files: ${{ steps.check-changed-files.outputs.changed_files }}" - - # - name: Commit back any updated source code - # if: steps.check-changed-files.outputs.files_changed == 'true' - # uses: EndBug/add-and-commit@v9 - # with: - # committer_name: GitHub Actions - # committer_email: actions@github.com - # message: 'Updating generated source [skip ci]' - # add: 'internal/broker/generated/*.go' - # new_branch: GeneratedSourceUpdates-${{ github.ref_name }} - - # - name: Create pull request - # if: steps.check-changed-files.outputs.files_changed == 'true' - # run: | - # CURRENT_BRANCH=${GITHUB_REF_NAME} - # gh pr create -B ${CURRENT_BRANCH} -H "GeneratedSourceUpdates-${CURRENT_BRANCH}" --title "Merge generated source updates into ${CURRENT_BRANCH}" --body 'Created by Github action' - # env: - # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # larger config + pushd ci/bigtest + terraform plan + terraform apply -auto-approve + terraform plan + terraform destroy -auto-approve + popd diff --git a/.github/workflows/verify-registry-release.yml b/.github/workflows/verify-registry-release.yml new file mode 100644 index 00000000..31e483ea --- /dev/null +++ b/.github/workflows/verify-registry-release.yml @@ -0,0 +1,84 @@ +# Launched manually to test new relesse from registry +on: + workflow_dispatch: + inputs: + release_version: + description: 'The version of the release in the Terraform registry (expecting semver format)' + required: true + default: '0.1.0-rc.1' + public_release: + type: boolean + description: 'Check if this is a public release (from registry.terraform.io). Private release is from app.terraform.io' + required: true + default: false + +jobs: + build: + name: Verify registry release + runs-on: ubuntu-latest + steps: + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: "1.21" + + - name: Check out code + uses: actions/checkout@v4 + + - name: Setup test broker + run: | + mkdir -p $HOME/solace; chmod 777 $HOME/solace + docker run -d -p 8080:8080 -p 55555:55555 --shm-size=1g --env username_admin_globalaccesslevel=admin --env username_admin_password=admin --env system_scaling_maxkafkabridgecount="10" --name=solace \ + --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.6.1.52" + while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done + + - name: Set up Terraform latest - public + if: ${{ github.event.inputs.public_release != 'false' }} + uses: hashicorp/setup-terraform@v3 + with: + terraform_wrapper: true + + - name: Set up Terraform latest - private, with token + if: ${{ github.event.inputs.public_release == 'false' }} + uses: hashicorp/setup-terraform@v3 + with: + cli_config_credentials_token: ${{ secrets.TF_API_TOKEN }} + terraform_wrapper: true + + - name: Setup token and patch provider for private release + run: | + pushd ci/broker_vpn_q + if [ "${{ github.event.inputs.public_release }}" == "false" ] ; then + echo Internal release + sed -i "s@registry.terraform.io/solaceproducts@app.terraform.io/SolaceDev@g" testconfig.tf + else + echo Public release + fi + sed -i '/source = "/a \ \ \ \ \ \ version = "${{ github.event.inputs.release_version }}"' testconfig.tf + cat testconfig.tf + popd + + - name: Run init + run: | + pushd ci/broker_vpn_q + terraform init + $(find .terraform/ | grep terraform-provider) version | grep ${{ github.event.inputs.release_version }} + popd + + - name: Test basic provider + run: | + pushd ci/broker_vpn_q + terraform plan + sleep 1 + terraform apply -auto-approve + sleep 1 + terraform destroy -auto-approve + popd + + - name: Test basic config generator + run: | + pushd ci/broker_vpn_q + SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=admin $(find .terraform/ | grep terraform-provider) generate --url=http://localhost:8080 solacebroker_msg_vpn.test default messageVpn.tf + popd + + diff --git a/Makefile b/Makefile index dd0f8cf0..cf01b3c3 100644 --- a/Makefile +++ b/Makefile @@ -5,25 +5,28 @@ PKG_LIST := $(shell go list ./... | grep -v /vendor/) .PHONY: dep: ## Get the dependencies @go mod tidy - @go mod vendor .PHONY: vet: ## Run go vet @go vet ${PKG_LIST} +.PHONY: +fmt: ## Run gofmt + @gofmt -w -l . + .PHONY: test: ## Run unit tests @go test -short ${PKG_LIST} .PHONY: test-coverage: ## Run tests with coverage - mkdir -p reports + @mkdir -p reports @go test -short -coverprofile reports/cover.out ${PKG_LIST} @go tool cover -html reports/cover.out -o reports/cover.html .PHONY: testacc testacc: ## Run acceptance tests - TF_ACC=1 go test ./... -v $(TESTARGS) -timeout 120m + @TF_ACC=1 go test ./... -v $(TESTARGS) -timeout 120m .PHONY: generate-docs: dep ## Build the binary file diff --git a/README.md b/README.md index f90aef3f..5859c769 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,14 @@ Note that the provider also offers the unique ability to generate a config file Full documentation is available on the [Terraform Providers Registry website](https://registry.terraform.io/providers/solaceproducts/solacebroker/latest/docs). -It is recommended to familiarize yourself with Solace technology and broker management, refer to the [Resources section](#resources). +We recommended that you familiarize yourself with Solace technology and broker management. For more information, refer to the [Resources section](#resources). ## Development ### Requirements * [Terraform](https://www.terraform.io/downloads) (>= 1.0) -* [Go](https://go.dev/doc/install) (1.20) +* [Go](https://go.dev/doc/install) (1.21) * [Make](https://www.gnu.org/software/make/) ### Building diff --git a/ci/bigtest/test.tf b/ci/bigtest/test.tf new file mode 100644 index 00000000..b24b95bd --- /dev/null +++ b/ci/bigtest/test.tf @@ -0,0 +1,1195 @@ +terraform { + required_providers { + solacebroker = { + source = "registry.terraform.io/solaceproducts/solacebroker" + } + } +} + +provider "solacebroker" { + username = "admin" + password = "admin" + url = "http://localhost:8080" +} + +resource "solacebroker_broker" "broker" { + auth_client_cert_revocation_check_mode = "ocsp" + config_sync_authentication_client_cert_max_chain_depth = 4 + config_sync_authentication_client_cert_validate_date_enabled = false + config_sync_client_profile_tcp_initial_congestion_window = 3 + config_sync_client_profile_tcp_keepalive_count = 2 + config_sync_client_profile_tcp_keepalive_idle = 4 + config_sync_client_profile_tcp_keepalive_interval = 2 + config_sync_client_profile_tcp_max_window = 257 + config_sync_client_profile_tcp_mss = 256 + config_sync_enabled = true + config_sync_synchronize_username_enabled = false + config_sync_tls_enabled = true + guaranteed_msging_defragmentation_schedule_day_list = "Mon,Tue" + guaranteed_msging_defragmentation_schedule_enabled = true + guaranteed_msging_defragmentation_schedule_time_list = "23:59" + guaranteed_msging_defragmentation_threshold_enabled = true + guaranteed_msging_defragmentation_threshold_fragmentation_percentage = 30 + guaranteed_msging_defragmentation_threshold_min_interval = 16 + guaranteed_msging_defragmentation_threshold_usage_percentage = 30 + guaranteed_msging_enabled = true + guaranteed_msging_event_cache_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_delivered_unacked_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_disk_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_egress_flow_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_endpoint_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_ingress_flow_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_msg_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_msg_spool_file_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_msg_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_transacted_session_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_transacted_session_resource_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_event_transaction_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + guaranteed_msging_max_cache_usage = 11 + guaranteed_msging_max_msg_spool_usage = 1600 + guaranteed_msging_msg_spool_sync_mirrored_msg_ack_timeout = 10001 + guaranteed_msging_msg_spool_sync_mirrored_spool_file_ack_timeout = 10002 + guaranteed_msging_transaction_replication_compatibility_mode = "transacted" + oauth_profile_default = "test" + service_amqp_enabled = true + service_amqp_tls_listen_port = 10001 + service_event_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + service_health_check_enabled = true + service_health_check_listen_port = 10002 + service_health_check_tls_enabled = true + service_health_check_tls_listen_port = 10003 + service_mate_link_enabled = false + service_mate_link_listen_port = 10004 + service_mqtt_enabled = true + service_msg_backbone_enabled = false + service_redundancy_enabled = false + service_redundancy_first_listen_port = 10005 + service_rest_event_outgoing_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + service_rest_incoming_enabled = true + service_rest_outgoing_enabled = true + service_semp_cors_allow_any_host_enabled = true + service_semp_legacy_timeout_enabled = false + service_semp_plain_text_enabled = true + service_semp_session_idle_timeout = 16 + service_semp_session_max_lifetime = 43201 + service_semp_tls_enabled = true + service_smf_compression_listen_port = 10006 + service_smf_enabled = false + service_smf_event_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + service_smf_plain_text_listen_port = 10007 + service_smf_routing_control_listen_port = 10008 + service_smf_tls_listen_port = 10009 + service_tls_event_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + service_web_transport_plain_text_listen_port = 10010 + service_web_transport_tls_listen_port = 10011 + service_web_transport_web_url_suffix = "test" + tls_block_version11_enabled = true + tls_cipher_suite_management_list = "default" + tls_cipher_suite_msg_backbone_list = "default" + tls_cipher_suite_secure_shell_list = "default" + tls_crime_exploit_protection_enabled = false + tls_server_cert_content = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + tls_server_cert_password = "test" + tls_standard_domain_certificate_authorities_enabled = false + tls_ticket_lifetime = 1 + web_manager_allow_unencrypted_wizards_enabled = true + web_manager_customization = "test" + web_manager_redirect_http_enabled = false + web_manager_redirect_http_override_tls_port = 8080 +} + +resource "solacebroker_client_cert_authority" "client_cert_authority" { + cert_authority_name = "test" + cert_content = "-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + crl_day_list = "Wed,Fri" + crl_time_list = "8:54" + crl_url = "http://test1.com:4321" + ocsp_non_responder_cert_enabled = true + ocsp_override_url = "http://test2.com:3421" + ocsp_timeout = 8 + revocation_check_enabled = true + +} + +resource "solacebroker_client_cert_authority_ocsp_tls_trusted_common_name" "client_cert_authority_ocsp_tls_trusted_common_name" { + cert_authority_name = solacebroker_client_cert_authority.client_cert_authority.cert_authority_name + ocsp_tls_trusted_common_name = "test" +} + +resource "solacebroker_dmr_cluster" "dmr_cluster" { + dmr_cluster_name = "test" + authentication_basic_enabled = false + authentication_basic_password = "test" + authentication_basic_type = "none" + authentication_client_cert_content = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + authentication_client_cert_enabled = false + authentication_client_cert_password = "test" + direct_only_enabled = true + enabled = true + tls_server_cert_max_chain_depth = 4 + tls_server_cert_validate_date_enabled = false + tls_server_cert_validate_name_enabled = false +} + +resource "solacebroker_dmr_cluster_cert_matching_rule" "dmr_cluster_cert_matching_rule" { + dmr_cluster_name = solacebroker_dmr_cluster.dmr_cluster.dmr_cluster_name + rule_name = "test" + enabled = true +} + +resource "solacebroker_dmr_cluster_cert_matching_rule_attribute_filter" "dmr_cluster_cert_matching_rule_attribute_filter" { + dmr_cluster_name = solacebroker_dmr_cluster.dmr_cluster.dmr_cluster_name + rule_name = solacebroker_dmr_cluster_cert_matching_rule.dmr_cluster_cert_matching_rule.rule_name + filter_name = "test" + attribute_name = "test" + attribute_value = "test" + +} + +resource "solacebroker_dmr_cluster_cert_matching_rule_condition" "dmr_cluster_cert_matching_rule_condition" { + dmr_cluster_name = solacebroker_dmr_cluster.dmr_cluster.dmr_cluster_name + rule_name = solacebroker_dmr_cluster_cert_matching_rule.dmr_cluster_cert_matching_rule.rule_name + source = "uid" + expression = "test" +} + +resource "solacebroker_dmr_cluster_link" "dmr_cluster_link" { + dmr_cluster_name = solacebroker_dmr_cluster.dmr_cluster.dmr_cluster_name + remote_node_name = "test" + authentication_basic_password = "test" + authentication_scheme = "client-certificate" + client_profile_queue_control1_max_depth = 5 + client_profile_queue_control1_min_msg_burst = 5 + client_profile_queue_direct1_max_depth = 5 + client_profile_queue_direct1_min_msg_burst = 5 + client_profile_queue_direct2_max_depth = 5 + client_profile_queue_direct2_min_msg_burst = 5 + client_profile_queue_direct3_max_depth = 5 + client_profile_queue_direct3_min_msg_burst = 5 + client_profile_queue_guaranteed1_max_depth = 20001 + client_profile_queue_guaranteed1_min_msg_burst = 254 + client_profile_tcp_congestion_window_size = 34 + client_profile_tcp_keepalive_count = 4 + client_profile_tcp_keepalive_idle_time = 54 + client_profile_tcp_keepalive_interval = 2 + client_profile_tcp_max_segment_size = 1459 + client_profile_tcp_max_window_size = 254 + egress_flow_window_size = 254 + enabled = false + initiator = "local" + queue_dead_msg_queue = "test" + queue_event_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + queue_max_delivered_unacked_msgs_per_flow = 100000 + queue_max_msg_spool_usage = 700000 + queue_max_redelivery_count = 1 + queue_max_ttl = 1 + queue_reject_msg_to_sender_on_discard_behavior = "never" + queue_respect_ttl_enabled = true + span = "internal" + transport_compressed_enabled = true + transport_tls_enabled = true +} + +resource "solacebroker_dmr_cluster_link_attribute" "dmr_cluster_link_attribute" { + dmr_cluster_name = solacebroker_dmr_cluster.dmr_cluster.dmr_cluster_name + remote_node_name = solacebroker_dmr_cluster_link.dmr_cluster_link.remote_node_name + attribute_name = "test" + attribute_value = "test" +} + +resource "solacebroker_dmr_cluster_link_remote_address" "dmr_cluster_link_remote_address" { + dmr_cluster_name = solacebroker_dmr_cluster.dmr_cluster.dmr_cluster_name + remote_node_name = solacebroker_dmr_cluster_link.dmr_cluster_link.remote_node_name + remote_address = "192.168.1.1" +} + +resource "solacebroker_domain_cert_authority" "domain_cert_authority" { + cert_authority_name = "test" + cert_content = "-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" +} + +resource "solacebroker_msg_vpn" "msg_vpn" { + msg_vpn_name = "test" + alias = "test123" + authentication_basic_enabled = false + authentication_basic_profile_name = "" + authentication_basic_radius_domain = "test" + authentication_basic_type = "internal" + authentication_client_cert_allow_api_provided_username_enabled = true + authentication_client_cert_certificate_matching_rules_enabled = true + authentication_client_cert_enabled = true + authentication_client_cert_max_chain_depth = "4" + authentication_client_cert_revocation_check_mode = "allow-all" + authentication_client_cert_username_source = "uid" + authentication_client_cert_validate_date_enabled = false + authentication_kerberos_allow_api_provided_username_enabled = true + authentication_kerberos_enabled = true + authentication_oauth_default_profile_name = "test" + authentication_oauth_enabled = true + authorization_ldap_group_membership_attribute_name = "test" + authorization_ldap_trim_client_username_domain_enabled = true + authorization_profile_name = "default" + authorization_type = "ldap" + bridging_tls_server_cert_max_chain_depth = "4" + bridging_tls_server_cert_validate_date_enabled = false + bridging_tls_server_cert_validate_name_enabled = false + dmr_enabled = true + enabled = true + event_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_egress_flow_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_egress_msg_rate_threshold = { "clear_value" = 40, "set_value" = 50 } + event_endpoint_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_ingress_flow_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_ingress_msg_rate_threshold = { "clear_value" = 40, "set_value" = 50 } + event_log_tag = "test" + event_msg_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_publish_client_enabled = true + event_publish_msg_vpn_enabled = true + event_publish_subscription_mode = "on-with-format-v2" + event_publish_topic_format_mqtt_enabled = true + event_publish_topic_format_smf_enabled = false + event_service_amqp_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_service_mqtt_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_service_rest_incoming_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_service_smf_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_service_web_connection_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_subscription_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_transacted_session_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_transaction_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + export_subscriptions_enabled = true + jndi_enabled = true + max_connection_count = 1234 + max_egress_flow_count = 999 + max_endpoint_count = 999 + max_ingress_flow_count = 999 + max_msg_spool_usage = 1 + max_subscription_count = 999 + max_transacted_session_count = 999 + max_transaction_count = 999 + mqtt_retain_max_memory = 999 + replication_ack_propagation_interval_msg_count = 21 + replication_bridge_authentication_basic_client_username = "test" + replication_bridge_authentication_basic_password = "test" + replication_bridge_authentication_client_cert_content = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + replication_bridge_authentication_client_cert_password = "test" + replication_bridge_authentication_scheme = "client-certificate" + replication_bridge_compressed_data_enabled = true + replication_bridge_egress_flow_window_size = 254 + replication_bridge_retry_delay = 2 + replication_bridge_tls_enabled = true + replication_bridge_unidirectional_client_profile_name = "default" + replication_enabled = false + replication_queue_max_msg_spool_usage = "5999" + replication_queue_reject_msg_to_sender_on_discard_enabled = false + replication_reject_msg_when_sync_ineligible_enabled = true + replication_role = "active" + replication_transaction_mode = "sync" + rest_tls_server_cert_max_chain_depth = "4" + rest_tls_server_cert_validate_date_enabled = false + rest_tls_server_cert_validate_name_enabled = false + semp_over_msg_bus_admin_client_enabled = true + semp_over_msg_bus_admin_distributed_cache_enabled = true + semp_over_msg_bus_admin_enabled = true + semp_over_msg_bus_enabled = false + semp_over_msg_bus_show_enabled = true + service_amqp_max_connection_count = 100 + service_amqp_plain_text_enabled = true + service_amqp_plain_text_listen_port = 4567 + service_amqp_tls_enabled = true + service_amqp_tls_listen_port = 7654 + service_mqtt_authentication_client_cert_request = "always" + service_mqtt_max_connection_count = "102" + service_mqtt_plain_text_enabled = true + service_mqtt_plain_text_listen_port = 9876 + service_mqtt_tls_enabled = true + service_mqtt_tls_listen_port = 1573 + service_mqtt_tls_web_socket_enabled = true + service_mqtt_tls_web_socket_listen_port = 6294 + service_mqtt_web_socket_enabled = true + service_mqtt_web_socket_listen_port = 8234 + service_rest_incoming_authentication_client_cert_request = "never" + service_rest_incoming_authorization_header_handling = "forward" + service_rest_incoming_max_connection_count = 101 + service_rest_incoming_plain_text_enabled = true + service_rest_incoming_plain_text_listen_port = 4571 + service_rest_incoming_tls_enabled = true + service_rest_incoming_tls_listen_port = 8392 + service_rest_mode = "gateway" + service_rest_outgoing_max_connection_count = 202 + service_smf_max_connection_count = 303 + service_smf_plain_text_enabled = false + service_smf_tls_enabled = false + service_web_authentication_client_cert_request = "always" + service_web_max_connection_count = 404 + service_web_plain_text_enabled = false + service_web_tls_enabled = false + tls_allow_downgrade_to_plain_text_enabled = true +} + +resource "solacebroker_msg_vpn_acl_profile" "msg_vpn_acl_profile" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + acl_profile_name = "test" + client_connect_default_action = "allow" + publish_topic_default_action = "allow" + subscribe_share_name_default_action = "disallow" + subscribe_topic_default_action = "allow" +} + +resource "solacebroker_msg_vpn_acl_profile_client_connect_exception" "msg_vpn_acl_profile_client_connect_exception" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + acl_profile_name = solacebroker_msg_vpn_acl_profile.msg_vpn_acl_profile.acl_profile_name + client_connect_exception_address = "192.168.1.1/24" +} + +resource "solacebroker_msg_vpn_acl_profile_publish_topic_exception" "msg_vpn_acl_profile_publish_topic_exception" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + acl_profile_name = solacebroker_msg_vpn_acl_profile.msg_vpn_acl_profile.acl_profile_name + publish_topic_exception = "test1" + publish_topic_exception_syntax = "smf" +} + +resource "solacebroker_msg_vpn_acl_profile_subscribe_share_name_exception" "msg_vpn_acl_profile_subscribe_share_name_exception" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + acl_profile_name = solacebroker_msg_vpn_acl_profile.msg_vpn_acl_profile.acl_profile_name + subscribe_share_name_exception = "test3" + subscribe_share_name_exception_syntax = "mqtt" +} + +resource "solacebroker_msg_vpn_acl_profile_subscribe_topic_exception" "msg_vpn_acl_profile_subscribe_topic_exception" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + acl_profile_name = solacebroker_msg_vpn_acl_profile.msg_vpn_acl_profile.acl_profile_name + subscribe_topic_exception = "test4" + subscribe_topic_exception_syntax = "smf" +} + +resource "solacebroker_msg_vpn_authentication_oauth_profile" "msg_vpn_authentication_oauth_profile" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + oauth_profile_name = "test" + authorization_groups_claim_name = "test" + authorization_groups_claim_string_format = "space-delimited" + client_id = "test" + client_required_type = "test" + client_secret = "test" + client_validate_type_enabled = false + disconnect_on_token_expiration_enabled = false + enabled = true + endpoint_discovery = "https://dfsaf:3242" + endpoint_discovery_refresh_interval = 86399 + endpoint_introspection = "https://qsdfsd:4231" + endpoint_introspection_timeout = 2 + endpoint_jwks = "https://esafs:4225" + endpoint_jwks_refresh_interval = 86399 + endpoint_userinfo = "https://dsgfh:3261" + endpoint_userinfo_timeout = 2 + issuer = "test" + mqtt_username_validate_enabled = true + oauth_role = "resource-server" + resource_server_parse_access_token_enabled = false + resource_server_required_audience = "test" + resource_server_required_issuer = "test" + resource_server_required_scope = "test" + resource_server_required_type = "test" + resource_server_validate_audience_enabled = false + resource_server_validate_issuer_enabled = false + resource_server_validate_scope_enabled = false + resource_server_validate_type_enabled = false + username_claim_name = "test" +} + +resource "solacebroker_msg_vpn_authentication_oauth_profile_client_required_claim" "msg_vpn_authentication_oauth_profile_client_required_claim" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + oauth_profile_name = solacebroker_msg_vpn_authentication_oauth_profile.msg_vpn_authentication_oauth_profile.oauth_profile_name + client_required_claim_name = "test" + client_required_claim_value = "{\"test\":1}" +} + +resource "solacebroker_msg_vpn_authentication_oauth_profile_resource_server_required_claim" "msg_vpn_authentication_oauth_profile_resource_server_required_claim" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + oauth_profile_name = solacebroker_msg_vpn_authentication_oauth_profile.msg_vpn_authentication_oauth_profile.oauth_profile_name + resource_server_required_claim_name = "test" + resource_server_required_claim_value = "{\"test\":1}" +} + +resource "solacebroker_msg_vpn_authorization_group" "msg_vpn_authorization_group" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + authorization_group_name = "test" + acl_profile_name = "default" + client_profile_name = "default" + enabled = true + order_after_authorization_group_name = "test" +} + +resource "solacebroker_msg_vpn_bridge" "msg_vpn_bridge" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + bridge_name = "test" + bridge_virtual_router = "auto" + enabled = true + max_ttl = 11 + remote_authentication_basic_client_username = "test" + remote_authentication_basic_password = "test" + remote_authentication_client_cert_content = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + remote_authentication_client_cert_password = "test" + remote_authentication_scheme = "client-certificate" + remote_connection_retry_count = 1 + remote_connection_retry_delay = 2 + remote_deliver_to_one_priority = "p2" + tls_cipher_suite_list = "default" +} + +resource "solacebroker_msg_vpn_bridge_remote_msg_vpn" "msg_vpn_bridge_remote_msg_vpn" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + bridge_name = solacebroker_msg_vpn_bridge.msg_vpn_bridge.bridge_name + bridge_virtual_router = solacebroker_msg_vpn_bridge.msg_vpn_bridge.bridge_virtual_router + remote_msg_vpn_interface = "" + remote_msg_vpn_location = "192.168.1.1:1234" + remote_msg_vpn_name = "default" + client_username = "test" + compressed_data_enabled = true + connect_order = 3 + egress_flow_window_size = 254 + enabled = true + password = "test" + queue_binding = "test" + tls_enabled = true + unidirectional_client_profile = "default" +} + +resource "solacebroker_msg_vpn_bridge_remote_subscription" "msg_vpn_bridge_remote_subscription" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + bridge_name = solacebroker_msg_vpn_bridge.msg_vpn_bridge.bridge_name + bridge_virtual_router = solacebroker_msg_vpn_bridge.msg_vpn_bridge.bridge_virtual_router + remote_subscription_topic = "test" + deliver_always_enabled = true +} + +resource "solacebroker_msg_vpn_cert_matching_rule" "msg_vpn_cert_matching_rule" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rule_name = "test" + enabled = true +} + +resource "solacebroker_msg_vpn_cert_matching_rule_attribute_filter" "msg_vpn_cert_matching_rule_attribute_filter" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rule_name = solacebroker_msg_vpn_cert_matching_rule.msg_vpn_cert_matching_rule.rule_name + filter_name = "test" + attribute_name = "test" + attribute_value = "test" +} + +resource "solacebroker_msg_vpn_cert_matching_rule_condition" "msg_vpn_cert_matching_rule_condition" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rule_name = solacebroker_msg_vpn_cert_matching_rule.msg_vpn_cert_matching_rule.rule_name + source = "uid" + expression = "test" +} + +resource "solacebroker_msg_vpn_client_profile" "msg_vpn_client_profile" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + client_profile_name = "test" + allow_bridge_connections_enabled = true + allow_guaranteed_endpoint_create_durability = "durable" + allow_guaranteed_endpoint_create_enabled = true + allow_guaranteed_msg_receive_enabled = true + allow_guaranteed_msg_send_enabled = true + allow_shared_subscriptions_enabled = true + allow_transacted_sessions_enabled = true + api_queue_management_copy_from_on_create_template_name = "test" + api_topic_endpoint_management_copy_from_on_create_template_name = "test" + compression_enabled = true + eliding_delay = 1 + eliding_enabled = true + eliding_max_topic_count = 255 + event_client_provisioned_endpoint_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_connection_count_per_client_username_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_egress_flow_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_endpoint_count_per_client_username_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_ingress_flow_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_service_smf_connection_count_per_client_username_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_service_web_connection_count_per_client_username_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_subscription_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_transacted_session_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_transaction_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + max_connection_count_per_client_username = 999 + max_egress_flow_count = 999 + max_endpoint_count_per_client_username = 999 + max_ingress_flow_count = 999 + max_msgs_per_transaction = 5 + max_subscription_count = 99 + max_transacted_session_count = 9 + max_transaction_count = 9 + queue_control1_max_depth = 999 + queue_control1_min_msg_burst = 3 + queue_direct1_max_depth = 999 + queue_direct1_min_msg_burst = 3 + queue_direct2_max_depth = 999 + queue_direct2_min_msg_burst = 3 + queue_direct3_max_depth = 999 + queue_direct3_min_msg_burst = 3 + queue_guaranteed1_max_depth = 999 + queue_guaranteed1_min_msg_burst = 254 + reject_msg_to_sender_on_no_subscription_match_enabled = true + replication_allow_client_connect_when_standby_enabled = true + service_min_keepalive_timeout = 29 + service_smf_max_connection_count_per_client_username = 99 + service_smf_min_keepalive_enabled = true + service_web_inactive_timeout = 9 + service_web_max_connection_count_per_client_username = 99 + service_web_max_payload = 99999 + tcp_congestion_window_size = 3 + tcp_keepalive_count = 2 + tcp_keepalive_idle_time = 3 + tcp_keepalive_interval = 2 + tcp_max_segment_size = 1459 + tcp_max_window_size = 255 + tls_allow_downgrade_to_plain_text_enabled = false +} + +resource "solacebroker_msg_vpn_client_username" "msg_vpn_client_username" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + client_username = "test" + acl_profile_name = solacebroker_msg_vpn_acl_profile.msg_vpn_acl_profile.acl_profile_name + client_profile_name = solacebroker_msg_vpn_client_profile.msg_vpn_client_profile.client_profile_name + enabled = true + guaranteed_endpoint_permission_override_enabled = true + password = "test" + subscription_manager_enabled = true +} + +resource "solacebroker_msg_vpn_client_username_attribute" "msg_vpn_client_username_attribute" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + client_username = solacebroker_msg_vpn_client_username.msg_vpn_client_username.client_username + attribute_name = "test" + attribute_value = "test" +} + +resource "solacebroker_msg_vpn_distributed_cache" "msg_vpn_distributed_cache" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + cache_name = "test" + cache_virtual_router = "auto" + enabled = true + heartbeat = 11 + scheduled_delete_msg_day_list = "Thu,Fri" + scheduled_delete_msg_time_list = "3:59,4:59,13:59,23:59" +} + +resource "solacebroker_msg_vpn_distributed_cache_cluster" "msg_vpn_distributed_cache_cluster" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + cache_name = solacebroker_msg_vpn_distributed_cache.msg_vpn_distributed_cache.cache_name + cluster_name = "test1" + deliver_to_one_override_enabled = false + enabled = true + event_data_byte_rate_threshold = { "clear_value" = 40, "set_value" = 50 } + event_data_msg_rate_threshold = { "clear_value" = 40, "set_value" = 50 } + event_max_memory_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_max_topics_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_request_queue_depth_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_request_rate_threshold = { "clear_value" = 40, "set_value" = 50 } + event_response_rate_threshold = { "clear_value" = 40, "set_value" = 50 } + global_caching_enabled = true + global_caching_heartbeat = 4 + global_caching_topic_lifetime = 3599 + max_memory = 2047 + max_msgs_per_topic = 2 + max_request_queue_depth = 99999 + max_topic_count = 99999 + msg_lifetime = 4 + new_topic_advertisement_enabled = true +} + +resource "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_cluster" "msg_vpn_distributed_cache_cluster_global_caching_home_cluster" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + cache_name = solacebroker_msg_vpn_distributed_cache.msg_vpn_distributed_cache.cache_name + cluster_name = solacebroker_msg_vpn_distributed_cache_cluster.msg_vpn_distributed_cache_cluster.cluster_name + home_cluster_name = "test2" +} + +resource "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix" "msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + cache_name = solacebroker_msg_vpn_distributed_cache.msg_vpn_distributed_cache.cache_name + cluster_name = solacebroker_msg_vpn_distributed_cache_cluster.msg_vpn_distributed_cache_cluster.cluster_name + home_cluster_name = solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_cluster.msg_vpn_distributed_cache_cluster_global_caching_home_cluster.home_cluster_name + topic_prefix = "test3" +} + +resource "solacebroker_msg_vpn_distributed_cache_cluster_instance" "msg_vpn_distributed_cache_cluster_instance" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + cache_name = solacebroker_msg_vpn_distributed_cache.msg_vpn_distributed_cache.cache_name + cluster_name = solacebroker_msg_vpn_distributed_cache_cluster.msg_vpn_distributed_cache_cluster.cluster_name + instance_name = "test4" + auto_start_enabled = true + enabled = true + stop_on_lost_msg_enabled = false +} + +resource "solacebroker_msg_vpn_distributed_cache_cluster_topic" "msg_vpn_distributed_cache_cluster_topic" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + cache_name = solacebroker_msg_vpn_distributed_cache.msg_vpn_distributed_cache.cache_name + cluster_name = solacebroker_msg_vpn_distributed_cache_cluster.msg_vpn_distributed_cache_cluster.cluster_name + topic = "test" +} + +resource "solacebroker_msg_vpn_dmr_bridge" "msg_vpn_dmr_bridge" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + remote_node_name = "test" + remote_msg_vpn_name = "test" +} + +resource "solacebroker_msg_vpn_jndi_connection_factory" "msg_vpn_jndi_connection_factory" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + connection_factory_name = "test" + allow_duplicate_client_id_enabled = true + client_description = "test" + client_id = "test" + dto_receive_override_enabled = false + dto_receive_subscriber_local_priority = 2 + dto_receive_subscriber_network_priority = 2 + dto_send_enabled = true + dynamic_endpoint_create_durable_enabled = true + dynamic_endpoint_respect_ttl_enabled = false + guaranteed_receive_ack_timeout = 999 + guaranteed_receive_reconnect_retry_count = 1 + guaranteed_receive_reconnect_retry_wait = 2999 + guaranteed_receive_window_size = 17 + guaranteed_receive_window_size_ack_threshold = 59 + guaranteed_send_ack_timeout = 1999 + guaranteed_send_window_size = 254 + messaging_default_delivery_mode = "non-persistent" + messaging_default_dmq_eligible_enabled = true + messaging_default_eliding_eligible_enabled = true + messaging_jmsx_user_id_enabled = true + messaging_text_in_xml_payload_enabled = false + transport_compression_level = 0 + transport_connect_retry_count = -1 + transport_connect_retry_per_host_count = -1 + transport_connect_timeout = 2999 + transport_direct_transport_enabled = false + transport_keepalive_count = 4232 + transport_keepalive_enabled = false + transport_keepalive_interval = 2999 + transport_msg_callback_on_io_thread_enabled = true + transport_optimize_direct_enabled = true + transport_port = 4214 + transport_read_timeout = 9999 + transport_receive_buffer_size = 9999 + transport_reconnect_retry_count = -1 + transport_reconnect_retry_wait = 2999 + transport_send_buffer_size = 65533 + transport_tcp_no_delay_enabled = false + xa_enabled = true +} + +resource "solacebroker_msg_vpn_jndi_queue" "msg_vpn_jndi_queue" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + queue_name = "test1" + physical_name = "test1" +} + +resource "solacebroker_msg_vpn_jndi_topic" "msg_vpn_jndi_topic" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + topic_name = "test2" + physical_name = "test2" +} + +resource "solacebroker_msg_vpn_kafka_receiver" "msg_vpn_kafka_receiver" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + kafka_receiver_name = "test" + authentication_basic_password = "test" + authentication_basic_username = "test" + authentication_client_cert_content = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + authentication_client_cert_password = "test" + authentication_oauth_client_id = "test" + authentication_oauth_client_scope = "test" + authentication_oauth_client_secret = "test" + authentication_oauth_client_token_endpoint = "https://test1:3224" + authentication_scheme = "basic" + authentication_scram_hash = "sha-256" + authentication_scram_password = "test" + authentication_scram_username = "test" + batch_delay = 501 + batch_max_size = 2 + bootstrap_address_list = "test" + enabled = true + group_id = "test" + group_keepalive_interval = 3001 + group_keepalive_timeout = 45499 + group_membership_type = "static" + group_partition_scheme_list = "cooperative-sticky" + metadata_topic_exclude_list = "test" + metadata_topic_refresh_interval = "29999" + transport_tls_enabled = true +} + +resource "solacebroker_msg_vpn_kafka_receiver_topic_binding" "msg_vpn_kafka_receiver_topic_binding" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + kafka_receiver_name = solacebroker_msg_vpn_kafka_receiver.msg_vpn_kafka_receiver.kafka_receiver_name + topic_name = "test" + enabled = true + initial_offset = "beginning" + local_key = "test" + local_topic = "test" +} + +resource "solacebroker_msg_vpn_kafka_sender" "msg_vpn_kafka_sender" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + kafka_sender_name = "test" + authentication_basic_password = "test" + authentication_basic_username = "test" + authentication_client_cert_content = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + authentication_client_cert_password = "test" + authentication_oauth_client_id = "test" + authentication_oauth_client_scope = "test" + authentication_oauth_client_secret = "test" + authentication_oauth_client_token_endpoint = "https://test:3222" + authentication_scheme = "basic" + authentication_scram_hash = "sha-256" + authentication_scram_password = "test" + authentication_scram_username = "test" + batch_delay = 501 + batch_max_msg_count = 9999 + batch_max_size = 2 + bootstrap_address_list = "test" + enabled = true + idempotence_enabled = true + transport_compression_enabled = true + transport_compression_level = 0 + transport_compression_type = "lz4" + transport_tls_enabled = true +} + +resource "solacebroker_msg_vpn_kafka_sender_queue_binding" "msg_vpn_kafka_sender_queue_binding" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + kafka_sender_name = solacebroker_msg_vpn_kafka_sender.msg_vpn_kafka_sender.kafka_sender_name + queue_name = "test" + ack_mode = "none" + enabled = true + partition_consistent_hash = "murmur2" + partition_explicit_number = 1 + partition_random_fallback_enabled = false + partition_scheme = "random" + remote_key = "test" + remote_topic = "test" +} + +resource "solacebroker_msg_vpn_mqtt_retain_cache" "msg_vpn_mqtt_retain_cache" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + cache_name = "test" + enabled = true + msg_lifetime = 4 +} + +resource "solacebroker_msg_vpn_mqtt_session" "msg_vpn_mqtt_session" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + mqtt_session_client_id = "test" + mqtt_session_virtual_router = "auto" + enabled = true + owner = "test" + queue_consumer_ack_propagation_enabled = false + queue_dead_msg_queue = "test" + queue_event_bind_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + queue_event_msg_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + queue_event_reject_low_priority_msg_limit_threshold = { "clear_percent" = 40, "set_percent" = 50 } + queue_max_delivered_unacked_msgs_per_flow = 9999 + queue_max_msg_size = 999999 + queue_max_msg_spool_usage = 999 + queue_max_redelivery_count = 1 + queue_max_ttl = 1 + queue_reject_low_priority_msg_enabled = true + queue_reject_low_priority_msg_limit = 1 + queue_reject_msg_to_sender_on_discard_behavior = "always" + queue_respect_ttl_enabled = true +} + +resource "solacebroker_msg_vpn_mqtt_session_subscription" "msg_vpn_mqtt_session_subscription" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + mqtt_session_client_id = solacebroker_msg_vpn_mqtt_session.msg_vpn_mqtt_session.mqtt_session_client_id + mqtt_session_virtual_router = solacebroker_msg_vpn_mqtt_session.msg_vpn_mqtt_session.mqtt_session_virtual_router + subscription_topic = "test" + subscription_qos = 1 +} + +resource "solacebroker_msg_vpn_proxy" "msg_vpn_proxy" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + proxy_name = "test" + authentication_scheme = "basic" + authentication_basic_username = "test" + authentication_basic_password = "test" + enabled = true + host = "192.168.1.1" + port = "12345" + proxy_type = "http" +} + +resource "solacebroker_msg_vpn_queue" "msg_vpn_queue" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + queue_name = "test" + access_type = "non-exclusive" + consumer_ack_propagation_enabled = false + dead_msg_queue = "test1" + delivery_count_enabled = true + delivery_delay = "1" + egress_enabled = true + event_bind_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_msg_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_reject_low_priority_msg_limit_threshold = { "clear_percent" = 40, "set_percent" = 50 } + ingress_enabled = true + max_bind_count = 999 + max_delivered_unacked_msgs_per_flow = 999 + max_msg_size = 999 + max_msg_spool_usage = 9999 + max_redelivery_count = 9 + max_ttl = 9 + owner = "test" + partition_count = 1 + partition_rebalance_delay = 6 + partition_rebalance_max_handoff_time = 4 + permission = "consume" + redelivery_delay_enabled = true + redelivery_delay_initial_interval = 999 + redelivery_delay_max_interval = 9999 + redelivery_delay_multiplier = 199 + redelivery_enabled = true + reject_low_priority_msg_enabled = true + reject_low_priority_msg_limit = 1 + reject_msg_to_sender_on_discard_behavior = "always" + respect_msg_priority_enabled = true + respect_ttl_enabled = true +} + +resource "solacebroker_msg_vpn_queue_subscription" "msg_vpn_queue_subscription" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + queue_name = solacebroker_msg_vpn_queue.msg_vpn_queue.queue_name + subscription_topic = "test" +} + +resource "solacebroker_msg_vpn_queue_template" "msg_vpn_queue_template" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + queue_template_name = "test" + access_type = "non-exclusive" + consumer_ack_propagation_enabled = false + dead_msg_queue = "test1" + delivery_delay = "1" + durability_override = "non-durable" + event_bind_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_msg_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_reject_low_priority_msg_limit_threshold = { "clear_percent" = 40, "set_percent" = 50 } + max_bind_count = 999 + max_delivered_unacked_msgs_per_flow = 999 + max_msg_size = 999 + max_msg_spool_usage = 9999 + max_redelivery_count = 0 + max_ttl = 9 + permission = "consume" + queue_name_filter = "test" + redelivery_delay_enabled = true + redelivery_delay_initial_interval = 1 + redelivery_delay_max_interval = 1 + redelivery_delay_multiplier = 100 + redelivery_enabled = true + reject_low_priority_msg_enabled = true + reject_low_priority_msg_limit = 1 + reject_msg_to_sender_on_discard_behavior = "always" + respect_msg_priority_enabled = true + respect_ttl_enabled = true +} + +resource "solacebroker_msg_vpn_replay_log" "msg_vpn_replay_log" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + replay_log_name = "test" + egress_enabled = true + ingress_enabled = true + max_spool_usage = 100 + topic_filter_enabled = true +} + +resource "solacebroker_msg_vpn_replay_log_topic_filter_subscription" "msg_vpn_replay_log_topic_filter_subscription" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + replay_log_name = solacebroker_msg_vpn_replay_log.msg_vpn_replay_log.replay_log_name + topic_filter_subscription = "test" +} + +resource "solacebroker_msg_vpn_replicated_topic" "msg_vpn_replicated_topic" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + replicated_topic = "test" + replication_mode = "sync" +} + +resource "solacebroker_msg_vpn_rest_delivery_point" "msg_vpn_rest_delivery_point" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rest_delivery_point_name = "test" + client_profile_name = "default" + enabled = true + service = "test" + vendor = "test" +} + +resource "solacebroker_msg_vpn_rest_delivery_point_queue_binding" "msg_vpn_rest_delivery_point_queue_binding" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rest_delivery_point_name = solacebroker_msg_vpn_rest_delivery_point.msg_vpn_rest_delivery_point.rest_delivery_point_name + queue_binding_name = "test" + gateway_replace_target_authority_enabled = true + post_request_target = "test" + request_target_evaluation = "substitution-expressions" +} + +resource "solacebroker_msg_vpn_rest_delivery_point_queue_binding_protected_request_header" "msg_vpn_rest_delivery_point_queue_binding_protected_request_header" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rest_delivery_point_name = solacebroker_msg_vpn_rest_delivery_point.msg_vpn_rest_delivery_point.rest_delivery_point_name + queue_binding_name = solacebroker_msg_vpn_rest_delivery_point_queue_binding.msg_vpn_rest_delivery_point_queue_binding.queue_binding_name + header_name = "test6" + header_value = "test" +} + +resource "solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_header" "msg_vpn_rest_delivery_point_queue_binding_request_header" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rest_delivery_point_name = solacebroker_msg_vpn_rest_delivery_point.msg_vpn_rest_delivery_point.rest_delivery_point_name + queue_binding_name = solacebroker_msg_vpn_rest_delivery_point_queue_binding.msg_vpn_rest_delivery_point_queue_binding.queue_binding_name + header_name = "test5" + header_value = "test" +} + +resource "solacebroker_msg_vpn_rest_delivery_point_rest_consumer" "msg_vpn_rest_delivery_point_rest_consumer" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rest_delivery_point_name = solacebroker_msg_vpn_rest_delivery_point.msg_vpn_rest_delivery_point.rest_delivery_point_name + rest_consumer_name = "test" + authentication_aws_access_key_id = "test" + authentication_aws_region = "test" + authentication_aws_secret_access_key = "test" + authentication_aws_service = "test" + authentication_client_cert_content = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nMIIIAjCCBuqgAwIBAgIJALYF/Umvsgf3MA0GCSqGSIb3DQEBCwUAME8xCzAJBgNV\nBAYTAkNBMRAwDgYDVQQIDAdPbnRhcmlvMQ8wDQYDVQQHDAZPdHRhd2ExDzANBgNV\nBAoMBlNvbGFjZTEMMAoGA1UEAwwDYWZ3MCAXDTIzMDMwNzE3MDExMloYDzIxMjMw\nMjExMTcwMTEyWjB1MQswCQYDVQQGEwJDQTEQMA4GA1UECAwHT250YXJpbzEPMA0G\nA1UEBwwGT3R0YXdhMQ8wDQYDVQQKDAZTb2xhY2UxDDAKBgNVBAMMA2FmdzEkMCIG\nCSqGSIb3DQEJARYVdm1yLTEzMi05NkBzb2xhY2UuY29tMIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEA3N43XQcQGfLiH8XqxaT5kuu8WDtDxMjHz9LMkOwK\nGdFyRsh75f7eLDhGa9WtBeadE1cOZc5pMwT5Nfh4xme3hoEjLWB3tkIRzR3ciyTh\nmzHeK8478obZ465XjyPrnJ+qbobTDhshfQo/IpnpsuR8RdogztWUbIEuLAN0hn5/\nAMS+U5OGgfI+70IWcBLWVkUdoB9LFQQFxLJrlMul5fkmjOnYQ6xJdyjgYpMS/mOW\nsf8iUqfZu0Xlr8xTi3dzxJEZD6m39IUiB/0aMpKFRTe2ibvPW3/FTlle3ArlUPuA\nG6ZB2iTLKm9sENq1UkORjmYY6gQhq6GwPhL4PPWXURwE5wIDAQABo4IEtzCCBLMw\nCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwggSXBgNVHREEggSOMIIEiocEwKiEYIcQ\n/YAAAAAAASgBkgFoATIAloIEZTk2bYIJZTk2bS5pcHY0ggllOTZtLmlwdjaCgf1l\nOTZtLmNvbS5zb2xhY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5C\nYmJiYmJiYmJiLkNjY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZm\nZmZmZmYuR2dnZ2dnZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampq\nai5La2tra2tra2trLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9v\nb29vb29vb28uUHBwcHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nz\nc3Nzcy5UdHR0dHR0goH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNs\nb3VkLkFhYWFhYWFhYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQu\nRWVlZWVlZWVlZS5GZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlp\naWlpaWlpLkpqampqampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1t\nbW0uTm5ubm5ubm5ubi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5S\ncnJycnJycnJyLlNzc3Nzc3Nzc3MuVHR0dHR0dIIMZTk2bS5zb2x0ZXN0ghFlOTZt\nLmlwdjQuc29sdGVzdIIRZTk2bS5pcHY2LnNvbHRlc3SCgf1lOTZtLmNvbS5zb2xh\nY2UtdGVzdC52bXItbXVsdGktY2xvdWQuQWFhYWFhYWFhYS5CYmJiYmJiYmJiLkNj\nY2NjY2NjY2MuRGRkZGRkZGRkZC5FZWVlZWVlZWVlLkZmZmZmZmZmZmYuR2dnZ2dn\nZ2dnZy5IaGhoaGhoaGhoLklpaWlpaWlpaWkuSmpqampqampqai5La2tra2tra2tr\nLkxsbGxsbGxsbGwuTW1tbW1tbW1tbS5Obm5ubm5ubm5uLk9vb29vb29vb28uUHBw\ncHBwcHBwcC5RcXFxcXFxcXFxLlJycnJycnJycnIuU3Nzc3Nzc3Nzcy5zb2x0ZXN0\ngoH9ZTk2bS5jb20uc29sYWNlLXRlc3Qudm1yLW11bHRpLWNsb3VkLkFhYWFhYWFh\nYWEuQmJiYmJiYmJiYi5DY2NjY2NjY2NjLkRkZGRkZGRkZGQuRWVlZWVlZWVlZS5G\nZmZmZmZmZmZmLkdnZ2dnZ2dnZ2cuSGhoaGhoaGhoaC5JaWlpaWlpaWlpLkpqampq\nampqamouS2tra2tra2tray5MbGxsbGxsbGxsLk1tbW1tbW1tbW0uTm5ubm5ubm5u\nbi5Pb29vb29vb29vLlBwcHBwcHBwcHAuUXFxcXFxcXFxcS5ScnJycnJycnJyLlNz\nc3Nzc3Nzc3Muc29sdGVzdIIKdm1yLTEzMi05NoIUdm1yLTEzMi05Ni5zb2wtbG9j\nYWwwDQYJKoZIhvcNAQELBQADggEBALw9t+131ytbltmPk8LKmYNo/tWWsJgwcxGu\npzconod45Ibia2Sep1yNll2Oqx1/Te6vk93WmHnP2F01N/o9mWZSMbsw2mxWi+EJ\nd5TSvr14Elb7/6bsc8b82SF3UIFVlBe2ng3M6a0r/g3UG2Nq7O4EoRwt8msIUfI+\nW2k1YOOplaejxKwbIOxBe4qpagdwtwOWvmjM//IrRCI+GiXZ7UfO5nG0Dzy85lX2\n80mOjL5WX1c9QalW/c4tU/W2gBXt+/GlZ9M0WFSmiBfexSp75G8/tVCfbwV+XUBw\nX8aEQnKCo/w72bD2C52Di/OnxteRT+NFdNMafngPpPTHk9hnRgU=\n-----END CERTIFICATE-----" + authentication_client_cert_password = "test" + authentication_http_basic_password = "test" + authentication_http_basic_username = "test" + authentication_http_header_name = "test" + authentication_http_header_value = "test" + authentication_oauth_client_id = "test" + authentication_oauth_client_scope = "test" + authentication_oauth_client_secret = "test" + authentication_oauth_client_token_endpoint = "https://192.168.1.1:8324" + authentication_oauth_client_token_expiry_default = 899 + authentication_oauth_jwt_secret_key = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDc3jddBxAZ8uIf\nxerFpPmS67xYO0PEyMfP0syQ7AoZ0XJGyHvl/t4sOEZr1a0F5p0TVw5lzmkzBPk1\n+HjGZ7eGgSMtYHe2QhHNHdyLJOGbMd4rzjvyhtnjrlePI+ucn6puhtMOGyF9Cj8i\nmemy5HxF2iDO1ZRsgS4sA3SGfn8AxL5Tk4aB8j7vQhZwEtZWRR2gH0sVBAXEsmuU\ny6Xl+SaM6dhDrEl3KOBikxL+Y5ax/yJSp9m7ReWvzFOLd3PEkRkPqbf0hSIH/Roy\nkoVFN7aJu89bf8VOWV7cCuVQ+4AbpkHaJMsqb2wQ2rVSQ5GOZhjqBCGrobA+Evg8\n9ZdRHATnAgMBAAECggEAJR5bY5D6TcIZ6okSiaDOKLjhcFqVaw7rNawRoRFqKSif\n8fFjkSWiJQBYJWtFpsY5A7UPwGBOIbrmPwHBGmb32uz9AnVB6Sl1YGlyVRgfqjtZ\nQTdpr7qmB7OXF4FL6YiT1ftmoOpCWIdOUPxY4C2yDPM5rEkMpqeXIOJ7xNahdXlL\nLm+E0qxy2yt3khGhhKeObIiYpiln6z3VrRk5GA9U8aq0HP15IXBlxbfT9uzBZfbs\n4KlHCMOYEDE2+5r5R38kRCgMjkOuNAo38oMRIeEVlzbvq85WWFHs1kt/N8855zLt\nyDbnIn8SY6+fxeCGpecDef45Qb4xfAmRDLTLyJOFMQKBgQDuIPrW+YzGacBBLDWM\nzISw3jf9JsR4IWCD3zeSUAYjkHYwnBnyXfqZyGaMaQrE7GE16Wl20wVjEHeTJgdR\n+NZZ8ZpmHAHjfifSUjxn7t7M9Qo6VTp8W5LoaSs2HY4ylsSOK6RUPkXEIKAGvf7I\nf3VvdjJuWo0X04HPoC7u/rwMqwKBgQDtcZ2VfvoBYtIk6CpfAhRmhrPo2hJpyDB1\ny9MPmsYhCiB+/HcYsUt8zXUlCaOP1m/5tz58hSzTytvoB60Z+aXtG9I4XS3Wjhmd\nrEtuV0WiCA92vqKUVXWYnGy8L8pr6UXPgBezFvjHQKZzIoKByPCJckrEqCl8VUxh\nUcAvPVUwtQKBgHJxxTxWORMOtghcf+wISulaE1yGKjx2BhW6zNFzxk+HWVYpX8r8\n4bjQ+IAY58UWue2YHUivSFKBEobU6wW5awNVO1hBs6Kq+eZ6AXAN/GRSjDTWy0ID\nHMq36L2cXL/xd8vAK70VJKCK8X3sCCxCHaWRD9G7kT3XN/caTBQutx/7AoGAMB4j\nIiWOQnOlRGdsFr7UJYbMtLZknt07vNNmXTYvSojD1xgQhod/VbZJNA1FASQiowdY\neWF/mRf2AopzsNzfnDJUIqn3XRCE7mf5DU5QRSq+/4BYcBj1cMzaWDSTH9UxGYDK\nzLcuCSr30ENBEU4IOMJZlorBhXm/tcUcXjZeqjUCgYEAwpOFx8KHazph2ial9954\ndq0IZZrhrLPoaLQVwLnUITpvKw1ORxdzLH8VNvRTcPF6XRt7BcV8aRcENW7R0Ozd\nQa4T12AxqCFp2tdD7juOMJoFVwr5Cq5DyN935QP7PiGhqBRJYkXvBMCezFD7XloC\njjroojuJIsIhfhgvoKj37oE=\n-----END PRIVATE KEY-----\n" + authentication_oauth_jwt_token_endpoint = "https://192.168.1.1:8244" + authentication_oauth_jwt_token_expiry_default = 899 + authentication_scheme = "oauth-jwt" + enabled = false + http_method = "put" + local_interface = "test" + max_post_wait_time = 29 + outgoing_connection_count = 4 + proxy_name = "test" + remote_host = "192.168.1.2" + remote_port = 2423 + retry_delay = 4 + tls_cipher_suite_list = "default" + tls_enabled = true +} + +resource "solacebroker_msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim" "msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + rest_delivery_point_name = solacebroker_msg_vpn_rest_delivery_point.msg_vpn_rest_delivery_point.rest_delivery_point_name + rest_consumer_name = solacebroker_msg_vpn_rest_delivery_point_rest_consumer.msg_vpn_rest_delivery_point_rest_consumer.rest_consumer_name + oauth_jwt_claim_name = "test" + oauth_jwt_claim_value = "{\"test\":1}" +} + +resource "solacebroker_msg_vpn_sequenced_topic" "msg_vpn_sequenced_topic" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + sequenced_topic = "test" +} + +resource "solacebroker_msg_vpn_telemetry_profile" "msg_vpn_telemetry_profile" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + telemetry_profile_name = "test" + queue_event_bind_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + queue_event_msg_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + queue_max_bind_count = 999 + queue_max_msg_spool_usage = 800000 + receiver_acl_connect_default_action = "allow" + receiver_enabled = true + receiver_event_connection_count_per_client_username_threshold = { "clear_percent" = 40, "set_percent" = 50 } + receiver_max_connection_count_per_client_username = 999 + receiver_tcp_congestion_window_size = 3 + receiver_tcp_keepalive_count = 4 + receiver_tcp_keepalive_idle_time = 4 + receiver_tcp_keepalive_interval = 2 + receiver_tcp_max_segment_size = 1459 + receiver_tcp_max_window_size = 255 + trace_enabled = true + trace_send_span_generation_enabled = false +} + +resource "solacebroker_msg_vpn_telemetry_profile_receiver_acl_connect_exception" "msg_vpn_telemetry_profile_receiver_acl_connect_exception" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + telemetry_profile_name = solacebroker_msg_vpn_telemetry_profile.msg_vpn_telemetry_profile.telemetry_profile_name + receiver_acl_connect_exception_address = "192.168.1.1/24" +} + +resource "solacebroker_msg_vpn_telemetry_profile_trace_filter" "msg_vpn_telemetry_profile_trace_filter" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + telemetry_profile_name = solacebroker_msg_vpn_telemetry_profile.msg_vpn_telemetry_profile.telemetry_profile_name + trace_filter_name = "test" + enabled = true +} + +resource "solacebroker_msg_vpn_telemetry_profile_trace_filter_subscription" "msg_vpn_telemetry_profile_trace_filter_subscription" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + telemetry_profile_name = solacebroker_msg_vpn_telemetry_profile.msg_vpn_telemetry_profile.telemetry_profile_name + trace_filter_name = solacebroker_msg_vpn_telemetry_profile_trace_filter.msg_vpn_telemetry_profile_trace_filter.trace_filter_name + subscription = "test" + subscription_syntax = "smf" +} + +resource "solacebroker_msg_vpn_topic_endpoint" "msg_vpn_topic_endpoint" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + topic_endpoint_name = "test" + access_type = "non-exclusive" + consumer_ack_propagation_enabled = false + dead_msg_queue = "test" + delivery_count_enabled = true + delivery_delay = 1 + egress_enabled = true + event_bind_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_reject_low_priority_msg_limit_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + ingress_enabled = true + max_bind_count = 2 + max_delivered_unacked_msgs_per_flow = 9999 + max_msg_size = 99999 + max_redelivery_count = 9 + max_spool_usage = 999 + max_ttl = 9 + owner = "test" + permission = "delete" + redelivery_delay_enabled = true + redelivery_delay_initial_interval = 999 + redelivery_delay_max_interval = 9999 + redelivery_delay_multiplier = 199 + redelivery_enabled = true + reject_low_priority_msg_enabled = true + reject_low_priority_msg_limit = 9 + reject_msg_to_sender_on_discard_behavior = "always" + respect_msg_priority_enabled = true + respect_ttl_enabled = true +} + +resource "solacebroker_msg_vpn_topic_endpoint_template" "msg_vpn_topic_endpoint_template" { + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + topic_endpoint_template_name = solacebroker_msg_vpn_topic_endpoint.msg_vpn_topic_endpoint.topic_endpoint_name + access_type = "non-exclusive" + consumer_ack_propagation_enabled = false + dead_msg_queue = "test" + delivery_delay = 1 + event_bind_count_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_reject_low_priority_msg_limit_threshold = { "clear_percent" = 40, "set_percent" = 50 } + event_msg_spool_usage_threshold = { "clear_percent" = 40, "set_percent" = 50 } + max_bind_count = 2 + max_delivered_unacked_msgs_per_flow = 9999 + max_msg_size = 99999 + max_msg_spool_usage = 999 + max_redelivery_count = 9 + max_ttl = 9 + permission = "delete" + redelivery_delay_enabled = true + redelivery_delay_initial_interval = 999 + redelivery_delay_max_interval = 9999 + redelivery_delay_multiplier = 199 + redelivery_enabled = true + reject_low_priority_msg_enabled = true + reject_low_priority_msg_limit = 9 + reject_msg_to_sender_on_discard_behavior = "always" + respect_msg_priority_enabled = true + respect_ttl_enabled = true + topic_endpoint_name_filter = "test" +} + +resource "solacebroker_oauth_profile" "oauth_profile" { + oauth_profile_name = "test" + access_level_groups_claim_name = "test" + access_level_groups_claim_string_format = "space-delimited" + client_id = "test" + client_redirect_uri = "https://test1:2141" + client_required_type = "test" + client_scope = "test" + client_secret = "test" + client_validate_type_enabled = false + default_global_access_level = "read-only" + default_msg_vpn_access_level = "read-only" + display_name = "test" + enabled = true + endpoint_authorization = "https://test1:3421" + endpoint_discovery = "https://test1:3221" + endpoint_discovery_refresh_interval = 86399 + endpoint_introspection = "https://test1:6342" + endpoint_introspection_timeout = 2 + endpoint_jwks = "https://test1:8523" + endpoint_jwks_refresh_interval = 86399 + endpoint_token = "https://test1:1244" + endpoint_token_timeout = 2 + endpoint_userinfo = "https://test1:2463" + endpoint_userinfo_timeout = 2 + interactive_enabled = false + interactive_prompt_for_expired_session = "test" + interactive_prompt_for_new_session = "test" + issuer = "test" + oauth_role = "resource-server" + resource_server_parse_access_token_enabled = false + resource_server_required_audience = "test" + resource_server_required_issuer = "test" + resource_server_required_scope = "test" + resource_server_required_type = "test" + resource_server_validate_audience_enabled = false + resource_server_validate_issuer_enabled = false + resource_server_validate_scope_enabled = false + resource_server_validate_type_enabled = false + semp_enabled = false + username_claim_name = "test" +} + +resource "solacebroker_oauth_profile_access_level_group" "oauth_profile_access_level_group" { + oauth_profile_name = solacebroker_oauth_profile.oauth_profile.oauth_profile_name + group_name = "test" + description = "test" + global_access_level = "admin" + msg_vpn_access_level = "read-write" +} + +resource "solacebroker_oauth_profile_access_level_group_msg_vpn_access_level_exception" "oauth_profile_access_level_group_msg_vpn_access_level_exception" { + oauth_profile_name = solacebroker_oauth_profile.oauth_profile.oauth_profile_name + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + group_name = solacebroker_oauth_profile_access_level_group.oauth_profile_access_level_group.group_name + access_level = "read-write" +} + +resource "solacebroker_oauth_profile_client_allowed_host" "oauth_profile_client_allowed_host" { + oauth_profile_name = solacebroker_oauth_profile.oauth_profile.oauth_profile_name + allowed_host = "test" +} + +resource "solacebroker_oauth_profile_client_authorization_parameter" "oauth_profile_client_authorization_parameter" { + oauth_profile_name = solacebroker_oauth_profile.oauth_profile.oauth_profile_name + authorization_parameter_name = "test" + authorization_parameter_value = "test" +} + +resource "solacebroker_oauth_profile_client_required_claim" "oauth_profile_client_required_claim" { + oauth_profile_name = solacebroker_oauth_profile.oauth_profile.oauth_profile_name + client_required_claim_name = "test" + client_required_claim_value = "{\"test\":1}" +} + +resource "solacebroker_oauth_profile_default_msg_vpn_access_level_exception" "oauth_profile_default_msg_vpn_access_level_exception" { + oauth_profile_name = solacebroker_oauth_profile.oauth_profile.oauth_profile_name + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name + access_level = "read-only" +} + +resource "solacebroker_oauth_profile_resource_server_required_claim" "oauth_profile_resource_server_required_claim" { + oauth_profile_name = solacebroker_oauth_profile.oauth_profile.oauth_profile_name + resource_server_required_claim_name = "test" + resource_server_required_claim_value = "{\"test\":1}" +} + +resource "solacebroker_virtual_hostname" "virtual_hostname" { + virtual_hostname = "test" + enabled = true + msg_vpn_name = solacebroker_msg_vpn.msg_vpn.msg_vpn_name +} diff --git a/ci/swagger_spec/semp-v2-swagger-config-extended.10.4.1.40.json b/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.1.30.vm.json similarity index 90% rename from ci/swagger_spec/semp-v2-swagger-config-extended.10.4.1.40.json rename to ci/swagger_spec/semp-v2-swagger-config-extended.10.6.1.30.vm.json index d6d5af5c..7452c6fc 100644 --- a/ci/swagger_spec/semp-v2-swagger-config-extended.10.4.1.40.json +++ b/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.1.30.vm.json @@ -1966,7 +1966,7 @@ "minLength": 0, "type": "string", "x-accessLevels": { - "patch": "global/read-write" + "patch": "global/admin" }, "x-autoDisable": [], "x-configSyncDefault": "", @@ -1988,7 +1988,7 @@ "minLength": 0, "type": "string", "x-accessLevels": { - "patch": "global/read-write" + "patch": "global/admin" }, "x-autoDisable": [], "x-configSyncDefault": "", @@ -4063,7 +4063,7 @@ "x-writeOnly": false }, "clientProfileQueueGuaranteed1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", + "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-1) priority queue, regardless of the `clientProfileQueueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", "format": "int32", "maximum": 262144, "minimum": 0, @@ -6574,7 +6574,7 @@ "MsgVpn": { "properties": { "alias": { - "description": "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\nAliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", + "description": "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\nAliases may form a non-circular chain, cascading one to the next.\n\nChanges to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.", "maxLength": 32, "minLength": 0, "pattern": "^[^*?]*$", @@ -7601,6 +7601,29 @@ "x-requiresDisable": [], "x-writeOnly": false }, + "maxKafkaBrokerConnectionCount": { + "description": "The maximum number of simultaneous Kafka Broker connections of the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.39.", + "format": "int32", + "maximum": 10000, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [], + "x-configSyncTableType": "vpn", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-writeOnly": false + }, "maxMsgSpoolUsage": { "description": "The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", @@ -8780,7 +8803,7 @@ "x-writeOnly": false }, "serviceRestIncomingAuthorizationHeaderHandling": { - "description": "The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are:\n\n
\n\"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.\n\"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n\"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n
\n Available since 2.19.", + "description": "The handling of Authorization headers for incoming REST connections. Authorization header handling settings apply only when the Message VPN is in gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are:\n\n
\n\"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.\n\"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n\"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n
\n Available since 2.19.", "enum": [ "drop", "forward", @@ -14599,7 +14622,7 @@ "x-writeOnly": false }, "queueGuaranteed1MinMsgBurst": { - "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `queueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", + "description": "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-1) priority queue, regardless of the `queueGuaranteed1MaxDepth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", "format": "int32", "maximum": 262144, "minimum": 0, @@ -21627,7 +21650,7 @@ "MsgVpnKafkaReceiver": { "properties": { "authenticationBasicPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The password for the Username. To be used when authenticationScheme is \"basic\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -21655,7 +21678,7 @@ "x-writeOnly": true }, "authenticationBasicUsername": { - "description": "The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authenticationScheme is \"basic\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -21681,7 +21704,7 @@ "x-writeOnly": false }, "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + "description": "The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. To be used when authenticationScheme is \"client-certificate\". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka Broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", "maxLength": 32768, "minLength": 0, "type": "string", @@ -21705,7 +21728,7 @@ "x-writeOnly": true }, "authenticationClientCertPassword": { - "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + "description": "The password for the client certificate. To be used when authenticationScheme is \"client-certificate\". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka Broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", "maxLength": 512, "minLength": 0, "type": "string", @@ -21732,7 +21755,7 @@ "x-writeOnly": true }, "authenticationOauthClientId": { - "description": "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth client ID. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 200, "minLength": 0, "type": "string", @@ -21758,7 +21781,7 @@ "x-writeOnly": false }, "authenticationOauthClientScope": { - "description": "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth scope. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 200, "minLength": 0, "type": "string", @@ -21784,7 +21807,7 @@ "x-writeOnly": false }, "authenticationOauthClientSecret": { - "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth client secret. To be used when authenticationScheme is \"oauth-client\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 512, "minLength": 0, "type": "string", @@ -21809,7 +21832,7 @@ "x-writeOnly": true }, "authenticationOauthClientTokenEndpoint": { - "description": "The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with \"https\". To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 2048, "minLength": 0, "pattern": "^([hH][tT][tT][pP][sS]://.+)?$", @@ -21836,7 +21859,7 @@ "x-writeOnly": false }, "authenticationScheme": { - "description": "The authentication scheme for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication.\n\"basic\" - Basic Authentication.\n\"scram\" - Salted Challenge Response Authentication.\n\"client-certificate\" - Client Certificate Authentication.\n\"oauth-client\" - Oauth Authentication.\n
\n", + "description": "The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports.\n
\n", "enum": [ "none", "basic", @@ -21867,7 +21890,7 @@ "x-writeOnly": false }, "authenticationScramHash": { - "description": "The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", + "description": "The hash used for SCRAM authentication. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", "enum": [ "sha-256", "sha-512" @@ -21895,7 +21918,7 @@ "x-writeOnly": false }, "authenticationScramPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The password for the Username. To be used when authenticationScheme is \"scram\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -21923,7 +21946,7 @@ "x-writeOnly": true }, "authenticationScramUsername": { - "description": "The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -21949,7 +21972,7 @@ "x-writeOnly": false }, "batchDelay": { - "description": "Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`.", + "description": "Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis.\n\nThis corresponds to the Kafka consumer API `fetch.max.wait.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`.", "format": "int32", "maximum": 300000, "minimum": 0, @@ -21976,7 +21999,7 @@ "x-writeOnly": false }, "batchMaxSize": { - "description": "Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + "description": "Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis.\n\nThis corresponds to the Kafka consumer API `fetch.min.bytes` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", "format": "int32", "maximum": 100000000, "minimum": 1, @@ -22003,7 +22026,7 @@ "x-writeOnly": false }, "bootstrapAddressList": { - "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.\n\nThis corresponds to the Kafka consumer API `bootstrap.servers` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 1044, "minLength": 0, "pattern": "^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", @@ -22052,7 +22075,7 @@ "x-writeOnly": false }, "groupId": { - "description": "The id of the Kafka consumer group for the Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The id of the Kafka consumer group for the Receiver.\n\nThis corresponds to the Kafka consumer API `group.id` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 100, "minLength": 0, "type": "string", @@ -22078,7 +22101,7 @@ "x-writeOnly": false }, "groupKeepaliveInterval": { - "description": "The time between sending keepalives to the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", + "description": "The time (in ms) between sending keepalives to the group.\n\nThis corresponds to the Kafka consumer API `heartbeat.interval.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", "format": "int32", "maximum": 3600000, "minimum": 1, @@ -22105,7 +22128,7 @@ "x-writeOnly": false }, "groupKeepaliveTimeout": { - "description": "The time until unresponsive group members are removed, triggering a partition rebalance across other members of the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`.", + "description": "The time (in ms) until unresponsive group members are removed, triggering a partition rebalance across other members of the group.\n\nThis corresponds to the Kafka consumer API `session.timeout.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`.", "format": "int32", "maximum": 3600000, "minimum": 1, @@ -22132,7 +22155,7 @@ "x-writeOnly": false }, "groupMembershipType": { - "description": "The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within groupKeepaliveTimeout) without prompting a group rebalance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"dynamic\"`. The allowed values and their meaning are:\n\n
\n\"dynamic\" - Dynamic Membership.\n\"static\" - Static Membership.\n
\n", + "description": "The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within groupKeepaliveTimeout) without prompting a group rebalance.\n\nThis corresponds to the Kafka consumer API `group.instance.id` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"dynamic\"`. The allowed values and their meaning are:\n\n
\n\"dynamic\" - Dynamic Membership.\n\"static\" - Static Membership.\n
\n", "enum": [ "dynamic", "static" @@ -22160,7 +22183,7 @@ "x-writeOnly": false }, "groupPartitionSchemeList": { - "description": "The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager (\"range\", \"roundrobin\") and Cooperative (\"cooperative-sticky\") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"range,roundrobin\"`.", + "description": "The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager (\"range\", \"roundrobin\") and Cooperative (\"cooperative-sticky\") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation.\n\nThis corresponds to the Kafka consumer API `partition.assignment.strategy` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"range,roundrobin\"`.", "maxLength": 64, "minLength": 0, "type": "string", @@ -22282,7 +22305,7 @@ "x-writeOnly": false }, "transportTlsEnabled": { - "description": "Enable or disable encryption (TLS) for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable encryption (TLS) for the Kafka Receiver. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -22368,7 +22391,7 @@ "x-writeOnly": false }, "initialOffset": { - "description": "The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"end\"`. The allowed values and their meaning are:\n\n
\n\"beginning\" - Start with the earliest offset available.\n\"end\" - Start with new offsets only.\n
\n", + "description": "The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition.\n\nThis corresponds to the Kafka consumer API `auto.offset.reset` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"end\"`. The allowed values and their meaning are:\n\n
\n\"beginning\" - Start with the earliest offset available.\n\"end\" - Start with new offsets only.\n
\n", "enum": [ "beginning", "end" @@ -22417,7 +22440,7 @@ "x-writeOnly": false }, "localKey": { - "description": "The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, no key is included for each message as it is published into Solace. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, no key is included for each message as it is published into Solace.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 1024, "minLength": 0, "type": "string", @@ -22443,7 +22466,7 @@ "x-writeOnly": false }, "localTopic": { - "description": "The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, the Topic Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, the Topic Binding will not be operational.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 1024, "minLength": 0, "type": "string", @@ -22593,7 +22616,7 @@ "MsgVpnKafkaSender": { "properties": { "authenticationBasicPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The password for the Username. To be used when authenticationScheme is \"basic\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -22621,7 +22644,7 @@ "x-writeOnly": true }, "authenticationBasicUsername": { - "description": "The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authenticationScheme is \"basic\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -22647,7 +22670,7 @@ "x-writeOnly": false }, "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + "description": "The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. To be used when authenticationScheme is \"client-certificate\". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka Broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", "maxLength": 32768, "minLength": 0, "type": "string", @@ -22671,7 +22694,7 @@ "x-writeOnly": true }, "authenticationClientCertPassword": { - "description": "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + "description": "The password for the client certificate. To be used when authenticationScheme is \"client-certificate\". Alternatively this will be used for other values of authenticationScheme when the Kafka Broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka Broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", "maxLength": 512, "minLength": 0, "type": "string", @@ -22698,7 +22721,7 @@ "x-writeOnly": true }, "authenticationOauthClientId": { - "description": "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth client ID. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 200, "minLength": 0, "type": "string", @@ -22724,7 +22747,7 @@ "x-writeOnly": false }, "authenticationOauthClientScope": { - "description": "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth scope. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 200, "minLength": 0, "type": "string", @@ -22750,7 +22773,7 @@ "x-writeOnly": false }, "authenticationOauthClientSecret": { - "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth client secret. To be used when authenticationScheme is \"oauth-client\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 512, "minLength": 0, "type": "string", @@ -22775,7 +22798,7 @@ "x-writeOnly": true }, "authenticationOauthClientTokenEndpoint": { - "description": "The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with \"https\". To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 2048, "minLength": 0, "pattern": "^([hH][tT][tT][pP][sS]://.+)?$", @@ -22802,7 +22825,7 @@ "x-writeOnly": false }, "authenticationScheme": { - "description": "The authentication scheme for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication.\n\"basic\" - Basic Authentication.\n\"scram\" - Salted Challenge Response Authentication.\n\"client-certificate\" - Client Certificate Authentication.\n\"oauth-client\" - Oauth Authentication.\n
\n", + "description": "The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports.\n
\n", "enum": [ "none", "basic", @@ -22833,7 +22856,7 @@ "x-writeOnly": false }, "authenticationScramHash": { - "description": "The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", + "description": "The hash used for SCRAM authentication. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", "enum": [ "sha-256", "sha-512" @@ -22861,7 +22884,7 @@ "x-writeOnly": false }, "authenticationScramPassword": { - "description": "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The password for the Username. To be used when authenticationScheme is \"scram\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -22889,7 +22912,7 @@ "x-writeOnly": true }, "authenticationScramUsername": { - "description": "The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 255, "minLength": 0, "type": "string", @@ -22915,7 +22938,7 @@ "x-writeOnly": false }, "batchDelay": { - "description": "Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", + "description": "Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `linger.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", "format": "int32", "maximum": 900000, "minimum": 0, @@ -22969,7 +22992,7 @@ "x-writeOnly": false }, "batchMaxSize": { - "description": "Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", + "description": "Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `batch.size` configuration setting, and should not exceed either the Kafka broker `message.max.bytes` configuration setting, or the per-Topic override of `max.message.bytes`.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", "format": "int32", "maximum": 2147483647, "minimum": 1, @@ -22996,7 +23019,7 @@ "x-writeOnly": false }, "bootstrapAddressList": { - "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.\n\nThis corresponds to the Kafka producer API `bootstrap.servers` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 1044, "minLength": 0, "pattern": "^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", @@ -23045,7 +23068,7 @@ "x-writeOnly": false }, "idempotenceEnabled": { - "description": "Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. When idempotence is enabled the Queue Bindings of the Kafka Sender must have ackMode of \"all\" to be operational.\n\nThis corresponds to the Kafka producer API `enable.idempotence` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -23135,7 +23158,7 @@ "x-writeOnly": false }, "transportCompressionLevel": { - "description": "Compression level. The valid range is dependent on the compression type. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", + "description": "Compression level. The valid range is dependent on the compression type.\n\nThis corresponds to the Kafka producer API `compression.level` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", "format": "int32", "maximum": 22, "minimum": -1, @@ -23162,7 +23185,7 @@ "x-writeOnly": false }, "transportCompressionType": { - "description": "Compression type. Only relevant if compression is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"gzip\"`. The allowed values and their meaning are:\n\n
\n\"gzip\" - GZIP Compression.\n\"snappy\" - Snappy Compression.\n\"lz4\" - LZ4 Compression.\n\"zstd\" - Zstandard Compression.\n
\n", + "description": "Compression type. Only relevant if compression is enabled.\n\nThis corresponds to the Kafka producer API `compression.type` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"gzip\"`. The allowed values and their meaning are:\n\n
\n\"gzip\" - GZIP Compression.\n\"snappy\" - Snappy Compression.\n\"lz4\" - LZ4 Compression.\n\"zstd\" - Zstandard Compression.\n
\n", "enum": [ "gzip", "snappy", @@ -23192,7 +23215,7 @@ "x-writeOnly": false }, "transportTlsEnabled": { - "description": "Enable or disable encryption (TLS) for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable encryption (TLS) for the Kafka Sender. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -23239,7 +23262,7 @@ "MsgVpnKafkaSenderQueueBinding": { "properties": { "ackMode": { - "description": "The number of acks required from the remote Kafka Broker. When \"none\" messages are delivered at-most-once. When \"one\" or \"all\" messages are delivered at-least-once but may be reordered. This is overridden to \"all\" for an idempotent Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are:\n\n
\n\"none\" - No Acks.\n\"one\" - Leader Ack Only.\n\"all\" - All Replica Acks.\n
\n", + "description": "The number of acks required from the remote Kafka Broker. When \"none\" messages are delivered at-most-once. When \"one\" or \"all\" messages are delivered at-least-once but may be reordered. This must be configured as \"all\" for an idempotent Kafka Sender, otherwise the Queue Binding will be operationally down.\n\nThis corresponds to the Kafka producer API `acks` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are:\n\n
\n\"none\" - No Acks.\n\"one\" - Leader Ack Only.\n\"all\" - All Replica Acks.\n
\n", "enum": [ "none", "one", @@ -23412,7 +23435,7 @@ "x-writeOnly": false }, "partitionScheme": { - "description": "The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"consistent\"`. The allowed values and their meaning are:\n\n
\n\"consistent\" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number.\n\"explicit\" - Select an explicit partition independent of key value.\n\"random\" - Select a random partition independent of key value.\n
\n", + "description": "The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to.\n\nThis corresponds to the Kafka producer API `partitioner.class` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"consistent\"`. The allowed values and their meaning are:\n\n
\n\"consistent\" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number.\n\"explicit\" - Select an explicit partition independent of key value.\n\"random\" - Select a random partition independent of key value.\n
\n", "enum": [ "consistent", "explicit", @@ -23462,7 +23485,7 @@ "x-writeOnly": false }, "remoteKey": { - "description": "The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue.\n\nIf empty, no key is included for each message as it is published into Kafka. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue.\n\nIf empty, no key is included for each message as it is published into Kafka.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 1024, "minLength": 0, "type": "string", @@ -23488,7 +23511,7 @@ "x-writeOnly": false }, "remoteTopic": { - "description": "The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to.\n\nIf empty, the Queue Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to.\n\nIf empty, the Queue Binding will not be operational.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 249, "minLength": 0, "pattern": "^[a-zA-Z0-9\\._\\-]*$", @@ -36295,9 +36318,9 @@ "name": "Solace", "url": "http://www.solace.com" }, - "description": "SEMP (starting in `v2`, see note 1) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker.\n\nSEMP uses URIs to address manageable **resources** of the Solace PubSub+ broker. Resources are individual **objects**, **collections** of objects, or (exclusively in the action API) **actions**. This document applies to the following API:\n\n\nAPI|Base Path|Purpose|Comments\n:---|:---|:---|:---\nConfiguration|/SEMP/v2/config|Reading and writing config state|See note 2\n\n\n\nThe following APIs are also available:\n\n\nAPI|Base Path|Purpose|Comments\n:---|:---|:---|:---\nAction|/SEMP/v2/action|Performing actions|See note 2\nMonitoring|/SEMP/v2/monitor|Querying operational parameters|See note 2\n\n\n\nResources are always nouns, with individual objects being singular and collections being plural.\n\nObjects within a collection are identified by an `obj-id`, which follows the collection name with the form `collection-name/obj-id`. An `obj-id` consists of one or more identifying attributes, separated by commas. Commas that appear in the identifying attribute itself must be percent encoded.\n\n\nActions within an object are identified by an `action-id`, which follows the object name with the form `obj-id/action-id`.\n\nSome examples:\n\n```\n/SEMP/v2/config/msgVpns ; MsgVpn collection\n/SEMP/v2/config/msgVpns/a ; MsgVpn object named \"a\"\n/SEMP/v2/config/msgVpns/a/bridges ; Bridge collection in MsgVpn \"a\"\n/SEMP/v2/config/msgVpns/a/bridges/b,auto ; Bridge object named \"b\" with virtual router \"auto\" in MsgVpn \"a\"\n/SEMP/v2/config/msgVpns/a/queues ; Queue collection in MsgVpn \"a\"\n/SEMP/v2/config/msgVpns/a/queues/c ; Queue object named \"c\" in MsgVpn \"a\"\n/SEMP/v2/action/msgVpns/a/queues/c/startReplay ; Action that starts a replay on Queue \"c\" in MsgVpn \"a\"\n/SEMP/v2/monitor/msgVpns/a/clients ; Client collection in MsgVpn \"a\"\n/SEMP/v2/monitor/msgVpns/a/clients/d ; Client object named \"d\" in MsgVpn \"a\"\n```\n\n## Collection Resources\n\nCollections are unordered lists of objects (unless described as otherwise), and are described by JSON arrays. Each item in the array represents an object in the same manner as the individual object would normally be represented. In the configuration API, the creation of a new object is done through its collection resource.\n\n## Object and Action Resources\n\nObjects are composed of attributes, actions, collections, and other objects. They are described by JSON objects as name/value pairs. The collections and actions of an object are not contained directly in the object's JSON content; rather the content includes an attribute containing a URI which points to the collections and actions. These contained resources must be managed through this URI. At a minimum, every object has one or more identifying attributes, and its own `uri` attribute which contains the URI pointing to itself.\n\nActions are also composed of attributes, and are described by JSON objects as name/value pairs. Unlike objects, however, they are not members of a collection and cannot be retrieved, only performed. Actions only exist in the action API.\n\nAttributes in an object or action may have any combination of the following properties:\n\n\nProperty|Meaning|Comments\n:---|:---|:---\nIdentifying|Attribute is involved in unique identification of the object, and appears in its URI|\nConst|Attribute value can only be chosen during object creation|\nRequired|Attribute must be provided in the request|\nRead-Only|Attribute value cannot be changed|See note 3\nWrite-Only|Attribute can only be written, not read, unless the attribute is also opaque|See the documentation for the opaque property\nRequires-Disable|Attribute cannot be changed while the object (or the relevant part of the object) is administratively enabled|\nAuto-Disable|Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as one or more attributes will be temporarily disabled to apply the change|\nDeprecated|Attribute is deprecated, and will disappear in the next SEMP version|\nOpaque|Attribute can be set or retrieved in opaque form when the `opaquePassword` query parameter is present|See the `opaquePassword` query parameter documentation\n\n\n\nIn some requests, certain attributes may only be provided in certain combinations with other attributes:\n\n\nRelationship|Meaning|Comments\n:---|:---|:---\nRequires|Attribute may only be provided in a request if a particular attribute or combination of attributes is also provided in the request|The \"requires\" property will not be enforced for an attribute when all of the following conditions are met: (a) the attribute is not write-only; (b) the value provided for the attribute is the same as its current (or, on object creation, its default) value; and (c) the attribute requires a write-only attribute. In addition, the \"requires\" property may not be enforced even if only conditions (a) and (b) are met.\nConflicts|Attribute may only be provided in a request if a particular attribute or combination of attributes is not also provided in the request|\n\n\n\nIn the monitoring API, any non-identifying attribute may not be returned in a GET.\n\n## HTTP Methods\n\nThe following HTTP methods manipulate resources in accordance with these general principles. Note that some methods are only used in certain APIs:\n\n\nMethod|Resource|Meaning|Request Body|Response Body|Notes\n:---|:---|:---|:---|:---|:---\nPOST|Collection|Create object|Initial attribute values|Object attributes and metadata|Absent attributes are set to default. If object already exists, a 400 error is returned\nPUT|Object|Update object|New attribute values|Object attributes and metadata|If does not exist, the object is first created. Absent attributes are set to default, with certain exceptions (see note 4)\nPUT|Action|Performs action|Action arguments|Action metadata|\nPATCH|Object|Update object|New attribute values|Object attributes and metadata|Absent attributes are left unchanged. If the object does not exist, a 404 error is returned\nDELETE|Object|Delete object|Empty|Object metadata|If the object does not exist, a 404 is returned\nGET|Object|Get object|Empty|Object attributes and metadata|If the object does not exist, a 404 is returned\nGET|Collection|Get collection|Empty|Object attributes and collection metadata|If the collection is empty, then an empty collection is returned with a 200 code\n\n\n\n## Common Query Parameters\n\nThe following are some common query parameters that are supported by many method/URI combinations. Individual URIs may document additional parameters. Note that multiple query parameters can be used together in a single URI, separated by the ampersand character. For example:\n\n```\n; Request for the MsgVpns collection using two hypothetical query parameters\n; \"q1\" and \"q2\" with values \"val1\" and \"val2\" respectively\n/SEMP/v2/config/msgVpns?q1=val1&q2=val2\n```\n\n### select\n\nInclude in the response only selected attributes of the object, or exclude from the response selected attributes of the object. Use this query parameter to limit the size of the returned data for each returned object, return only those fields that are desired, or exclude fields that are not desired.\n\nThe value of `select` is a comma-separated list of attribute names. If the list contains attribute names that are not prefaced by `-`, only those attributes are included in the response. If the list contains attribute names that are prefaced by `-`, those attributes are excluded from the response. If the list contains both types, then the difference of the first set of attributes and the second set of attributes is returned. If the list is empty (i.e. `select=`), it is treated the same as if no `select` was provided: all attribute are returned.\n\nAll attributes that are prefaced by `-` must follow all attributes that are not prefaced by `-`. In addition, each attribute name in the list must match at least one attribute in the object.\n\nNames may include the `*` wildcard (zero or more characters). Nested attribute names are supported using periods (e.g. `parentName.childName`).\n\nSome examples:\n\n```\n; List of all MsgVpn names\n/SEMP/v2/config/msgVpns?select=msgVpnName\n; List of all MsgVpn and their attributes except for their names\n/SEMP/v2/config/msgVpns?select=-msgVpnName\n; Authentication attributes of MsgVpn \"finance\"\n/SEMP/v2/config/msgVpns/finance?select=authentication%2A\n; All attributes of MsgVpn \"finance\" except for authentication attributes\n/SEMP/v2/config/msgVpns/finance?select=-authentication%2A\n; Access related attributes of Queue \"orderQ\" of MsgVpn \"finance\"\n/SEMP/v2/config/msgVpns/finance/queues/orderQ?select=owner,permission\n```\n\n### where\n\nInclude in the response only objects where certain conditions are true. Use this query parameter to limit which objects are returned to those whose attribute values meet the given conditions.\n\nThe value of `where` is a comma-separated list of expressions. All expressions must be true for the object to be included in the response. Each expression takes the form:\n\n```\nexpression = attribute-name OP value\nOP = '==' | '!=' | '<' | '>' | '<=' | '>='\n```\n\nWrite-only attributes cannot be used in a `where` expression.\n\n`value` may be a number, string, `true`, or `false`, as appropriate for the type of `attribute-name`.\n\nA `*` in a string `value` is interpreted as a wildcard (zero or more characters), but can be escaped using `\\`. The `\\` character can itself be escaped using `\\`. The `*` wildcard can only be used with the `==` and `!=` operators. If `*` is used as a literal with other operators, it must be escaped.\n\nThe `<`, `>`, `<=`, and `>=` operators perform a simple byte-for-byte comparison when used with a string `value`.\n\nSome examples:\n\n```\n; Only enabled MsgVpns\n/SEMP/v2/config/msgVpns?where=enabled%3D%3Dtrue\n; Only MsgVpns using basic non-LDAP authentication\n/SEMP/v2/config/msgVpns?where=authenticationBasicEnabled%3D%3Dtrue,authenticationBasicType%21%3Dldap\n; Only MsgVpns that allow more than 100 client connections\n/SEMP/v2/config/msgVpns?where=maxConnectionCount%3E100\n; Only MsgVpns with msgVpnName starting with \"B\":\n/SEMP/v2/config/msgVpns?where=msgVpnName%3D%3DB%2A\n```\n\n### count\n\nLimit the count of objects in the response. This can be useful to limit the size of the response for large collections. The minimum value for `count` is `1` and the default is `10`. There is also a per-collection maximum value to limit request handling time.\n\n`count` does not guarantee that a minimum number of objects will be returned. A page may contain fewer than `count` objects or even be empty. Additional objects may nonetheless be available for retrieval on subsequent pages. See the `cursor` query parameter documentation for more information on paging.\n\nFor example:\n```\n; Up to 25 MsgVpns\n/SEMP/v2/config/msgVpns?count=25\n```\n\n### cursor\n\nThe cursor, or position, for the next page of objects. Cursors are opaque data that should not be created or interpreted by SEMP clients, and should only be used as described below.\n\nWhen a request is made for a collection and there may be additional objects available for retrieval that are not included in the initial response, the response will include a `cursorQuery` field containing a cursor. The value of this field can be specified in the `cursor` query parameter of a subsequent request to retrieve the next page of objects.\n\nApplications must continue to use the `cursorQuery` if one is provided in order to retrieve the full set of objects associated with the request, even if a page contains fewer than the requested number of objects (see the `count` query parameter documentation) or is empty.\n\n### opaquePassword\n\nAttributes with the opaque property are also write-only and so cannot normally be retrieved in a GET. However, when a password is provided in the `opaquePassword` query parameter, attributes with the opaque property are retrieved in a GET in opaque form, encrypted with this password. The query parameter can also be used on a POST, PATCH, or PUT to set opaque attributes using opaque attribute values retrieved in a GET, so long as:\n\n1. the same password that was used to retrieve the opaque attribute values is provided; and\n\n2. the broker to which the request is being sent has the same major and minor SEMP version as the broker that produced the opaque attribute values.\n\nThe password provided in the query parameter must be a minimum of 8 characters and a maximum of 128 characters.\n\nThe query parameter can only be used in the configuration API, and only over HTTPS.\n\n## Authentication\n\nWhen a client makes its first SEMPv2 request, it must supply a username and password using HTTP Basic authentication, or an OAuth token or tokens using HTTP Bearer authentication.\n\nWhen HTTP Basic authentication is used, the broker returns a cookie containing a session key. The client can omit the username and password from subsequent requests, because the broker can use the session cookie for authentication instead. When the session expires or is deleted, the client must provide the username and password again, and the broker creates a new session.\n\nThere are a limited number of session slots available on the broker. The broker returns 529 No SEMP Session Available if it is not able to allocate a session.\n\nIf certain attributes\u2014such as a user's password\u2014are changed, the broker automatically deletes the affected sessions. These attributes are documented below. However, changes in external user configuration data stored on a RADIUS or LDAP server do not trigger the broker to delete the associated session(s), therefore you must do this manually, if required.\n\nA client can retrieve its current session information using the /about/user endpoint and delete its own session using the /about/user/logout endpoint. A client with appropriate permissions can also manage all sessions using the /sessions endpoint.\n\nSessions are not created when authenticating with an OAuth token or tokens using HTTP Bearer authentication. If a session cookie is provided, it is ignored.\n\n## Help\n\nVisit [our website](https://solace.com) to learn more about Solace.\n\nYou can also download the SEMP API specifications by clicking [here](https://solace.com/downloads/).\n\nIf you need additional support, please contact us at [support@solace.com](mailto:support@solace.com).\n\n## Notes\n\nNote|Description\n:---:|:---\n1|This specification defines SEMP starting in \"v2\", and not the original SEMP \"v1\" interface. Request and response formats between \"v1\" and \"v2\" are entirely incompatible, although both protocols share a common port configuration on the Solace PubSub+ broker. They are differentiated by the initial portion of the URI path, one of either \"/SEMP/\" or \"/SEMP/v2/\"\n2|This API is partially implemented. Only a subset of all objects are available.\n3|Read-only attributes may appear in POST and PUT/PATCH requests but are ignored, except when the read-only attribute is identifying.\n4|On a PUT, if the SEMP user is not authorized to modify the attribute, its value is left unchanged rather than set to default. In addition, the values of write-only attributes are not set to their defaults on a PUT, except in the following two cases: there is a mutual requires relationship with another non-write-only attribute, both attributes are absent from the request, and the non-write-only attribute is not currently set to its default value; or the attribute is also opaque and the `opaquePassword` query parameter is provided in the request.\n\n", + "description": "SEMP (starting in `v2`) is a RESTful API for configuring, monitoring, and administering a Solace PubSub+ broker. This specification defines the following API:\n\n\nAPI|Base Path|Purpose\n:---|:---|:---\nConfiguration|/SEMP/v2/config|Reading and writing configuration\n\n\n\nThe following APIs are also available:\n\n\nAPI|Base Path|Purpose\n:---|:---|:---\nAction|/SEMP/v2/action|Performing actions\nMonitoring|/SEMP/v2/monitor|Querying operational state\n\n\n\nFor tutorials, architectural and protocol design documentation, and other information about the SEMP API, consult the [SEMP documentation](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) on the Solace website. The SEMP API specifications are also [available for download](https://solace.com/downloads/).\n\nIf you need additional support, please contact us at [support@solace.com](mailto:support@solace.com).", "title": "SEMP (Solace Element Management Protocol)", - "version": "0.2.36" + "version": "2.39" }, "parameters": { "countQuery": { @@ -36364,7 +36387,7 @@ "paths": { "/": { "get": { - "description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ntlsServerCertContent||x||x\ntlsServerCertPassword||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/read-only\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-only\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-only\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-only\nconfigSyncClientProfileTcpKeepaliveCount|global/read-only\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-only\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-only\nconfigSyncClientProfileTcpMaxWindow|global/read-only\nconfigSyncClientProfileTcpMss|global/read-only\nconfigSyncEnabled|global/read-only\nconfigSyncSynchronizeUsernameEnabled|global/read-only\nconfigSyncTlsEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleDayList|global/read-only\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-only\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-only\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-only\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only\nguaranteedMsgingEnabled|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only\nguaranteedMsgingMaxCacheUsage|global/read-only\nguaranteedMsgingMaxMsgSpoolUsage|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only\noauthProfileDefault|global/read-only\nserviceAmqpEnabled|global/read-only\nserviceAmqpTlsListenPort|global/read-only\nserviceEventConnectionCountThreshold.clearPercent|global/read-only\nserviceEventConnectionCountThreshold.clearValue|global/read-only\nserviceEventConnectionCountThreshold.setPercent|global/read-only\nserviceEventConnectionCountThreshold.setValue|global/read-only\nserviceHealthCheckEnabled|global/read-only\nserviceHealthCheckListenPort|global/read-only\nserviceHealthCheckTlsEnabled|global/read-only\nserviceHealthCheckTlsListenPort|global/read-only\nserviceMateLinkEnabled|global/read-only\nserviceMateLinkListenPort|global/read-only\nserviceMqttEnabled|global/read-only\nserviceMsgBackboneEnabled|global/read-only\nserviceRedundancyEnabled|global/read-only\nserviceRedundancyFirstListenPort|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only\nserviceRestIncomingEnabled|global/read-only\nserviceRestOutgoingEnabled|global/read-only\nserviceSempCorsAllowAnyHostEnabled|global/read-only\nserviceSempLegacyTimeoutEnabled|global/read-only\nserviceSempPlainTextEnabled|global/read-only\nserviceSempPlainTextListenPort|global/read-only\nserviceSempSessionIdleTimeout|global/read-only\nserviceSempSessionMaxLifetime|global/read-only\nserviceSempTlsEnabled|global/read-only\nserviceSempTlsListenPort|global/read-only\nserviceSmfCompressionListenPort|global/read-only\nserviceSmfEnabled|global/read-only\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-only\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.setValue|global/read-only\nserviceSmfPlainTextListenPort|global/read-only\nserviceSmfRoutingControlListenPort|global/read-only\nserviceSmfTlsListenPort|global/read-only\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-only\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.setValue|global/read-only\nserviceWebTransportEnabled|global/read-only\nserviceWebTransportPlainTextListenPort|global/read-only\nserviceWebTransportTlsListenPort|global/read-only\nserviceWebTransportWebUrlSuffix|global/read-only\ntlsBlockVersion11Enabled|global/read-only\ntlsCipherSuiteManagementList|global/read-only\ntlsCipherSuiteMsgBackboneList|global/read-only\ntlsCipherSuiteSecureShellList|global/read-only\ntlsCrimeExploitProtectionEnabled|global/read-only\ntlsServerCertContent|global/read-only\ntlsStandardDomainCertificateAuthoritiesEnabled|vpn/read-only\ntlsTicketLifetime|global/read-only\nwebManagerAllowUnencryptedWizardsEnabled|vpn/read-only\nwebManagerCustomization|vpn/read-only\nwebManagerRedirectHttpEnabled|vpn/read-only\nwebManagerRedirectHttpOverrideTlsPort|vpn/read-only\n\n\n\nThis has been available since 2.13.", + "description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Opaque\n:---|:---:|:---:\ntlsServerCertContent|x|x\ntlsServerCertPassword|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/read-only\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-only\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-only\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-only\nconfigSyncClientProfileTcpKeepaliveCount|global/read-only\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-only\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-only\nconfigSyncClientProfileTcpMaxWindow|global/read-only\nconfigSyncClientProfileTcpMss|global/read-only\nconfigSyncEnabled|global/read-only\nconfigSyncSynchronizeUsernameEnabled|global/read-only\nconfigSyncTlsEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleDayList|global/read-only\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-only\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-only\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-only\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only\nguaranteedMsgingEnabled|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only\nguaranteedMsgingMaxCacheUsage|global/read-only\nguaranteedMsgingMaxMsgSpoolUsage|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only\noauthProfileDefault|global/read-only\nserviceAmqpEnabled|global/read-only\nserviceAmqpTlsListenPort|global/read-only\nserviceEventConnectionCountThreshold.clearPercent|global/read-only\nserviceEventConnectionCountThreshold.clearValue|global/read-only\nserviceEventConnectionCountThreshold.setPercent|global/read-only\nserviceEventConnectionCountThreshold.setValue|global/read-only\nserviceHealthCheckEnabled|global/read-only\nserviceHealthCheckListenPort|global/read-only\nserviceHealthCheckTlsEnabled|global/read-only\nserviceHealthCheckTlsListenPort|global/read-only\nserviceMateLinkEnabled|global/read-only\nserviceMateLinkListenPort|global/read-only\nserviceMqttEnabled|global/read-only\nserviceMsgBackboneEnabled|global/read-only\nserviceRedundancyEnabled|global/read-only\nserviceRedundancyFirstListenPort|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only\nserviceRestIncomingEnabled|global/read-only\nserviceRestOutgoingEnabled|global/read-only\nserviceSempCorsAllowAnyHostEnabled|global/read-only\nserviceSempLegacyTimeoutEnabled|global/read-only\nserviceSempPlainTextEnabled|global/read-only\nserviceSempPlainTextListenPort|global/read-only\nserviceSempSessionIdleTimeout|global/read-only\nserviceSempSessionMaxLifetime|global/read-only\nserviceSempTlsEnabled|global/read-only\nserviceSempTlsListenPort|global/read-only\nserviceSmfCompressionListenPort|global/read-only\nserviceSmfEnabled|global/read-only\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-only\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.setValue|global/read-only\nserviceSmfPlainTextListenPort|global/read-only\nserviceSmfRoutingControlListenPort|global/read-only\nserviceSmfTlsListenPort|global/read-only\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-only\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.setValue|global/read-only\nserviceWebTransportEnabled|global/read-only\nserviceWebTransportPlainTextListenPort|global/read-only\nserviceWebTransportTlsListenPort|global/read-only\nserviceWebTransportWebUrlSuffix|global/read-only\ntlsBlockVersion11Enabled|global/read-only\ntlsCipherSuiteManagementList|global/read-only\ntlsCipherSuiteMsgBackboneList|global/read-only\ntlsCipherSuiteSecureShellList|global/read-only\ntlsCrimeExploitProtectionEnabled|global/read-only\ntlsServerCertContent|global/read-only\ntlsTicketLifetime|global/read-only\n\n\n\nThis has been available since 2.13.", "operationId": "getBroker", "parameters": [ { @@ -36406,7 +36429,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Broker object. Any attribute missing from the request will be left unchanged.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nserviceAmqpTlsListenPort||||||x||\nserviceHealthCheckListenPort||||||x||\nserviceHealthCheckTlsListenPort||||||x||\nserviceMateLinkListenPort||||||x||\nserviceRedundancyFirstListenPort||||||x||\nserviceSempPlainTextListenPort|||||x|||\nserviceSempTlsListenPort|||||x|||\nserviceSmfCompressionListenPort||||||x||\nserviceSmfPlainTextListenPort||||||x||\nserviceSmfRoutingControlListenPort||||||x||\nserviceSmfTlsListenPort||||||x||\nserviceWebTransportPlainTextListenPort||||||x||\nserviceWebTransportTlsListenPort||||||x||\nserviceWebTransportWebUrlSuffix||||||x||\ntlsServerCertContent||||x||||x\ntlsServerCertPassword||||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nBroker|tlsServerCertPassword|tlsServerCertContent|\nGuaranteedMsgingEventCacheUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventCacheUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventDeliveredUnackedThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDeliveredUnackedThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventDiskUsageThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDiskUsageThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/admin\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-write\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-write\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-write\nconfigSyncClientProfileTcpKeepaliveCount|global/read-write\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-write\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-write\nconfigSyncClientProfileTcpMaxWindow|global/read-write\nconfigSyncClientProfileTcpMss|global/read-write\nconfigSyncEnabled|global/read-write\nconfigSyncSynchronizeUsernameEnabled|global/read-write\nconfigSyncTlsEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleDayList|global/read-write\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-write\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-write\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-write\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write\nguaranteedMsgingEnabled|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write\nguaranteedMsgingMaxCacheUsage|global/read-write\nguaranteedMsgingMaxMsgSpoolUsage|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write\noauthProfileDefault|global/admin\nserviceAmqpEnabled|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceEventConnectionCountThreshold.clearPercent|global/read-write\nserviceEventConnectionCountThreshold.clearValue|global/read-write\nserviceEventConnectionCountThreshold.setPercent|global/read-write\nserviceEventConnectionCountThreshold.setValue|global/read-write\nserviceHealthCheckEnabled|global/read-write\nserviceHealthCheckListenPort|global/read-write\nserviceHealthCheckTlsEnabled|global/read-write\nserviceHealthCheckTlsListenPort|global/read-write\nserviceMateLinkEnabled|global/read-write\nserviceMateLinkListenPort|global/read-write\nserviceMqttEnabled|global/read-write\nserviceMsgBackboneEnabled|global/read-write\nserviceRedundancyEnabled|global/read-write\nserviceRedundancyFirstListenPort|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write\nserviceRestIncomingEnabled|global/read-write\nserviceRestOutgoingEnabled|global/read-write\nserviceSempCorsAllowAnyHostEnabled|global/read-write\nserviceSempLegacyTimeoutEnabled|global/read-write\nserviceSempPlainTextEnabled|global/read-write\nserviceSempPlainTextListenPort|global/read-write\nserviceSempSessionIdleTimeout|global/read-write\nserviceSempSessionMaxLifetime|global/read-write\nserviceSempTlsEnabled|global/read-write\nserviceSempTlsListenPort|global/read-write\nserviceSmfCompressionListenPort|global/read-write\nserviceSmfEnabled|global/read-write\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-write\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.setValue|global/read-write\nserviceSmfPlainTextListenPort|global/read-write\nserviceSmfRoutingControlListenPort|global/read-write\nserviceSmfTlsListenPort|global/read-write\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-write\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.setValue|global/read-write\nserviceWebTransportEnabled|global/read-write\nserviceWebTransportPlainTextListenPort|global/read-write\nserviceWebTransportTlsListenPort|global/read-write\nserviceWebTransportWebUrlSuffix|global/read-write\ntlsBlockVersion11Enabled|global/read-write\ntlsCipherSuiteManagementList|global/read-write\ntlsCipherSuiteMsgBackboneList|global/read-write\ntlsCipherSuiteSecureShellList|global/read-write\ntlsCrimeExploitProtectionEnabled|global/read-write\ntlsServerCertContent|global/read-write\ntlsServerCertPassword|global/read-write\ntlsStandardDomainCertificateAuthoritiesEnabled|global/read-write\ntlsTicketLifetime|global/read-write\nwebManagerAllowUnencryptedWizardsEnabled|global/read-write\nwebManagerCustomization|vpn/read-write\nwebManagerRedirectHttpEnabled|global/read-write\nwebManagerRedirectHttpOverrideTlsPort|global/read-write\n\n\n\nThis has been available since 2.13.", + "description": "Update a Broker object. Any attribute missing from the request will be left unchanged.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Requires-Disable|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:\nserviceAmqpTlsListenPort|||x|\nserviceHealthCheckListenPort|||x|\nserviceHealthCheckTlsListenPort|||x|\nserviceMateLinkListenPort|||x|\nserviceRedundancyFirstListenPort|||x|\nserviceSempPlainTextListenPort||x||\nserviceSempTlsListenPort||x||\nserviceSmfCompressionListenPort|||x|\nserviceSmfPlainTextListenPort|||x|\nserviceSmfRoutingControlListenPort|||x|\nserviceSmfTlsListenPort|||x|\nserviceWebTransportPlainTextListenPort|||x|\nserviceWebTransportTlsListenPort|||x|\nserviceWebTransportWebUrlSuffix|||x|\ntlsServerCertContent|x|||x\ntlsServerCertPassword|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nBroker|tlsServerCertPassword|tlsServerCertContent|\nGuaranteedMsgingEventCacheUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventCacheUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventCacheUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventDeliveredUnackedThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDeliveredUnackedThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventDiskUsageThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventDiskUsageThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventMsgSpoolFileCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|clearPercent|setPercent|\nGuaranteedMsgingEventTransactedSessionResourceCountThreshold|setPercent|clearPercent|\nGuaranteedMsgingEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nGuaranteedMsgingEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nGuaranteedMsgingEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceRestEventOutgoingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceRestEventOutgoingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceSmfEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceSmfEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nServiceTlsEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nServiceTlsEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/admin\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-write\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-write\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-write\nconfigSyncClientProfileTcpKeepaliveCount|global/read-write\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-write\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-write\nconfigSyncClientProfileTcpMaxWindow|global/read-write\nconfigSyncClientProfileTcpMss|global/read-write\nconfigSyncEnabled|global/read-write\nconfigSyncSynchronizeUsernameEnabled|global/read-write\nconfigSyncTlsEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleDayList|global/read-write\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-write\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-write\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-write\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-write\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-write\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-write\nguaranteedMsgingEnabled|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-write\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-write\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-write\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-write\nguaranteedMsgingMaxCacheUsage|global/read-write\nguaranteedMsgingMaxMsgSpoolUsage|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-write\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-write\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-write\noauthProfileDefault|global/admin\nserviceAmqpEnabled|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceEventConnectionCountThreshold.clearPercent|global/read-write\nserviceEventConnectionCountThreshold.clearValue|global/read-write\nserviceEventConnectionCountThreshold.setPercent|global/read-write\nserviceEventConnectionCountThreshold.setValue|global/read-write\nserviceHealthCheckEnabled|global/read-write\nserviceHealthCheckListenPort|global/read-write\nserviceHealthCheckTlsEnabled|global/read-write\nserviceHealthCheckTlsListenPort|global/read-write\nserviceMateLinkEnabled|global/read-write\nserviceMateLinkListenPort|global/read-write\nserviceMqttEnabled|global/read-write\nserviceMsgBackboneEnabled|global/read-write\nserviceRedundancyEnabled|global/read-write\nserviceRedundancyFirstListenPort|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-write\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-write\nserviceRestIncomingEnabled|global/read-write\nserviceRestOutgoingEnabled|global/read-write\nserviceSempCorsAllowAnyHostEnabled|global/read-write\nserviceSempLegacyTimeoutEnabled|global/read-write\nserviceSempPlainTextEnabled|global/read-write\nserviceSempPlainTextListenPort|global/read-write\nserviceSempSessionIdleTimeout|global/read-write\nserviceSempSessionMaxLifetime|global/read-write\nserviceSempTlsEnabled|global/read-write\nserviceSempTlsListenPort|global/read-write\nserviceSmfCompressionListenPort|global/read-write\nserviceSmfEnabled|global/read-write\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-write\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-write\nserviceSmfEventConnectionCountThreshold.setValue|global/read-write\nserviceSmfPlainTextListenPort|global/read-write\nserviceSmfRoutingControlListenPort|global/read-write\nserviceSmfTlsListenPort|global/read-write\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-write\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-write\nserviceTlsEventConnectionCountThreshold.setValue|global/read-write\nserviceWebTransportEnabled|global/read-write\nserviceWebTransportPlainTextListenPort|global/read-write\nserviceWebTransportTlsListenPort|global/read-write\nserviceWebTransportWebUrlSuffix|global/read-write\ntlsBlockVersion11Enabled|global/read-write\ntlsCipherSuiteManagementList|global/read-write\ntlsCipherSuiteMsgBackboneList|global/read-write\ntlsCipherSuiteSecureShellList|global/read-write\ntlsCrimeExploitProtectionEnabled|global/read-write\ntlsServerCertContent|global/admin\ntlsServerCertPassword|global/admin\ntlsStandardDomainCertificateAuthoritiesEnabled|global/read-write\ntlsTicketLifetime|global/read-write\nwebManagerAllowUnencryptedWizardsEnabled|global/read-write\nwebManagerRedirectHttpEnabled|global/read-write\nwebManagerRedirectHttpOverrideTlsPort|global/read-write\n\n\n\nThis has been available since 2.13.", "operationId": "updateBroker", "parameters": [ { @@ -36594,7 +36617,7 @@ }, "/about/user/msgVpns": { "get": { - "description": "Get a list of User Message VPN objects.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", + "description": "Get a list of User Message VPN objects.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", "operationId": "getAboutUserMsgVpns", "parameters": [ { @@ -36651,7 +36674,7 @@ }, "/about/user/msgVpns/{msgVpnName}": { "get": { - "description": "Get a User Message VPN object.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Get a User Message VPN object.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "getAboutUserMsgVpn", "parameters": [ { @@ -36704,7 +36727,7 @@ "/certAuthorities": { "get": { "deprecated": true, - "description": "Get a list of Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\ncertContent|||x|\ncrlDayList|||x|\ncrlTimeList|||x|\ncrlUrl|||x|\nocspNonResponderCertEnabled|||x|\nocspOverrideUrl|||x|\nocspTimeout|||x|\nrevocationCheckEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "description": "Get a list of Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\ncertContent||x\ncrlDayList||x\ncrlTimeList||x\ncrlUrl||x\nocspNonResponderCertEnabled||x\nocspOverrideUrl||x\nocspTimeout||x\nrevocationCheckEnabled||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", "operationId": "getCertAuthorities", "parameters": [ { @@ -36760,7 +36783,7 @@ }, "post": { "deprecated": true, - "description": "Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|x|||x|\ncertContent||||||x|\ncrlDayList||||||x|\ncrlTimeList||||||x|\ncrlUrl||||||x|\nocspNonResponderCertEnabled||||||x|\nocspOverrideUrl||||||x|\nocspTimeout||||||x|\nrevocationCheckEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nCertAuthority|crlDayList|crlTimeList|\nCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "description": "Create a Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|x|x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl||||x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", "operationId": "createCertAuthority", "parameters": [ { @@ -36860,7 +36883,7 @@ }, "get": { "deprecated": true, - "description": "Get a Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\ncertContent|||x|\ncrlDayList|||x|\ncrlTimeList|||x|\ncrlUrl|||x|\nocspNonResponderCertEnabled|||x|\nocspOverrideUrl|||x|\nocspTimeout|||x|\nrevocationCheckEnabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "description": "Get a Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\ncertContent||x\ncrlDayList||x\ncrlTimeList||x\ncrlUrl||x\nocspNonResponderCertEnabled||x\nocspOverrideUrl||x\nocspTimeout||x\nrevocationCheckEnabled||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", "operationId": "getCertAuthority", "parameters": [ { @@ -36911,7 +36934,7 @@ }, "patch": { "deprecated": true, - "description": "Update a Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|||||x|\ncertContent|||||||x|\ncrlDayList|||||||x|\ncrlTimeList|||||||x|\ncrlUrl||||||x|x|\nocspNonResponderCertEnabled|||||||x|\nocspOverrideUrl|||||||x|\nocspTimeout|||||||x|\nrevocationCheckEnabled|||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nCertAuthority|crlDayList|crlTimeList|\nCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "description": "Update a Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl|||x|x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", "operationId": "updateCertAuthority", "parameters": [ { @@ -36971,7 +36994,7 @@ }, "put": { "deprecated": true, - "description": "Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|||||x|\ncertContent|||||||x|\ncrlDayList|||||||x|\ncrlTimeList|||||||x|\ncrlUrl||||||x|x|\nocspNonResponderCertEnabled|||||||x|\nocspOverrideUrl|||||||x|\nocspTimeout|||||||x|\nrevocationCheckEnabled|||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nCertAuthority|crlDayList|crlTimeList|\nCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", + "description": "Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable|Deprecated\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||x\ncertContent||||x\ncrlDayList||||x\ncrlTimeList||||x\ncrlUrl|||x|x\nocspNonResponderCertEnabled||||x\nocspOverrideUrl||||x\nocspTimeout||||x\nrevocationCheckEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nCertAuthority|crlDayList|crlTimeList\nCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities and domainCertAuthorities.", "operationId": "replaceCertAuthority", "parameters": [ { @@ -37033,7 +37056,7 @@ "/certAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { "get": { "deprecated": true, - "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\nocspTlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\nocspTlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", "operationId": "getCertAuthorityOcspTlsTrustedCommonNames", "parameters": [ { @@ -37087,7 +37110,7 @@ }, "post": { "deprecated": true, - "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x||x|\nocspTlsTrustedCommonName|x|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x|x\nocspTlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", "operationId": "createCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { @@ -37201,7 +37224,7 @@ }, "get": { "deprecated": true, - "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x||x|\nocspTlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", + "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\nocspTlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.19. Replaced by clientCertAuthorities.", "operationId": "getCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { @@ -37260,7 +37283,7 @@ }, "/clientCertAuthorities": { "get": { - "description": "Get a list of Client Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", + "description": "Get a list of Client Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", "operationId": "getClientCertAuthorities", "parameters": [ { @@ -37315,7 +37338,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList|\nClientCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Create a Client Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "createClientCertAuthority", "parameters": [ { @@ -37413,7 +37436,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Client Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Get a Client Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "getClientCertAuthority", "parameters": [ { @@ -37463,7 +37486,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||||||\ncrlUrl||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList|\nClientCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Update a Client Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|\ncrlUrl|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "updateClientCertAuthority", "parameters": [ { @@ -37522,7 +37545,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||||||\ncrlUrl||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList|\nClientCertAuthority|crlTimeList|crlDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Const|Auto-Disable\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|\ncrlUrl|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nClientCertAuthority|crlDayList|crlTimeList\nClientCertAuthority|crlTimeList|crlDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "replaceClientCertAuthority", "parameters": [ { @@ -37583,7 +37606,7 @@ }, "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames": { "get": { - "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\nocspTlsTrustedCommonName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", + "description": "Get a list of OCSP Responder Trusted Common Name objects.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\nocspTlsTrustedCommonName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.19.", "operationId": "getClientCertAuthorityOcspTlsTrustedCommonNames", "parameters": [ { @@ -37636,7 +37659,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x|||\nocspTlsTrustedCommonName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Create an OCSP Responder Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||x\nocspTlsTrustedCommonName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "createClientCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { @@ -37748,7 +37771,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\nocspTlsTrustedCommonName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Get an OCSP Responder Trusted Common Name object.\n\nWhen an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\nocspTlsTrustedCommonName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "getClientCertAuthorityOcspTlsTrustedCommonName", "parameters": [ { @@ -37862,7 +37885,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\nauthenticationClientCertContent|||||x||x\nauthenticationClientCertPassword|||||x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|x||||\nnodeName||||x|||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\nauthenticationClientCertContent|||||x||x\nauthenticationClientCertPassword|||||x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|x||||\nnodeName||||x|||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createDmrCluster", "parameters": [ { @@ -38010,7 +38033,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\ndirectOnlyEnabled||x||||||\ndmrClusterName|x|x||||||\nnodeName|||x|||||\ntlsServerCertEnforceTrustedCommonNameEnabled|||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Update a Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|||||\nnodeName|||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "updateDmrCluster", "parameters": [ { @@ -38069,7 +38092,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\ndirectOnlyEnabled||x||||||\ndmrClusterName|x|x||||||\nnodeName|||x|||||\ntlsServerCertEnforceTrustedCommonNameEnabled|||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x||x\nauthenticationClientCertContent||||x|x||x\nauthenticationClientCertPassword||||x|x||\ndirectOnlyEnabled||x|||||\ndmrClusterName|x|x|||||\nnodeName|||x||||\ntlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nDmrCluster|authenticationClientCertPassword|authenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "replaceDmrCluster", "parameters": [ { @@ -38130,7 +38153,7 @@ }, "/dmrClusters/{dmrClusterName}/certMatchingRules": { "get": { - "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterCertMatchingRules", "parameters": [ { @@ -38192,7 +38215,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x|||\nruleName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nruleName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "createDmrClusterCertMatchingRule", "parameters": [ { @@ -38304,7 +38327,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterCertMatchingRule", "parameters": [ { @@ -38361,7 +38384,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||||\nruleName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "updateDmrClusterCertMatchingRule", "parameters": [ { @@ -38427,7 +38450,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||||\nruleName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "replaceDmrClusterCertMatchingRule", "parameters": [ { @@ -38495,7 +38518,7 @@ }, "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters": { "get": { - "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nfilterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nfilterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterCertMatchingRuleAttributeFilters", "parameters": [ { @@ -38564,7 +38587,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x|||\nfilterName|x|x|x||||\nruleName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nfilterName|x|x|x|\nruleName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "createDmrClusterCertMatchingRuleAttributeFilter", "parameters": [ { @@ -38690,7 +38713,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nfilterName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nfilterName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterCertMatchingRuleAttributeFilter", "parameters": [ { @@ -38754,7 +38777,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||||\nfilterName|x|x||||||\nruleName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nfilterName|x|x|\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "updateDmrClusterCertMatchingRuleAttributeFilter", "parameters": [ { @@ -38827,7 +38850,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|||||\nfilterName|x|x||||||\nruleName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ndmrClusterName|x||x\nfilterName|x|x|\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "replaceDmrClusterCertMatchingRuleAttributeFilter", "parameters": [ { @@ -38902,7 +38925,7 @@ }, "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions": { "get": { - "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterCertMatchingRuleConditions", "parameters": [ { @@ -38971,7 +38994,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nattribute||x|||||\ndmrClusterName|x|||x|||\nexpression||x|||||\nruleName|x|||x|||\nsource|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattribute||x||\ndmrClusterName|x|||x\nexpression||x||\nruleName|x|||x\nsource|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "createDmrClusterCertMatchingRuleCondition", "parameters": [ { @@ -39097,7 +39120,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterCertMatchingRuleCondition", "parameters": [ { @@ -39163,7 +39186,7 @@ }, "/dmrClusters/{dmrClusterName}/links": { "get": { - "description": "Get a list of Link objects.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Link objects.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\ndmrClusterName|x||\nremoteNodeName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getDmrClusterLinks", "parameters": [ { @@ -39225,7 +39248,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\ndmrClusterName|x|||x|||\nremoteNodeName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Link object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\ndmrClusterName|x|||x||\nremoteNodeName|x|x|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createDmrClusterLink", "parameters": [ { @@ -39337,7 +39360,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Link object.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Link object.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\ndmrClusterName|x||\nremoteNodeName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getDmrClusterLink", "parameters": [ { @@ -39394,7 +39417,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Link object. Any attribute missing from the request will be left unchanged.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationScheme||||||x||\ndmrClusterName|x||x|||||\negressFlowWindowSize||||||x||\ninitiator||||||x||\nremoteNodeName|x|x||||||\nspan||||||x||\ntransportCompressedEnabled||||||x||\ntransportTlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Update a Link object. Any attribute missing from the request will be left unchanged.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationScheme|||||x|\ndmrClusterName|x||x|||\negressFlowWindowSize|||||x|\ninitiator|||||x|\nremoteNodeName|x|x||||\nspan|||||x|\ntransportCompressedEnabled|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "updateDmrClusterLink", "parameters": [ { @@ -39460,7 +39483,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationScheme||||||x||\ndmrClusterName|x||x|||||\negressFlowWindowSize||||||x||\ninitiator||||||x||\nremoteNodeName|x|x||||||\nspan||||||x||\ntransportCompressedEnabled||||||x||\ntransportTlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationScheme|||||x|\ndmrClusterName|x||x|||\negressFlowWindowSize|||||x|\ninitiator|||||x|\nremoteNodeName|x|x||||\nspan|||||x|\ntransportCompressedEnabled|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nDmrClusterLinkQueueEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nDmrClusterLinkQueueEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "replaceDmrClusterLink", "parameters": [ { @@ -39528,7 +39551,7 @@ }, "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes": { "get": { - "description": "Get a list of Link Attribute objects.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "description": "Get a list of Link Attribute objects.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\ndmrClusterName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterLinkAttributes", "parameters": [ { @@ -39597,7 +39620,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nattributeName|x|x|x||||\nattributeValue|x|x|x||||\ndmrClusterName|x|||x|||\nremoteNodeName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Create a Link Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattributeName|x|x|x|\nattributeValue|x|x|x|\ndmrClusterName|x|||x\nremoteNodeName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "createDmrClusterLinkAttribute", "parameters": [ { @@ -39730,7 +39753,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Link Attribute object.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\ndmrClusterName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Get a Link Attribute object.\n\nA Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\ndmrClusterName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "getDmrClusterLinkAttribute", "parameters": [ { @@ -39803,7 +39826,7 @@ }, "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses": { "get": { - "description": "Get a list of Remote Address objects.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nremoteAddress|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Remote Address objects.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nremoteAddress|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getDmrClusterLinkRemoteAddresses", "parameters": [ { @@ -39863,7 +39886,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x|||\nremoteAddress|x|x|x||||\nremoteNodeName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Remote Address object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x\nremoteAddress|x|x|x|\nremoteNodeName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createDmrClusterLinkRemoteAddress", "parameters": [ { @@ -39989,7 +40012,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Remote Address object.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x|||\nremoteAddress|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Remote Address object.\n\nEach Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmrClusterName|x\nremoteAddress|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getDmrClusterLinkRemoteAddress", "parameters": [ { @@ -40056,7 +40079,7 @@ "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/tlsTrustedCommonNames": { "get": { "deprecated": true, - "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|\nremoteNodeName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ndmrClusterName|x|x\nremoteNodeName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "getDmrClusterLinkTlsTrustedCommonNames", "parameters": [ { @@ -40117,7 +40140,7 @@ }, "post": { "deprecated": true, - "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x||x|\nremoteNodeName|x|||x||x|\ntlsTrustedCommonName|x|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\ndmrClusterName|x|||x|x\nremoteNodeName|x|||x|x\ntlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "createDmrClusterLinkTlsTrustedCommonName", "parameters": [ { @@ -40245,7 +40268,7 @@ }, "get": { "deprecated": true, - "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmrClusterName|x||x|\nremoteNodeName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Link are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ndmrClusterName|x|x\nremoteNodeName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "getDmrClusterLinkTlsTrustedCommonName", "parameters": [ { @@ -40311,7 +40334,7 @@ }, "/domainCertAuthorities": { "get": { - "description": "Get a list of Domain Certificate Authority objects.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.19.", + "description": "Get a list of Domain Certificate Authority objects.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.19.", "operationId": "getDomainCertAuthorities", "parameters": [ { @@ -40366,7 +40389,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\ncertAuthorityName|x|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "createDomainCertAuthority", "parameters": [ { @@ -40464,7 +40487,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Domain Certificate Authority object.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncertAuthorityName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Get a Domain Certificate Authority object.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "getDomainCertAuthority", "parameters": [ { @@ -40514,7 +40537,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "updateDomainCertAuthority", "parameters": [ { @@ -40573,7 +40596,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncertAuthorityName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", + "description": "Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nCertificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.19.", "operationId": "replaceDomainCertAuthority", "parameters": [ { @@ -40689,7 +40712,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName||||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled||||||x|\ndistributedCacheManagementEnabled||||||x|\nmsgVpnName|x|x|x||||\nreplicationBridgeAuthenticationBasicPassword|||||x||x\nreplicationBridgeAuthenticationClientCertContent|||||x||x\nreplicationBridgeAuthenticationClientCertPassword|||||x||\nreplicationEnabledQueueBehavior|||||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled||||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Required|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x|x|||\nreplicationBridgeAuthenticationBasicPassword||||x||x\nreplicationBridgeAuthenticationClientCertContent||||x||x\nreplicationBridgeAuthenticationClientCertPassword||||x||\nreplicationEnabledQueueBehavior||||x||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpn", "parameters": [ { @@ -40837,7 +40860,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Message VPN object. Any attribute missing from the request will be left unchanged.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||||x|\ndistributedCacheManagementEnabled|||||||x|\nmsgVpnName|x|x||||||\nreplicationBridgeAuthenticationBasicPassword||||x||||x\nreplicationBridgeAuthenticationClientCertContent||||x||||x\nreplicationBridgeAuthenticationClientCertPassword||||x||||\nreplicationEnabledQueueBehavior||||x||||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||||x|\nserviceAmqpPlainTextListenPort||||||x||\nserviceAmqpTlsListenPort||||||x||\nserviceMqttPlainTextListenPort||||||x||\nserviceMqttTlsListenPort||||||x||\nserviceMqttTlsWebSocketListenPort||||||x||\nserviceMqttWebSocketListenPort||||||x||\nserviceRestIncomingPlainTextListenPort||||||x||\nserviceRestIncomingTlsListenPort||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", + "description": "Update a Message VPN object. Any attribute missing from the request will be left unchanged.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\nreplicationBridgeAuthenticationBasicPassword|||x|||x\nreplicationBridgeAuthenticationClientCertContent|||x|||x\nreplicationBridgeAuthenticationClientCertPassword|||x|||\nreplicationEnabledQueueBehavior|||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\nserviceAmqpPlainTextListenPort||||x||\nserviceAmqpTlsListenPort||||x||\nserviceMqttPlainTextListenPort||||x||\nserviceMqttTlsListenPort||||x||\nserviceMqttTlsWebSocketListenPort||||x||\nserviceMqttWebSocketListenPort||||x||\nserviceRestIncomingPlainTextListenPort||||x||\nserviceRestIncomingTlsListenPort||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxKafkaBrokerConnectionCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", "operationId": "updateMsgVpn", "parameters": [ { @@ -40896,7 +40919,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||||x|\ndistributedCacheManagementEnabled|||||||x|\nmsgVpnName|x|x||||||\nreplicationBridgeAuthenticationBasicPassword||||x||||x\nreplicationBridgeAuthenticationClientCertContent||||x||||x\nreplicationBridgeAuthenticationClientCertPassword||||x||||\nreplicationEnabledQueueBehavior||||x||||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||||x|\nserviceAmqpPlainTextListenPort||||||x||\nserviceAmqpTlsListenPort||||||x||\nserviceMqttPlainTextListenPort||||||x||\nserviceMqttTlsListenPort||||||x||\nserviceMqttTlsWebSocketListenPort||||||x||\nserviceMqttWebSocketListenPort||||||x||\nserviceRestIncomingPlainTextListenPort||||||x||\nserviceRestIncomingTlsListenPort||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", + "description": "Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying|Const|Write-Only|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationOauthDefaultProviderName|||||x|\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\ndistributedCacheManagementEnabled|||||x|\nmsgVpnName|x|x||||\nreplicationBridgeAuthenticationBasicPassword|||x|||x\nreplicationBridgeAuthenticationClientCertContent|||x|||x\nreplicationBridgeAuthenticationClientCertPassword|||x|||\nreplicationEnabledQueueBehavior|||x|||\nrestTlsServerCertEnforceTrustedCommonNameEnabled|||||x|\nserviceAmqpPlainTextListenPort||||x||\nserviceAmqpTlsListenPort||||x||\nserviceMqttPlainTextListenPort||||x||\nserviceMqttTlsListenPort||||x||\nserviceMqttTlsWebSocketListenPort||||x||\nserviceMqttWebSocketListenPort||||x||\nserviceRestIncomingPlainTextListenPort||||x||\nserviceRestIncomingTlsListenPort||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpn|authenticationBasicProfileName|authenticationBasicType|\nMsgVpn|authorizationProfileName|authorizationType|\nMsgVpn|eventPublishTopicFormatMqttEnabled|eventPublishTopicFormatSmfEnabled|\nMsgVpn|eventPublishTopicFormatSmfEnabled|eventPublishTopicFormatMqttEnabled|\nMsgVpn|replicationBridgeAuthenticationBasicClientUsername|replicationBridgeAuthenticationBasicPassword|\nMsgVpn|replicationBridgeAuthenticationBasicPassword|replicationBridgeAuthenticationBasicClientUsername|\nMsgVpn|replicationBridgeAuthenticationClientCertPassword|replicationBridgeAuthenticationClientCertContent|\nMsgVpn|replicationEnabledQueueBehavior|replicationEnabled|\nMsgVpnEventConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventEgressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventEgressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventEndpointCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventEndpointCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventEndpointCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventIngressMsgRateThreshold|clearValue|setValue|\nMsgVpnEventIngressMsgRateThreshold|setValue|clearValue|\nMsgVpnEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceAmqpConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceAmqpConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceMqttConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceMqttConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceRestIncomingConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceSmfConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceSmfConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventServiceWebConnectionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventServiceWebConnectionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nalias|global/read-write\nauthenticationBasicEnabled|global/read-write\nauthenticationBasicProfileName|global/read-write\nauthenticationBasicRadiusDomain|global/read-write\nauthenticationBasicType|global/read-write\nauthenticationClientCertAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationClientCertCertificateMatchingRulesEnabled|global/read-write\nauthenticationClientCertEnabled|global/read-write\nauthenticationClientCertMaxChainDepth|global/read-write\nauthenticationClientCertRevocationCheckMode|global/read-write\nauthenticationClientCertUsernameSource|global/read-write\nauthenticationClientCertValidateDateEnabled|global/read-write\nauthenticationKerberosAllowApiProvidedUsernameEnabled|global/read-write\nauthenticationKerberosEnabled|global/read-write\nauthenticationOauthEnabled|global/read-write\nbridgingTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nbridgingTlsServerCertMaxChainDepth|global/read-write\nbridgingTlsServerCertValidateDateEnabled|global/read-write\nbridgingTlsServerCertValidateNameEnabled|global/read-write\ndmrEnabled|global/read-write\nexportSubscriptionsEnabled|global/read-write\nmaxConnectionCount|global/read-write\nmaxEgressFlowCount|global/read-write\nmaxEndpointCount|global/read-write\nmaxIngressFlowCount|global/read-write\nmaxKafkaBrokerConnectionCount|global/read-write\nmaxMsgSpoolUsage|global/read-write\nmaxSubscriptionCount|global/read-write\nmaxTransactedSessionCount|global/read-write\nmaxTransactionCount|global/read-write\nmqttRetainMaxMemory|global/read-write\nreplicationBridgeAuthenticationBasicClientUsername|global/read-write\nreplicationBridgeAuthenticationBasicPassword|global/read-write\nreplicationBridgeAuthenticationClientCertContent|global/read-write\nreplicationBridgeAuthenticationClientCertPassword|global/read-write\nreplicationBridgeAuthenticationScheme|global/read-write\nreplicationBridgeCompressedDataEnabled|global/read-write\nreplicationBridgeEgressFlowWindowSize|global/read-write\nreplicationBridgeRetryDelay|global/read-write\nreplicationBridgeTlsEnabled|global/read-write\nreplicationBridgeUnidirectionalClientProfileName|global/read-write\nreplicationEnabled|global/read-write\nreplicationEnabledQueueBehavior|global/read-write\nreplicationQueueMaxMsgSpoolUsage|global/read-write\nreplicationRole|global/read-write\nrestTlsServerCertEnforceTrustedCommonNameEnabled|global/read-write\nrestTlsServerCertMaxChainDepth|global/read-write\nrestTlsServerCertValidateDateEnabled|global/read-write\nrestTlsServerCertValidateNameEnabled|global/read-write\nsempOverMsgBusAdminClientEnabled|global/read-write\nsempOverMsgBusAdminDistributedCacheEnabled|global/read-write\nsempOverMsgBusAdminEnabled|global/read-write\nsempOverMsgBusEnabled|global/read-write\nsempOverMsgBusShowEnabled|global/read-write\nserviceAmqpMaxConnectionCount|global/read-write\nserviceAmqpPlainTextListenPort|global/read-write\nserviceAmqpTlsListenPort|global/read-write\nserviceMqttMaxConnectionCount|global/read-write\nserviceMqttPlainTextListenPort|global/read-write\nserviceMqttTlsListenPort|global/read-write\nserviceMqttTlsWebSocketListenPort|global/read-write\nserviceMqttWebSocketListenPort|global/read-write\nserviceRestIncomingMaxConnectionCount|global/read-write\nserviceRestIncomingPlainTextListenPort|global/read-write\nserviceRestIncomingTlsListenPort|global/read-write\nserviceRestOutgoingMaxConnectionCount|global/read-write\nserviceSmfMaxConnectionCount|global/read-write\nserviceWebMaxConnectionCount|global/read-write\n\n\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpn", "parameters": [ { @@ -40957,7 +40980,7 @@ }, "/msgVpns/{msgVpnName}/aclProfiles": { "get": { - "description": "Get a list of ACL Profile objects.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of ACL Profile objects.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnAclProfiles", "parameters": [ { @@ -41020,7 +41043,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create an ACL Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnAclProfile", "parameters": [ { @@ -41134,7 +41157,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an ACL Profile object.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get an ACL Profile object.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnAclProfile", "parameters": [ { @@ -41192,7 +41215,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an ACL Profile object. Any attribute missing from the request will be left unchanged.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update an ACL Profile object. Any attribute missing from the request will be left unchanged.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\naclProfileName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnAclProfile", "parameters": [ { @@ -41259,7 +41282,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace an ACL Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\naclProfileName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnAclProfile", "parameters": [ { @@ -41328,7 +41351,7 @@ }, "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions": { "get": { - "description": "Get a list of Client Connect Exception objects.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nclientConnectExceptionAddress|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Client Connect Exception objects.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nclientConnectExceptionAddress|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnAclProfileClientConnectExceptions", "parameters": [ { @@ -41398,7 +41421,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|||\nclientConnectExceptionAddress|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Client Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nclientConnectExceptionAddress|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnAclProfileClientConnectException", "parameters": [ { @@ -41526,7 +41549,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Client Connect Exception object.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nclientConnectExceptionAddress|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Client Connect Exception object.\n\nA Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nclientConnectExceptionAddress|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnAclProfileClientConnectException", "parameters": [ { @@ -41594,7 +41617,7 @@ "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishExceptions": { "get": { "deprecated": true, - "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\npublishExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\npublishExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", "operationId": "getMsgVpnAclProfilePublishExceptions", "parameters": [ { @@ -41665,7 +41688,7 @@ }, "post": { "deprecated": true, - "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x||x|\nmsgVpnName|x|||x||x|\npublishExceptionTopic|x|x|x|||x|\ntopicSyntax|x|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|x\nmsgVpnName|x|||x|x\npublishExceptionTopic|x|x|x||x\ntopicSyntax|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", "operationId": "createMsgVpnAclProfilePublishException", "parameters": [ { @@ -41802,7 +41825,7 @@ }, "get": { "deprecated": true, - "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\npublishExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", + "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\npublishExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by publishTopicExceptions.", "operationId": "getMsgVpnAclProfilePublishException", "parameters": [ { @@ -41876,7 +41899,7 @@ }, "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions": { "get": { - "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\npublishTopicException|x|||\npublishTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", + "description": "Get a list of Publish Topic Exception objects.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\npublishTopicException|x\npublishTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnAclProfilePublishTopicExceptions", "parameters": [ { @@ -41946,7 +41969,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|||\nmsgVpnName|x|||x|||\npublishTopicException|x|x|x||||\npublishTopicExceptionSyntax|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Create a Publish Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\npublishTopicException|x|x|x|\npublishTopicExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "createMsgVpnAclProfilePublishTopicException", "parameters": [ { @@ -42081,7 +42104,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\npublishTopicException|x|||\npublishTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Get a Publish Topic Exception object.\n\nA Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\npublishTopicException|x\npublishTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnAclProfilePublishTopicException", "parameters": [ { @@ -42156,7 +42179,7 @@ "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeExceptions": { "get": { "deprecated": true, - "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\nsubscribeExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\nsubscribeExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", "operationId": "getMsgVpnAclProfileSubscribeExceptions", "parameters": [ { @@ -42227,7 +42250,7 @@ }, "post": { "deprecated": true, - "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x||x|\nmsgVpnName|x|||x||x|\nsubscribeExceptionTopic|x|x|x|||x|\ntopicSyntax|x|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|x\nmsgVpnName|x|||x|x\nsubscribeExceptionTopic|x|x|x||x\ntopicSyntax|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", "operationId": "createMsgVpnAclProfileSubscribeException", "parameters": [ { @@ -42364,7 +42387,7 @@ }, "get": { "deprecated": true, - "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x||x|\nmsgVpnName|x||x|\nsubscribeExceptionTopic|x||x|\ntopicSyntax|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", + "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\naclProfileName|x|x\nmsgVpnName|x|x\nsubscribeExceptionTopic|x|x\ntopicSyntax|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.14. Replaced by subscribeTopicExceptions.", "operationId": "getMsgVpnAclProfileSubscribeException", "parameters": [ { @@ -42438,7 +42461,7 @@ }, "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions": { "get": { - "description": "Get a list of Subscribe Share Name Exception objects.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeShareNameException|x|||\nsubscribeShareNameExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", + "description": "Get a list of Subscribe Share Name Exception objects.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeShareNameException|x\nsubscribeShareNameExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnAclProfileSubscribeShareNameExceptions", "parameters": [ { @@ -42508,7 +42531,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|||\nmsgVpnName|x|||x|||\nsubscribeShareNameException|x|x|x||||\nsubscribeShareNameExceptionSyntax|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Create a Subscribe Share Name Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\nsubscribeShareNameException|x|x|x|\nsubscribeShareNameExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "createMsgVpnAclProfileSubscribeShareNameException", "parameters": [ { @@ -42643,7 +42666,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Subscribe Share Name Exception object.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeShareNameException|x|||\nsubscribeShareNameExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Get a Subscribe Share Name Exception object.\n\nA Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeShareNameException|x\nsubscribeShareNameExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnAclProfileSubscribeShareNameException", "parameters": [ { @@ -42717,7 +42740,7 @@ }, "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions": { "get": { - "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeTopicException|x|||\nsubscribeTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", + "description": "Get a list of Subscribe Topic Exception objects.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeTopicException|x\nsubscribeTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnAclProfileSubscribeTopicExceptions", "parameters": [ { @@ -42787,7 +42810,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|x|||x|||\nmsgVpnName|x|||x|||\nsubscribeTopicException|x|x|x||||\nsubscribeTopicExceptionSyntax|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Create a Subscribe Topic Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||x\nmsgVpnName|x|||x\nsubscribeTopicException|x|x|x|\nsubscribeTopicExceptionSyntax|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "createMsgVpnAclProfileSubscribeTopicException", "parameters": [ { @@ -42922,7 +42945,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\naclProfileName|x|||\nmsgVpnName|x|||\nsubscribeTopicException|x|||\nsubscribeTopicExceptionSyntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Get a Subscribe Topic Exception object.\n\nA Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\naclProfileName|x\nmsgVpnName|x\nsubscribeTopicException|x\nsubscribeTopicExceptionSyntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnAclProfileSubscribeTopicException", "parameters": [ { @@ -42996,7 +43019,7 @@ }, "/msgVpns/{msgVpnName}/authenticationOauthProfiles": { "get": { - "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", "operationId": "getMsgVpnAuthenticationOauthProfiles", "parameters": [ { @@ -43059,7 +43082,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret|||||x||x\nmsgVpnName|x|||x|||\noauthProfileName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret|||||x|x\nmsgVpnName|x|||x||\noauthProfileName|x|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "createMsgVpnAuthenticationOauthProfile", "parameters": [ { @@ -43173,7 +43196,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "getMsgVpnAuthenticationOauthProfile", "parameters": [ { @@ -43231,7 +43254,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x||||x\nmsgVpnName|x||x|||||\noauthProfileName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "updateMsgVpnAuthenticationOauthProfile", "parameters": [ { @@ -43298,7 +43321,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x||||x\nmsgVpnName|x||x|||||\noauthProfileName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "replaceMsgVpnAuthenticationOauthProfile", "parameters": [ { @@ -43367,7 +43390,7 @@ }, "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaims", "parameters": [ { @@ -43437,7 +43460,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x||||\nclientRequiredClaimValue||x|x||||\nmsgVpnName|x|||x|||\noauthProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x|\nclientRequiredClaimValue||x|x|\nmsgVpnName|x|||x\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "createMsgVpnAuthenticationOauthProfileClientRequiredClaim", "parameters": [ { @@ -43565,7 +43588,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaim", "parameters": [ { @@ -43632,7 +43655,7 @@ }, "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims", "parameters": [ { @@ -43702,7 +43725,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\noauthProfileName|x|||x|||\nresourceServerRequiredClaimName|x|x|x||||\nresourceServerRequiredClaimValue||x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\noauthProfileName|x|||x\nresourceServerRequiredClaimName|x|x|x|\nresourceServerRequiredClaimValue||x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "createMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", "parameters": [ { @@ -43830,7 +43853,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaim", "parameters": [ { @@ -44137,7 +44160,7 @@ }, "patch": { "deprecated": true, - "description": "Update an OAuth Provider object. Any attribute missing from the request will be left unchanged.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||||x|\naudienceClaimSource|||||||x|\naudienceClaimValue|||||||x|\naudienceValidationEnabled|||||||x|\nauthorizationGroupClaimName|||||||x|\nauthorizationGroupClaimSource|||||||x|\nauthorizationGroupEnabled|||||||x|\ndisconnectOnTokenExpirationEnabled|||||||x|\nenabled|||||||x|\njwksRefreshInterval|||||||x|\njwksUri|||||||x|\nmsgVpnName|x||x||||x|\noauthProviderName|x|x|||||x|\ntokenIgnoreTimeLimitsEnabled|||||||x|\ntokenIntrospectionParameterName|||||||x|\ntokenIntrospectionPassword||||x|||x|x\ntokenIntrospectionTimeout|||||||x|\ntokenIntrospectionUri|||||||x|\ntokenIntrospectionUsername|||||||x|\nusernameClaimName|||||||x|\nusernameClaimSource|||||||x|\nusernameValidateEnabled|||||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "description": "Update an OAuth Provider object. Any attribute missing from the request will be left unchanged.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x||x||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword||||x|x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", "operationId": "updateMsgVpnAuthenticationOauthProvider", "parameters": [ { @@ -44205,7 +44228,7 @@ }, "put": { "deprecated": true, - "description": "Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||||x|\naudienceClaimSource|||||||x|\naudienceClaimValue|||||||x|\naudienceValidationEnabled|||||||x|\nauthorizationGroupClaimName|||||||x|\nauthorizationGroupClaimSource|||||||x|\nauthorizationGroupEnabled|||||||x|\ndisconnectOnTokenExpirationEnabled|||||||x|\nenabled|||||||x|\njwksRefreshInterval|||||||x|\njwksUri|||||||x|\nmsgVpnName|x||x||||x|\noauthProviderName|x|x|||||x|\ntokenIgnoreTimeLimitsEnabled|||||||x|\ntokenIntrospectionParameterName|||||||x|\ntokenIntrospectionPassword||||x|||x|x\ntokenIntrospectionTimeout|||||||x|\ntokenIntrospectionUri|||||||x|\ntokenIntrospectionUsername|||||||x|\nusernameClaimName|||||||x|\nusernameClaimSource|||||||x|\nusernameValidateEnabled|||||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", + "description": "Replace an OAuth Provider object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naudienceClaimName|||||x|\naudienceClaimSource|||||x|\naudienceClaimValue|||||x|\naudienceValidationEnabled|||||x|\nauthorizationGroupClaimName|||||x|\nauthorizationGroupClaimSource|||||x|\nauthorizationGroupEnabled|||||x|\ndisconnectOnTokenExpirationEnabled|||||x|\nenabled|||||x|\njwksRefreshInterval|||||x|\njwksUri|||||x|\nmsgVpnName|x||x||x|\noauthProviderName|x|x|||x|\ntokenIgnoreTimeLimitsEnabled|||||x|\ntokenIntrospectionParameterName|||||x|\ntokenIntrospectionPassword||||x|x|x\ntokenIntrospectionTimeout|||||x|\ntokenIntrospectionUri|||||x|\ntokenIntrospectionUsername|||||x|\nusernameClaimName|||||x|\nusernameClaimSource|||||x|\nusernameValidateEnabled|||||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.25. Replaced by authenticationOauthProfiles.", "operationId": "replaceMsgVpnAuthenticationOauthProvider", "parameters": [ { @@ -44274,7 +44297,7 @@ }, "/msgVpns/{msgVpnName}/authorizationGroups": { "get": { - "description": "Get a list of Authorization Group objects.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|||\nmsgVpnName|x|||\norderAfterAuthorizationGroupName||x||\norderBeforeAuthorizationGroupName||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Authorization Group objects.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorizationGroupName|x|\nmsgVpnName|x|\norderAfterAuthorizationGroupName||x\norderBeforeAuthorizationGroupName||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnAuthorizationGroups", "parameters": [ { @@ -44337,7 +44360,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|x|x||||\nmsgVpnName|x|||x|||\norderAfterAuthorizationGroupName|||||x||\norderBeforeAuthorizationGroupName|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create an Authorization Group object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only\n:---|:---:|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|x|x||\nmsgVpnName|x|||x|\norderAfterAuthorizationGroupName|||||x\norderBeforeAuthorizationGroupName|||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnAuthorizationGroup", "parameters": [ { @@ -44451,7 +44474,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an Authorization Group object.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationGroupName|x|||\nmsgVpnName|x|||\norderAfterAuthorizationGroupName||x||\norderBeforeAuthorizationGroupName||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get an Authorization Group object.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorizationGroupName|x|\nmsgVpnName|x|\norderAfterAuthorizationGroupName||x\norderBeforeAuthorizationGroupName||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnAuthorizationGroup", "parameters": [ { @@ -44509,7 +44532,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an Authorization Group object. Any attribute missing from the request will be left unchanged.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName||||||x||\nauthorizationGroupName|x|x||||||\nclientProfileName||||||x||\nmsgVpnName|x||x|||||\norderAfterAuthorizationGroupName||||x||||\norderBeforeAuthorizationGroupName||||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update an Authorization Group object. Any attribute missing from the request will be left unchanged.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x\nauthorizationGroupName|x|x|||\nclientProfileName|||||x\nmsgVpnName|x||x||\norderAfterAuthorizationGroupName||||x|\norderBeforeAuthorizationGroupName||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnAuthorizationGroup", "parameters": [ { @@ -44576,7 +44599,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName||||||x||\nauthorizationGroupName|x|x||||||\nclientProfileName||||||x||\nmsgVpnName|x||x|||||\norderAfterAuthorizationGroupName||||x||||\norderBeforeAuthorizationGroupName||||x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName||orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName||orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x\nauthorizationGroupName|x|x|||\nclientProfileName|||||x\nmsgVpnName|x||x||\norderAfterAuthorizationGroupName||||x|\norderBeforeAuthorizationGroupName||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Conflicts\n:---|:---|:---\nMsgVpnAuthorizationGroup|orderAfterAuthorizationGroupName|orderBeforeAuthorizationGroupName\nMsgVpnAuthorizationGroup|orderBeforeAuthorizationGroupName|orderAfterAuthorizationGroupName\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnAuthorizationGroup", "parameters": [ { @@ -44645,7 +44668,7 @@ }, "/msgVpns/{msgVpnName}/bridges": { "get": { - "description": "Get a list of Bridge objects.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteAuthenticationBasicPassword||x||x\nremoteAuthenticationClientCertContent||x||x\nremoteAuthenticationClientCertPassword||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Bridge objects.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\nremoteAuthenticationBasicPassword||x|x\nremoteAuthenticationClientCertContent||x|x\nremoteAuthenticationClientCertPassword||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnBridges", "parameters": [ { @@ -44708,7 +44731,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x|x||||\nbridgeVirtualRouter|x|x|x||||\nmsgVpnName|x|||x|||\nremoteAuthenticationBasicPassword|||||x||x\nremoteAuthenticationClientCertContent|||||x||x\nremoteAuthenticationClientCertPassword|||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword|\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername|\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x|x|||\nbridgeVirtualRouter|x|x|x|||\nmsgVpnName|x|||x||\nremoteAuthenticationBasicPassword|||||x|x\nremoteAuthenticationClientCertContent|||||x|x\nremoteAuthenticationClientCertPassword|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnBridge", "parameters": [ { @@ -44829,7 +44852,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Bridge object.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteAuthenticationBasicPassword||x||x\nremoteAuthenticationClientCertContent||x||x\nremoteAuthenticationClientCertPassword||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Bridge object.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\nremoteAuthenticationBasicPassword||x|x\nremoteAuthenticationClientCertContent||x|x\nremoteAuthenticationClientCertPassword||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnBridge", "parameters": [ { @@ -44894,7 +44917,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Bridge object. Any attribute missing from the request will be left unchanged.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||||\nbridgeVirtualRouter|x|x||||||\nmaxTtl||||||x||\nmsgVpnName|x||x|||||\nremoteAuthenticationBasicClientUsername||||||x||\nremoteAuthenticationBasicPassword||||x||x||x\nremoteAuthenticationClientCertContent||||x||x||x\nremoteAuthenticationClientCertPassword||||x||x||\nremoteAuthenticationScheme||||||x||\nremoteDeliverToOnePriority||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword|\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername|\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a Bridge object. Any attribute missing from the request will be left unchanged.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmaxTtl|||||x|\nmsgVpnName|x||x|||\nremoteAuthenticationBasicClientUsername|||||x|\nremoteAuthenticationBasicPassword||||x|x|x\nremoteAuthenticationClientCertContent||||x|x|x\nremoteAuthenticationClientCertPassword||||x|x|\nremoteAuthenticationScheme|||||x|\nremoteDeliverToOnePriority|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnBridge", "parameters": [ { @@ -44968,7 +44991,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||||\nbridgeVirtualRouter|x|x||||||\nmaxTtl||||||x||\nmsgVpnName|x||x|||||\nremoteAuthenticationBasicClientUsername||||||x||\nremoteAuthenticationBasicPassword||||x||x||x\nremoteAuthenticationClientCertContent||||x||x||x\nremoteAuthenticationClientCertPassword||||x||x||\nremoteAuthenticationScheme||||||x||\nremoteDeliverToOnePriority||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword|\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername|\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|x||||\nbridgeVirtualRouter|x|x||||\nmaxTtl|||||x|\nmsgVpnName|x||x|||\nremoteAuthenticationBasicClientUsername|||||x|\nremoteAuthenticationBasicPassword||||x|x|x\nremoteAuthenticationClientCertContent||||x|x|x\nremoteAuthenticationClientCertPassword||||x|x|\nremoteAuthenticationScheme|||||x|\nremoteDeliverToOnePriority|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridge|remoteAuthenticationBasicClientUsername|remoteAuthenticationBasicPassword\nMsgVpnBridge|remoteAuthenticationBasicPassword|remoteAuthenticationBasicClientUsername\nMsgVpnBridge|remoteAuthenticationClientCertPassword|remoteAuthenticationClientCertContent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnBridge", "parameters": [ { @@ -45044,7 +45067,7 @@ }, "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns": { "get": { - "description": "Get a list of Remote Message VPN objects.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\npassword||x||x\nremoteMsgVpnInterface|x|||\nremoteMsgVpnLocation|x|||\nremoteMsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Remote Message VPN objects.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\npassword||x|x\nremoteMsgVpnInterface|x||\nremoteMsgVpnLocation|x||\nremoteMsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnBridgeRemoteMsgVpns", "parameters": [ { @@ -45112,7 +45135,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x|||\nbridgeVirtualRouter|x|||x|||\nmsgVpnName|x|||x|||\npassword|||||x||x\nremoteMsgVpnInterface|x|x|||||\nremoteMsgVpnLocation|x|x|x||||\nremoteMsgVpnName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password|\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Remote Message VPN object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x||\nbridgeVirtualRouter|x|||x||\nmsgVpnName|x|||x||\npassword|||||x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x|x|||\nremoteMsgVpnName|x|x|x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnBridgeRemoteMsgVpn", "parameters": [ { @@ -45268,7 +45291,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Remote Message VPN object.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\npassword||x||x\nremoteMsgVpnInterface|x|||\nremoteMsgVpnLocation|x|||\nremoteMsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Remote Message VPN object.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridgeName|x||\nbridgeVirtualRouter|x||\nmsgVpnName|x||\npassword||x|x\nremoteMsgVpnInterface|x||\nremoteMsgVpnLocation|x||\nremoteMsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnBridgeRemoteMsgVpn", "parameters": [ { @@ -45354,7 +45377,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||||\nbridgeVirtualRouter|x||x|||||\nclientUsername||||||x||\ncompressedDataEnabled||||||x||\negressFlowWindowSize||||||x||\nmsgVpnName|x||x|||||\npassword||||x||x||x\nremoteMsgVpnInterface|x|x||||||\nremoteMsgVpnLocation|x|x||||||\nremoteMsgVpnName|x|x||||||\ntlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password|\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a Remote Message VPN object. Any attribute missing from the request will be left unchanged.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\nclientUsername|||||x|\ncompressedDataEnabled|||||x|\negressFlowWindowSize|||||x|\nmsgVpnName|x||x|||\npassword||||x|x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnBridgeRemoteMsgVpn", "parameters": [ { @@ -45449,7 +45472,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||||\nbridgeVirtualRouter|x||x|||||\nclientUsername||||||x||\ncompressedDataEnabled||||||x||\negressFlowWindowSize||||||x||\nmsgVpnName|x||x|||||\npassword||||x||x||x\nremoteMsgVpnInterface|x|x||||||\nremoteMsgVpnLocation|x|x||||||\nremoteMsgVpnName|x|x||||||\ntlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password|\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x||x|||\nbridgeVirtualRouter|x||x|||\nclientUsername|||||x|\ncompressedDataEnabled|||||x|\negressFlowWindowSize|||||x|\nmsgVpnName|x||x|||\npassword||||x|x|x\nremoteMsgVpnInterface|x|x||||\nremoteMsgVpnLocation|x|x||||\nremoteMsgVpnName|x|x||||\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnBridgeRemoteMsgVpn|clientUsername|password\nMsgVpnBridgeRemoteMsgVpn|password|clientUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnBridgeRemoteMsgVpn", "parameters": [ { @@ -45546,7 +45569,7 @@ }, "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions": { "get": { - "description": "Get a list of Remote Subscription objects.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteSubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Remote Subscription objects.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\nremoteSubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnBridgeRemoteSubscriptions", "parameters": [ { @@ -45623,7 +45646,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x|||\nbridgeVirtualRouter|x|||x|||\ndeliverAlwaysEnabled||x|x||||\nmsgVpnName|x|||x|||\nremoteSubscriptionTopic|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Remote Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||x\nbridgeVirtualRouter|x|||x\ndeliverAlwaysEnabled||x|x|\nmsgVpnName|x|||x\nremoteSubscriptionTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnBridgeRemoteSubscription", "parameters": [ { @@ -45765,7 +45788,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Remote Subscription object.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x|||\nbridgeVirtualRouter|x|||\nmsgVpnName|x|||\nremoteSubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Remote Subscription object.\n\nA Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\nremoteSubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnBridgeRemoteSubscription", "parameters": [ { @@ -45840,7 +45863,7 @@ "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/tlsTrustedCommonNames": { "get": { "deprecated": true, - "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x||x|\nbridgeVirtualRouter|x||x|\nmsgVpnName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nbridgeName|x|x\nbridgeVirtualRouter|x|x\nmsgVpnName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "getMsgVpnBridgeTlsTrustedCommonNames", "parameters": [ { @@ -45909,7 +45932,7 @@ }, "post": { "deprecated": true, - "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x||x|\nbridgeVirtualRouter|x|||x||x|\nmsgVpnName|x|||x||x|\ntlsTrustedCommonName|x|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nbridgeName|x|||x|x\nbridgeVirtualRouter|x|||x|x\nmsgVpnName|x|||x|x\ntlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "createMsgVpnBridgeTlsTrustedCommonName", "parameters": [ { @@ -46053,7 +46076,7 @@ }, "get": { "deprecated": true, - "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridgeName|x||x|\nbridgeVirtualRouter|x||x|\nmsgVpnName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the Bridge are used by encrypted transports to verify the name in the certificate presented by the remote node. They must include the common name of the remote node's server certificate or client certificate, depending upon the initiator of the connection.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nbridgeName|x|x\nbridgeVirtualRouter|x|x\nmsgVpnName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "getMsgVpnBridgeTlsTrustedCommonName", "parameters": [ { @@ -46127,7 +46150,7 @@ }, "/msgVpns/{msgVpnName}/certMatchingRules": { "get": { - "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", + "description": "Get a list of Certificate Matching Rule objects.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnCertMatchingRules", "parameters": [ { @@ -46190,7 +46213,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nruleName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Create a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nruleName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "createMsgVpnCertMatchingRule", "parameters": [ { @@ -46304,7 +46327,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Get a Certificate Matching Rule object.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnCertMatchingRule", "parameters": [ { @@ -46362,7 +46385,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nruleName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Update a Certificate Matching Rule object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "updateMsgVpnCertMatchingRule", "parameters": [ { @@ -46429,7 +46452,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nruleName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Replace a Certificate Matching Rule object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nruleName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "replaceMsgVpnCertMatchingRule", "parameters": [ { @@ -46498,7 +46521,7 @@ }, "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters": { "get": { - "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nfilterName|x|||\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", + "description": "Get a list of Certificate Matching Rule Attribute Filter objects.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilterName|x\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.28.", "operationId": "getMsgVpnCertMatchingRuleAttributeFilters", "parameters": [ { @@ -46568,7 +46591,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nfilterName|x|x|x||||\nmsgVpnName|x|||x|||\nruleName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Create a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nfilterName|x|x|x|\nmsgVpnName|x|||x\nruleName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "createMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { @@ -46696,7 +46719,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nfilterName|x|||\nmsgVpnName|x|||\nruleName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Get a Certificate Matching Rule Attribute Filter object.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilterName|x\nmsgVpnName|x\nruleName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "getMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { @@ -46761,7 +46784,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nfilterName|x|x||||||\nmsgVpnName|x||x|||||\nruleName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Update a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be left unchanged.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nfilterName|x|x|\nmsgVpnName|x||x\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "updateMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { @@ -46835,7 +46858,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nfilterName|x|x||||||\nmsgVpnName|x||x|||||\nruleName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", + "description": "Replace a Certificate Matching Rule Attribute Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nfilterName|x|x|\nmsgVpnName|x||x\nruleName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.28.", "operationId": "replaceMsgVpnCertMatchingRuleAttributeFilter", "parameters": [ { @@ -46911,7 +46934,7 @@ }, "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions": { "get": { - "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", + "description": "Get a list of Certificate Matching Rule Condition objects.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnCertMatchingRuleConditions", "parameters": [ { @@ -46981,7 +47004,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nattribute||x|||||\nexpression||x|||||\nmsgVpnName|x|||x|||\nruleName|x|||x|||\nsource|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Create a Certificate Matching Rule Condition object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattribute||x||\nexpression||x||\nmsgVpnName|x|||x\nruleName|x|||x\nsource|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "createMsgVpnCertMatchingRuleCondition", "parameters": [ { @@ -47109,7 +47132,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nruleName|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Get a Certificate Matching Rule Condition object.\n\nA Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nruleName|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnCertMatchingRuleCondition", "parameters": [ { @@ -47176,7 +47199,7 @@ }, "/msgVpns/{msgVpnName}/clientProfiles": { "get": { - "description": "Get a list of Client Profile objects.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||x|\napiQueueManagementCopyFromOnCreateName|||x|\napiTopicEndpointManagementCopyFromOnCreateName|||x|\nclientProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Client Profile objects.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallowCutThroughForwardingEnabled||x\napiQueueManagementCopyFromOnCreateName||x\napiTopicEndpointManagementCopyFromOnCreateName||x\nclientProfileName|x|\nmsgVpnName|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnClientProfiles", "parameters": [ { @@ -47239,7 +47262,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled||||||x|\napiQueueManagementCopyFromOnCreateName||||||x|\napiTopicEndpointManagementCopyFromOnCreateName||||||x|\nclientProfileName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Client Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||||x\napiQueueManagementCopyFromOnCreateName|||||x\napiTopicEndpointManagementCopyFromOnCreateName|||||x\nclientProfileName|x|x|x||\nmsgVpnName|x|||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnClientProfile", "parameters": [ { @@ -47353,7 +47376,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Client Profile object.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||x|\napiQueueManagementCopyFromOnCreateName|||x|\napiTopicEndpointManagementCopyFromOnCreateName|||x|\nclientProfileName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Client Profile object.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallowCutThroughForwardingEnabled||x\napiQueueManagementCopyFromOnCreateName||x\napiTopicEndpointManagementCopyFromOnCreateName||x\nclientProfileName|x|\nmsgVpnName|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnClientProfile", "parameters": [ { @@ -47411,7 +47434,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Client Profile object. Any attribute missing from the request will be left unchanged.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||||||x|\napiQueueManagementCopyFromOnCreateName|||||||x|\napiTopicEndpointManagementCopyFromOnCreateName|||||||x|\nclientProfileName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a Client Profile object. Any attribute missing from the request will be left unchanged.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled||||x\napiQueueManagementCopyFromOnCreateName||||x\napiTopicEndpointManagementCopyFromOnCreateName||||x\nclientProfileName|x|x||\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnClientProfile", "parameters": [ { @@ -47478,7 +47501,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled|||||||x|\napiQueueManagementCopyFromOnCreateName|||||||x|\napiTopicEndpointManagementCopyFromOnCreateName|||||||x|\nclientProfileName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nClient Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Const|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:\nallowCutThroughForwardingEnabled||||x\napiQueueManagementCopyFromOnCreateName||||x\napiTopicEndpointManagementCopyFromOnCreateName||||x\nclientProfileName|x|x||\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|clearPercent|setPercent|\nMsgVpnClientProfileEventClientProvisionedEndpointSpoolUsageThreshold|setPercent|clearPercent|\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEgressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEgressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventEndpointCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventIngressFlowCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventIngressFlowCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceSmfConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventServiceWebConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventSubscriptionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventSubscriptionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactedSessionCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnClientProfileEventTransactionCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnClientProfileEventTransactionCountThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnClientProfile", "parameters": [ { @@ -47547,7 +47570,7 @@ }, "/msgVpns/{msgVpnName}/clientUsernames": { "get": { - "description": "Get a list of Client Username objects.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientUsername|x|||\nmsgVpnName|x|||\npassword||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Client Username objects.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientUsername|x||\nmsgVpnName|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnClientUsernames", "parameters": [ { @@ -47610,7 +47633,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientUsername|x|x|x||||\nmsgVpnName|x|||x|||\npassword|||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Client Username object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientUsername|x|x|x|||\nmsgVpnName|x|||x||\npassword|||||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnClientUsername", "parameters": [ { @@ -47724,7 +47747,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Client Username object.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientUsername|x|||\nmsgVpnName|x|||\npassword||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Client Username object.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientUsername|x||\nmsgVpnName|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnClientUsername", "parameters": [ { @@ -47782,7 +47805,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Client Username object. Any attribute missing from the request will be left unchanged.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName||||||x||\nclientProfileName||||||x||\nclientUsername|x|x||||||\nmsgVpnName|x||x|||||\npassword||||x||||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a Client Username object. Any attribute missing from the request will be left unchanged.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x|\nclientProfileName|||||x|\nclientUsername|x|x||||\nmsgVpnName|x||x|||\npassword||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnClientUsername", "parameters": [ { @@ -47849,7 +47872,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName||||||x||\nclientProfileName||||||x||\nclientUsername|x|x||||||\nmsgVpnName|x||x|||||\npassword||||x||||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\naclProfileName|||||x|\nclientProfileName|||||x|\nclientUsername|x|x||||\nmsgVpnName|x||x|||\npassword||||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnClientUsername", "parameters": [ { @@ -47918,7 +47941,7 @@ }, "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes": { "get": { - "description": "Get a list of Client Username Attribute objects.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\nclientUsername|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", + "description": "Get a list of Client Username Attribute objects.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\nclientUsername|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnClientUsernameAttributes", "parameters": [ { @@ -47988,7 +48011,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nattributeName|x|x|x||||\nattributeValue|x|x|x||||\nclientUsername|x|||x|||\nmsgVpnName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Create a Client Username Attribute object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nattributeName|x|x|x|\nattributeValue|x|x|x|\nclientUsername|x|||x\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "createMsgVpnClientUsernameAttribute", "parameters": [ { @@ -48123,7 +48146,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Client Username Attribute object.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattributeName|x|||\nattributeValue|x|||\nclientUsername|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Get a Client Username Attribute object.\n\nA ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattributeName|x\nattributeValue|x\nclientUsername|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnClientUsernameAttribute", "parameters": [ { @@ -48197,7 +48220,7 @@ }, "/msgVpns/{msgVpnName}/distributedCaches": { "get": { - "description": "Get a list of Distributed Cache objects.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Distributed Cache objects.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCaches", "parameters": [ { @@ -48260,7 +48283,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x|x||||\ncacheVirtualRouter||x|||||\nmsgVpnName|x|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList|\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Distributed Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|x|x|\ncacheVirtualRouter||x||\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnDistributedCache", "parameters": [ { @@ -48374,7 +48397,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Distributed Cache object.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Distributed Cache object.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCache", "parameters": [ { @@ -48432,7 +48455,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Distributed Cache object. Any attribute missing from the request will be left unchanged.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x||||||\ncacheVirtualRouter||x||||||\nmsgVpnName|x||x|||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList|\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Update a Distributed Cache object. Any attribute missing from the request will be left unchanged.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\ncacheVirtualRouter||x|\nmsgVpnName|x||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "updateMsgVpnDistributedCache", "parameters": [ { @@ -48499,7 +48522,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x||||||\ncacheVirtualRouter||x||||||\nmsgVpnName|x||x|||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList|\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\ncacheVirtualRouter||x|\nmsgVpnName|x||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCache|scheduledDeleteMsgDayList|scheduledDeleteMsgTimeList\nMsgVpnDistributedCache|scheduledDeleteMsgTimeList|scheduledDeleteMsgDayList\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "replaceMsgVpnDistributedCache", "parameters": [ { @@ -48568,7 +48591,7 @@ }, "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters": { "get": { - "description": "Get a list of Cache Cluster objects.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Cache Cluster objects.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusters", "parameters": [ { @@ -48638,7 +48661,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|||x|||\nclusterName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnDistributedCacheCluster", "parameters": [ { @@ -48766,7 +48789,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Cache Cluster object.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Cache Cluster object.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheCluster", "parameters": [ { @@ -48831,7 +48854,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Cache Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||||\nclusterName|x|x||||||\ndeliverToOneOverrideEnabled||||||x||\nmsgVpnName|x||x|||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Update a Cache Cluster object. Any attribute missing from the request will be left unchanged.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ncacheName|x||x|\nclusterName|x|x||\ndeliverToOneOverrideEnabled||||x\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "updateMsgVpnDistributedCacheCluster", "parameters": [ { @@ -48905,7 +48928,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||||\nclusterName|x|x||||||\ndeliverToOneOverrideEnabled||||||x||\nmsgVpnName|x||x|||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent|\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent|\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue|\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue|\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ncacheName|x||x|\nclusterName|x|x||\ndeliverToOneOverrideEnabled||||x\nmsgVpnName|x||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataByteRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventDataMsgRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxMemoryThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventMaxTopicsThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|clearPercent|setPercent\nMsgVpnDistributedCacheClusterEventRequestQueueDepthThreshold|setPercent|clearPercent\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventRequestRateThreshold|setValue|clearValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|clearValue|setValue\nMsgVpnDistributedCacheClusterEventResponseRateThreshold|setValue|clearValue\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "replaceMsgVpnDistributedCacheCluster", "parameters": [ { @@ -48981,7 +49004,7 @@ }, "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters": { "get": { - "description": "Get a list of Home Cache Cluster objects.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Home Cache Cluster objects.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusters", "parameters": [ { @@ -49058,7 +49081,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|||x|||\nclusterName|x|||x|||\nhomeClusterName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Home Cache Cluster object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nhomeClusterName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", "parameters": [ { @@ -49200,7 +49223,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Home Cache Cluster object.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Home Cache Cluster object.\n\nA Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeCluster", "parameters": [ { @@ -49274,7 +49297,7 @@ }, "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes": { "get": { - "description": "Get a list of Topic Prefix objects.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\ntopicPrefix|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Topic Prefix objects.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\ntopicPrefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefixes", "parameters": [ { @@ -49358,7 +49381,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|||x|||\nclusterName|x|||x|||\nhomeClusterName|x|||x|||\nmsgVpnName|x|||x|||\ntopicPrefix|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Topic Prefix object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nhomeClusterName|x|||x\nmsgVpnName|x|||x\ntopicPrefix|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", "parameters": [ { @@ -49514,7 +49537,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic Prefix object.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nhomeClusterName|x|||\nmsgVpnName|x|||\ntopicPrefix|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Topic Prefix object.\n\nA Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nhomeClusterName|x\nmsgVpnName|x\ntopicPrefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix", "parameters": [ { @@ -49595,7 +49618,7 @@ }, "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances": { "get": { - "description": "Get a list of Cache Instance objects.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\ninstanceName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Cache Instance objects.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterInstances", "parameters": [ { @@ -49672,7 +49695,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|||x|||\nclusterName|x|||x|||\ninstanceName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Cache Instance object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\ninstanceName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnDistributedCacheClusterInstance", "parameters": [ { @@ -49814,7 +49837,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Cache Instance object.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\ninstanceName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Cache Instance object.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterInstance", "parameters": [ { @@ -49886,7 +49909,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Cache Instance object. Any attribute missing from the request will be left unchanged.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||||\nclusterName|x||x|||||\ninstanceName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Update a Cache Instance object. Any attribute missing from the request will be left unchanged.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x||x\nclusterName|x||x\ninstanceName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "updateMsgVpnDistributedCacheClusterInstance", "parameters": [ { @@ -49967,7 +49990,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x||x|||||\nclusterName|x||x|||||\ninstanceName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Replace a Cache Instance object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x||x\nclusterName|x||x\ninstanceName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "replaceMsgVpnDistributedCacheClusterInstance", "parameters": [ { @@ -50050,7 +50073,7 @@ }, "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics": { "get": { - "description": "Get a list of Topic objects.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\ntopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of Topic objects.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterTopics", "parameters": [ { @@ -50127,7 +50150,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|||x|||\nclusterName|x|||x|||\nmsgVpnName|x|||x|||\ntopic|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||x\nclusterName|x|||x\nmsgVpnName|x|||x\ntopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnDistributedCacheClusterTopic", "parameters": [ { @@ -50269,7 +50292,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic object.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nclusterName|x|||\nmsgVpnName|x|||\ntopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a Topic object.\n\nThe Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDistributedCacheClusterTopic", "parameters": [ { @@ -50343,7 +50366,7 @@ }, "/msgVpns/{msgVpnName}/dmrBridges": { "get": { - "description": "Get a list of DMR Bridge objects.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of DMR Bridge objects.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDmrBridges", "parameters": [ { @@ -50406,7 +50429,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nremoteNodeName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nremoteNodeName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnDmrBridge", "parameters": [ { @@ -50520,7 +50543,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a DMR Bridge object.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nremoteNodeName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get a DMR Bridge object.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDmrBridge", "parameters": [ { @@ -50578,7 +50601,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a DMR Bridge object. Any attribute missing from the request will be left unchanged.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nremoteNodeName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Update a DMR Bridge object. Any attribute missing from the request will be left unchanged.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nremoteNodeName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "updateMsgVpnDmrBridge", "parameters": [ { @@ -50645,7 +50668,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nremoteNodeName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Replace a DMR Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nremoteNodeName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "replaceMsgVpnDmrBridge", "parameters": [ { @@ -50714,7 +50737,7 @@ }, "/msgVpns/{msgVpnName}/jndiConnectionFactories": { "get": { - "description": "Get a list of JNDI Connection Factory objects.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", + "description": "Get a list of JNDI Connection Factory objects.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnectionFactoryName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", "operationId": "getMsgVpnJndiConnectionFactories", "parameters": [ { @@ -50777,7 +50800,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Create a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "createMsgVpnJndiConnectionFactory", "parameters": [ { @@ -50891,7 +50914,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a JNDI Connection Factory object.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Get a JNDI Connection Factory object.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnectionFactoryName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "getMsgVpnJndiConnectionFactory", "parameters": [ { @@ -50949,7 +50972,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Update a JNDI Connection Factory object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nconnectionFactoryName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "updateMsgVpnJndiConnectionFactory", "parameters": [ { @@ -51016,7 +51039,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nconnectionFactoryName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Replace a JNDI Connection Factory object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nconnectionFactoryName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "replaceMsgVpnJndiConnectionFactory", "parameters": [ { @@ -51085,7 +51108,7 @@ }, "/msgVpns/{msgVpnName}/jndiQueues": { "get": { - "description": "Get a list of JNDI Queue objects.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", + "description": "Get a list of JNDI Queue objects.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", "operationId": "getMsgVpnJndiQueues", "parameters": [ { @@ -51148,7 +51171,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nqueueName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Create a JNDI Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "createMsgVpnJndiQueue", "parameters": [ { @@ -51262,7 +51285,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a JNDI Queue object.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Get a JNDI Queue object.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "getMsgVpnJndiQueue", "parameters": [ { @@ -51320,7 +51343,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a JNDI Queue object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nqueueName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Update a JNDI Queue object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "updateMsgVpnJndiQueue", "parameters": [ { @@ -51387,7 +51410,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nqueueName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Replace a JNDI Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "replaceMsgVpnJndiQueue", "parameters": [ { @@ -51456,7 +51479,7 @@ }, "/msgVpns/{msgVpnName}/jndiTopics": { "get": { - "description": "Get a list of JNDI Topic objects.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", + "description": "Get a list of JNDI Topic objects.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.2.", "operationId": "getMsgVpnJndiTopics", "parameters": [ { @@ -51519,7 +51542,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\ntopicName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Create a JNDI Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "createMsgVpnJndiTopic", "parameters": [ { @@ -51633,7 +51656,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a JNDI Topic object.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Get a JNDI Topic object.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "getMsgVpnJndiTopic", "parameters": [ { @@ -51691,7 +51714,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a JNDI Topic object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntopicName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Update a JNDI Topic object. Any attribute missing from the request will be left unchanged.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "updateMsgVpnJndiTopic", "parameters": [ { @@ -51758,7 +51781,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntopicName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", + "description": "Replace a JNDI Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.2.", "operationId": "replaceMsgVpnJndiTopic", "parameters": [ { @@ -51827,7 +51850,7 @@ }, "/msgVpns/{msgVpnName}/kafkaReceivers": { "get": { - "description": "Get a list of Kafka Receiver objects.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationOauthClientSecret||x||x\nauthenticationScramPassword||x||x\nkafkaReceiverName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Kafka Receiver objects.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaReceivers", "parameters": [ { @@ -51890,7 +51913,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Kafka Receiver object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\nauthenticationClientCertContent|||||x||x\nauthenticationClientCertPassword|||||x||\nauthenticationOauthClientSecret|||||x||x\nauthenticationScramPassword|||||x||x\nkafkaReceiverName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername|\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Create a Kafka Receiver object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaReceiverName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "createMsgVpnKafkaReceiver", "parameters": [ { @@ -51952,7 +51975,7 @@ }, "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}": { "delete": { - "description": "Delete a Kafka Receiver object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Delete a Kafka Receiver object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "deleteMsgVpnKafkaReceiver", "parameters": [ { @@ -52004,7 +52027,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Kafka Receiver object.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationOauthClientSecret||x||x\nauthenticationScramPassword||x||x\nkafkaReceiverName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Get a Kafka Receiver object.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaReceiver", "parameters": [ { @@ -52062,7 +52085,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Kafka Receiver object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationBasicUsername||||||x||\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\nauthenticationOauthClientId||||||x||\nauthenticationOauthClientScope||||||x||\nauthenticationOauthClientSecret||||x||x||x\nauthenticationOauthClientTokenEndpoint||||||x||\nauthenticationScheme||||||x||\nauthenticationScramHash||||||x||\nauthenticationScramPassword||||x||x||x\nauthenticationScramUsername||||||x||\nbatchDelay||||||x||\nbatchMaxSize||||||x||\nbootstrapAddressList||||||x||\ngroupId||||||x||\ngroupKeepaliveInterval||||||x||\ngroupKeepaliveTimeout||||||x||\ngroupMembershipType||||||x||\ngroupPartitionSchemeList||||||x||\nkafkaReceiverName|x|x||||||\nmetadataTopicExcludeList||||||x||\nmetadataTopicRefreshInterval||||||x||\nmsgVpnName|x||x|||||\ntransportTlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername|\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Update a Kafka Receiver object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\ngroupId|||||x|\ngroupKeepaliveInterval|||||x|\ngroupKeepaliveTimeout|||||x|\ngroupMembershipType|||||x|\ngroupPartitionSchemeList|||||x|\nkafkaReceiverName|x|x||||\nmetadataTopicExcludeList|||||x|\nmetadataTopicRefreshInterval|||||x|\nmsgVpnName|x||x|||\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "updateMsgVpnKafkaReceiver", "parameters": [ { @@ -52129,7 +52152,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Kafka Receiver object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationBasicUsername||||||x||\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\nauthenticationOauthClientId||||||x||\nauthenticationOauthClientScope||||||x||\nauthenticationOauthClientSecret||||x||x||x\nauthenticationOauthClientTokenEndpoint||||||x||\nauthenticationScheme||||||x||\nauthenticationScramHash||||||x||\nauthenticationScramPassword||||x||x||x\nauthenticationScramUsername||||||x||\nbatchDelay||||||x||\nbatchMaxSize||||||x||\nbootstrapAddressList||||||x||\ngroupId||||||x||\ngroupKeepaliveInterval||||||x||\ngroupKeepaliveTimeout||||||x||\ngroupMembershipType||||||x||\ngroupPartitionSchemeList||||||x||\nkafkaReceiverName|x|x||||||\nmetadataTopicExcludeList||||||x||\nmetadataTopicRefreshInterval||||||x||\nmsgVpnName|x||x|||||\ntransportTlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername|\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Replace a Kafka Receiver object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\ngroupId|||||x|\ngroupKeepaliveInterval|||||x|\ngroupKeepaliveTimeout|||||x|\ngroupMembershipType|||||x|\ngroupPartitionSchemeList|||||x|\nkafkaReceiverName|x|x||||\nmetadataTopicExcludeList|||||x|\nmetadataTopicRefreshInterval|||||x|\nmsgVpnName|x||x|||\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "replaceMsgVpnKafkaReceiver", "parameters": [ { @@ -52198,7 +52221,7 @@ }, "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}/topicBindings": { "get": { - "description": "Get a list of Topic Binding objects.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nkafkaReceiverName|x|||\nmsgVpnName|x|||\ntopicName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Topic Binding objects.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaReceiverName|x\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaReceiverTopicBindings", "parameters": [ { @@ -52268,7 +52291,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nkafkaReceiverName|x|||x|||\nmsgVpnName|x|||x|||\ntopicName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Create a Topic Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nkafkaReceiverName|x|||x\nmsgVpnName|x|||x\ntopicName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "createMsgVpnKafkaReceiverTopicBinding", "parameters": [ { @@ -52396,7 +52419,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic Binding object.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nkafkaReceiverName|x|||\nmsgVpnName|x|||\ntopicName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Get a Topic Binding object.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaReceiverName|x\nmsgVpnName|x\ntopicName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaReceiverTopicBinding", "parameters": [ { @@ -52461,7 +52484,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Topic Binding object. Any attribute missing from the request will be left unchanged.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ninitialOffset||||||x||\nkafkaReceiverName|x||x|||||\nlocalKey||||||x||\nlocalTopic||||||x||\nmsgVpnName|x||x|||||\ntopicName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Update a Topic Binding object. Any attribute missing from the request will be left unchanged.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ninitialOffset||||x\nkafkaReceiverName|x||x|\nlocalKey||||x\nlocalTopic||||x\nmsgVpnName|x||x|\ntopicName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "updateMsgVpnKafkaReceiverTopicBinding", "parameters": [ { @@ -52535,7 +52558,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Topic Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ninitialOffset||||||x||\nkafkaReceiverName|x||x|||||\nlocalKey||||||x||\nlocalTopic||||||x||\nmsgVpnName|x||x|||||\ntopicName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Replace a Topic Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\ninitialOffset||||x\nkafkaReceiverName|x||x|\nlocalKey||||x\nlocalTopic||||x\nmsgVpnName|x||x|\ntopicName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "replaceMsgVpnKafkaReceiverTopicBinding", "parameters": [ { @@ -52611,7 +52634,7 @@ }, "/msgVpns/{msgVpnName}/kafkaSenders": { "get": { - "description": "Get a list of Kafka Sender objects.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationOauthClientSecret||x||x\nauthenticationScramPassword||x||x\nkafkaSenderName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Kafka Sender objects.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaSenders", "parameters": [ { @@ -52674,7 +52697,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Kafka Sender object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\nauthenticationClientCertContent|||||x||x\nauthenticationClientCertPassword|||||x||\nauthenticationOauthClientSecret|||||x||x\nauthenticationScramPassword|||||x||x\nkafkaSenderName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername|\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Create a Kafka Sender object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaSenderName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "createMsgVpnKafkaSender", "parameters": [ { @@ -52736,7 +52759,7 @@ }, "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}": { "delete": { - "description": "Delete a Kafka Sender object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Delete a Kafka Sender object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "deleteMsgVpnKafkaSender", "parameters": [ { @@ -52788,7 +52811,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Kafka Sender object.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationOauthClientSecret||x||x\nauthenticationScramPassword||x||x\nkafkaSenderName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Get a Kafka Sender object.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaSender", "parameters": [ { @@ -52846,7 +52869,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Kafka Sender object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationBasicUsername||||||x||\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\nauthenticationOauthClientId||||||x||\nauthenticationOauthClientScope||||||x||\nauthenticationOauthClientSecret||||x||x||x\nauthenticationOauthClientTokenEndpoint||||||x||\nauthenticationScheme||||||x||\nauthenticationScramHash||||||x||\nauthenticationScramPassword||||x||x||x\nauthenticationScramUsername||||||x||\nbatchDelay||||||x||\nbatchMaxMsgCount||||||x||\nbatchMaxSize||||||x||\nbootstrapAddressList||||||x||\nidempotenceEnabled||||||x||\nkafkaSenderName|x|x||||||\nmsgVpnName|x||x|||||\ntransportCompressionEnabled||||||x||\ntransportCompressionLevel||||||x||\ntransportCompressionType||||||x||\ntransportTlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername|\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Update a Kafka Sender object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxMsgCount|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\nidempotenceEnabled|||||x|\nkafkaSenderName|x|x||||\nmsgVpnName|x||x|||\ntransportCompressionEnabled|||||x|\ntransportCompressionLevel|||||x|\ntransportCompressionType|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "updateMsgVpnKafkaSender", "parameters": [ { @@ -52913,7 +52936,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Kafka Sender object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||x||x\nauthenticationBasicUsername||||||x||\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\nauthenticationOauthClientId||||||x||\nauthenticationOauthClientScope||||||x||\nauthenticationOauthClientSecret||||x||x||x\nauthenticationOauthClientTokenEndpoint||||||x||\nauthenticationScheme||||||x||\nauthenticationScramHash||||||x||\nauthenticationScramPassword||||x||x||x\nauthenticationScramUsername||||||x||\nbatchDelay||||||x||\nbatchMaxMsgCount||||||x||\nbatchMaxSize||||||x||\nbootstrapAddressList||||||x||\nidempotenceEnabled||||||x||\nkafkaSenderName|x|x||||||\nmsgVpnName|x||x|||||\ntransportCompressionEnabled||||||x||\ntransportCompressionLevel||||||x||\ntransportCompressionType||||||x||\ntransportTlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername|\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Replace a Kafka Sender object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxMsgCount|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\nidempotenceEnabled|||||x|\nkafkaSenderName|x|x||||\nmsgVpnName|x||x|||\ntransportCompressionEnabled|||||x|\ntransportCompressionLevel|||||x|\ntransportCompressionType|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "replaceMsgVpnKafkaSender", "parameters": [ { @@ -52982,7 +53005,7 @@ }, "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}/queueBindings": { "get": { - "description": "Get a list of Queue Binding objects.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nkafkaSenderName|x|||\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Queue Binding objects.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaSenderName|x\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaSenderQueueBindings", "parameters": [ { @@ -53052,7 +53075,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nkafkaSenderName|x|||x|||\nmsgVpnName|x|||x|||\nqueueName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nkafkaSenderName|x|||x\nmsgVpnName|x|||x\nqueueName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "createMsgVpnKafkaSenderQueueBinding", "parameters": [ { @@ -53180,7 +53203,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Queue Binding object.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nkafkaSenderName|x|||\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Get a Queue Binding object.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaSenderName|x\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaSenderQueueBinding", "parameters": [ { @@ -53245,7 +53268,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Queue Binding object. Any attribute missing from the request will be left unchanged.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nackMode||||||x||\nkafkaSenderName|x||x|||||\nmsgVpnName|x||x|||||\npartitionConsistentHash||||||x||\npartitionExplicitNumber||||||x||\npartitionRandomFallbackEnabled||||||x||\npartitionScheme||||||x||\nqueueName|x|x||||||\nremoteKey||||||x||\nremoteTopic||||||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Update a Queue Binding object. Any attribute missing from the request will be left unchanged.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nackMode||||x\nkafkaSenderName|x||x|\nmsgVpnName|x||x|\npartitionConsistentHash||||x\npartitionExplicitNumber||||x\npartitionRandomFallbackEnabled||||x\npartitionScheme||||x\nqueueName|x|x||\nremoteKey||||x\nremoteTopic||||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "updateMsgVpnKafkaSenderQueueBinding", "parameters": [ { @@ -53319,7 +53342,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nackMode||||||x||\nkafkaSenderName|x||x|||||\nmsgVpnName|x||x|||||\npartitionConsistentHash||||||x||\npartitionExplicitNumber||||||x||\npartitionRandomFallbackEnabled||||||x||\npartitionScheme||||||x||\nqueueName|x|x||||||\nremoteKey||||||x||\nremoteTopic||||||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nackMode||||x\nkafkaSenderName|x||x|\nmsgVpnName|x||x|\npartitionConsistentHash||||x\npartitionExplicitNumber||||x\npartitionRandomFallbackEnabled||||x\npartitionScheme||||x\nqueueName|x|x||\nremoteKey||||x\nremoteTopic||||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "replaceMsgVpnKafkaSenderQueueBinding", "parameters": [ { @@ -53395,7 +53418,7 @@ }, "/msgVpns/{msgVpnName}/mqttRetainCaches": { "get": { - "description": "Get a list of MQTT Retain Cache objects.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of MQTT Retain Cache objects.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnMqttRetainCaches", "parameters": [ { @@ -53458,7 +53481,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Create an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ncacheName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "createMsgVpnMqttRetainCache", "parameters": [ { @@ -53572,7 +53595,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an MQTT Retain Cache object.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncacheName|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Get an MQTT Retain Cache object.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnMqttRetainCache", "parameters": [ { @@ -53630,7 +53653,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Update an MQTT Retain Cache object. Any attribute missing from the request will be left unchanged.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "updateMsgVpnMqttRetainCache", "parameters": [ { @@ -53697,7 +53720,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ncacheName|x|x||||||\nmsgVpnName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", + "description": "Replace an MQTT Retain Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nUsing MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ncacheName|x|x|\nmsgVpnName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", "operationId": "replaceMsgVpnMqttRetainCache", "parameters": [ { @@ -53766,7 +53789,7 @@ }, "/msgVpns/{msgVpnName}/mqttSessions": { "get": { - "description": "Get a list of MQTT Session objects.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of MQTT Session objects.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnMqttSessions", "parameters": [ { @@ -53829,7 +53852,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x|x||||\nmqttSessionVirtualRouter|x|x|x||||\nmsgVpnName|x|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create an MQTT Session object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x|x|\nmqttSessionVirtualRouter|x|x|x|\nmsgVpnName|x|||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "createMsgVpnMqttSession", "parameters": [ { @@ -53950,7 +53973,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an MQTT Session object.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get an MQTT Session object.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnMqttSession", "parameters": [ { @@ -54015,7 +54038,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an MQTT Session object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||||||\nmqttSessionVirtualRouter|x|x||||||\nmsgVpnName|x||x|||||\nowner||||||x||\nqueueRejectMsgToSenderOnDiscardBehavior||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update an MQTT Session object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||\nmqttSessionVirtualRouter|x|x||\nmsgVpnName|x||x|\nowner||||x\nqueueRejectMsgToSenderOnDiscardBehavior||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "updateMsgVpnMqttSession", "parameters": [ { @@ -54089,7 +54112,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||||||\nmqttSessionVirtualRouter|x|x||||||\nmsgVpnName|x||x|||||\nowner||||||x||\nqueueRejectMsgToSenderOnDiscardBehavior||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|x||\nmqttSessionVirtualRouter|x|x||\nmsgVpnName|x||x|\nowner||||x\nqueueRejectMsgToSenderOnDiscardBehavior||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnMqttSessionQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "replaceMsgVpnMqttSession", "parameters": [ { @@ -54165,7 +54188,7 @@ }, "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions": { "get": { - "description": "Get a list of Subscription objects.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of Subscription objects.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnMqttSessionSubscriptions", "parameters": [ { @@ -54242,7 +54265,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||x|||\nmqttSessionVirtualRouter|x|||x|||\nmsgVpnName|x|||x|||\nsubscriptionTopic|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create a Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||x\nmqttSessionVirtualRouter|x|||x\nmsgVpnName|x|||x\nsubscriptionTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "createMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54384,7 +54407,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Subscription object.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqttSessionClientId|x|||\nmqttSessionVirtualRouter|x|||\nmsgVpnName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get a Subscription object.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54456,7 +54479,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Subscription object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x||x|||||\nmqttSessionVirtualRouter|x||x|||||\nmsgVpnName|x||x|||||\nsubscriptionTopic|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update a Subscription object. Any attribute missing from the request will be left unchanged.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmqttSessionClientId|x||x\nmqttSessionVirtualRouter|x||x\nmsgVpnName|x||x\nsubscriptionTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "updateMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54537,7 +54560,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmqttSessionClientId|x||x|||||\nmqttSessionVirtualRouter|x||x|||||\nmsgVpnName|x||x|||||\nsubscriptionTopic|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace a Subscription object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAn MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmqttSessionClientId|x||x\nmqttSessionVirtualRouter|x||x\nmsgVpnName|x||x\nsubscriptionTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "replaceMsgVpnMqttSessionSubscription", "parameters": [ { @@ -54620,7 +54643,7 @@ }, "/msgVpns/{msgVpnName}/proxies": { "get": { - "description": "Get a list of Proxy objects.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nmsgVpnName|x|||\nproxyName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Proxy objects.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nmsgVpnName|x||\nproxyName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnProxies", "parameters": [ { @@ -54683,7 +54706,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Proxy object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x||x\nmsgVpnName|x|||x|||\nproxyName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Create a Proxy object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nmsgVpnName|x|||x||\nproxyName|x|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "createMsgVpnProxy", "parameters": [ { @@ -54797,7 +54820,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Proxy object.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||x||x\nmsgVpnName|x|||\nproxyName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Get a Proxy object.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nmsgVpnName|x||\nproxyName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnProxy", "parameters": [ { @@ -54855,7 +54878,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Proxy object. Any attribute missing from the request will be left unchanged.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||||x\nmsgVpnName|x||x|||||\nproxyName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Update a Proxy object. Any attribute missing from the request will be left unchanged.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x\nmsgVpnName|x||x||\nproxyName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "updateMsgVpnProxy", "parameters": [ { @@ -54922,7 +54945,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Proxy object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x||||x\nmsgVpnName|x||x|||||\nproxyName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Replace a Proxy object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x\nmsgVpnName|x||x||\nproxyName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "replaceMsgVpnProxy", "parameters": [ { @@ -54991,7 +55014,7 @@ }, "/msgVpns/{msgVpnName}/queueTemplates": { "get": { - "description": "Get a list of Queue Template objects.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.14.", + "description": "Get a list of Queue Template objects.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueTemplateName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnQueueTemplates", "parameters": [ { @@ -55054,7 +55077,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nqueueTemplateName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Create a Queue Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueTemplateName|x|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "createMsgVpnQueueTemplate", "parameters": [ { @@ -55168,7 +55191,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Queue Template object.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Get a Queue Template object.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueTemplateName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnQueueTemplate", "parameters": [ { @@ -55226,7 +55249,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Queue Template object. Any attribute missing from the request will be left unchanged.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nqueueTemplateName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Update a Queue Template object. Any attribute missing from the request will be left unchanged.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueTemplateName|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "updateMsgVpnQueueTemplate", "parameters": [ { @@ -55293,7 +55316,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nqueueTemplateName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Replace a Queue Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueTemplateName|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "replaceMsgVpnQueueTemplate", "parameters": [ { @@ -55362,7 +55385,7 @@ }, "/msgVpns/{msgVpnName}/queues": { "get": { - "description": "Get a list of Queue objects.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Queue objects.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnQueues", "parameters": [ { @@ -55425,7 +55448,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nqueueName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Queue object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueName|x|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnQueue", "parameters": [ { @@ -55539,7 +55562,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Queue object.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Queue object.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnQueue", "parameters": [ { @@ -55597,7 +55620,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Queue object. Any attribute missing from the request will be left unchanged.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naccessType||||||x||\nmsgVpnName|x||x|||||\nowner||||||x||\npermission||||||x||\nqueueName|x|x||||||\nredeliveryDelayEnabled||||||x||\nredeliveryDelayInitialInterval||||||x||\nredeliveryDelayMaxInterval||||||x||\nredeliveryDelayMultiplier||||||x||\nrejectMsgToSenderOnDiscardBehavior||||||x||\nrespectMsgPriorityEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a Queue object. Any attribute missing from the request will be left unchanged.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nqueueName|x|x||\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnQueue", "parameters": [ { @@ -55664,7 +55687,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naccessType||||||x||\nmsgVpnName|x||x|||||\nowner||||||x||\npermission||||||x||\nqueueName|x|x||||||\nredeliveryDelayEnabled||||||x||\nredeliveryDelayInitialInterval||||||x||\nredeliveryDelayMaxInterval||||||x||\nredeliveryDelayMultiplier||||||x||\nrejectMsgToSenderOnDiscardBehavior||||||x||\nrespectMsgPriorityEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nqueueName|x|x||\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnQueueEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnQueue", "parameters": [ { @@ -55733,7 +55756,7 @@ }, "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions": { "get": { - "description": "Get a list of Queue Subscription objects.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Queue Subscription objects.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnQueueSubscriptions", "parameters": [ { @@ -55803,7 +55826,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nqueueName|x|||x|||\nsubscriptionTopic|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Queue Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueName|x|||x\nsubscriptionTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnQueueSubscription", "parameters": [ { @@ -55931,7 +55954,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Queue Subscription object.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueName|x|||\nsubscriptionTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Queue Subscription object.\n\nOne or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\nsubscriptionTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnQueueSubscription", "parameters": [ { @@ -55998,7 +56021,7 @@ }, "/msgVpns/{msgVpnName}/replayLogs": { "get": { - "description": "Get a list of Replay Log objects.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.10.", + "description": "Get a list of Replay Log objects.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.10.", "operationId": "getMsgVpnReplayLogs", "parameters": [ { @@ -56061,7 +56084,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nreplayLogName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", + "description": "Create a Replay Log object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplayLogName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", "operationId": "createMsgVpnReplayLog", "parameters": [ { @@ -56175,7 +56198,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Replay Log object.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.10.", + "description": "Get a Replay Log object.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.10.", "operationId": "getMsgVpnReplayLog", "parameters": [ { @@ -56233,7 +56256,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Replay Log object. Any attribute missing from the request will be left unchanged.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nreplayLogName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", + "description": "Update a Replay Log object. Any attribute missing from the request will be left unchanged.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplayLogName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", "operationId": "updateMsgVpnReplayLog", "parameters": [ { @@ -56300,7 +56323,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nreplayLogName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", + "description": "Replace a Replay Log object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplayLogName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.10.", "operationId": "replaceMsgVpnReplayLog", "parameters": [ { @@ -56369,7 +56392,7 @@ }, "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions": { "get": { - "description": "Get a list of Topic Filter Subscription objects.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\ntopicFilterSubscription|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.27.", + "description": "Get a list of Topic Filter Subscription objects.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\ntopicFilterSubscription|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnReplayLogTopicFilterSubscriptions", "parameters": [ { @@ -56439,7 +56462,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nreplayLogName|x|||x|||\ntopicFilterSubscription|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Create a Topic Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplayLogName|x|||x\ntopicFilterSubscription|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "createMsgVpnReplayLogTopicFilterSubscription", "parameters": [ { @@ -56567,7 +56590,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic Filter Subscription object.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplayLogName|x|||\ntopicFilterSubscription|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", + "description": "Get a Topic Filter Subscription object.\n\nOne or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\ntopicFilterSubscription|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.27.", "operationId": "getMsgVpnReplayLogTopicFilterSubscription", "parameters": [ { @@ -56634,7 +56657,7 @@ }, "/msgVpns/{msgVpnName}/replicatedTopics": { "get": { - "description": "Get a list of Replicated Topic objects.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplicatedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of Replicated Topic objects.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnReplicatedTopics", "parameters": [ { @@ -56697,7 +56720,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nreplicatedTopic|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplicatedTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "createMsgVpnReplicatedTopic", "parameters": [ { @@ -56811,7 +56834,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Replicated Topic object.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreplicatedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get a Replicated Topic object.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnReplicatedTopic", "parameters": [ { @@ -56869,7 +56892,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Replicated Topic object. Any attribute missing from the request will be left unchanged.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nreplicatedTopic|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update a Replicated Topic object. Any attribute missing from the request will be left unchanged.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplicatedTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "updateMsgVpnReplicatedTopic", "parameters": [ { @@ -56936,7 +56959,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nreplicatedTopic|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace a Replicated Topic object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nreplicatedTopic|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "replaceMsgVpnReplicatedTopic", "parameters": [ { @@ -57005,7 +57028,7 @@ }, "/msgVpns/{msgVpnName}/restDeliveryPoints": { "get": { - "description": "Get a list of REST Delivery Point objects.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of REST Delivery Point objects.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnRestDeliveryPoints", "parameters": [ { @@ -57068,7 +57091,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nrestDeliveryPointName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a REST Delivery Point object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nrestDeliveryPointName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnRestDeliveryPoint", "parameters": [ { @@ -57182,7 +57205,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a REST Delivery Point object.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a REST Delivery Point object.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnRestDeliveryPoint", "parameters": [ { @@ -57240,7 +57263,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientProfileName||||||x||\nmsgVpnName|x||x|||||\nrestDeliveryPointName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a REST Delivery Point object. Any attribute missing from the request will be left unchanged.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nclientProfileName||||x\nmsgVpnName|x||x|\nrestDeliveryPointName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnRestDeliveryPoint", "parameters": [ { @@ -57307,7 +57330,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientProfileName||||||x||\nmsgVpnName|x||x|||||\nrestDeliveryPointName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nclientProfileName||||x\nmsgVpnName|x||x|\nrestDeliveryPointName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnRestDeliveryPoint", "parameters": [ { @@ -57376,7 +57399,7 @@ }, "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings": { "get": { - "description": "Get a list of Queue Binding objects.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Queue Binding objects.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnRestDeliveryPointQueueBindings", "parameters": [ { @@ -57446,7 +57469,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nqueueBindingName|x|x|x||||\nrestDeliveryPointName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Queue Binding object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nqueueBindingName|x|x|x|\nrestDeliveryPointName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnRestDeliveryPointQueueBinding", "parameters": [ { @@ -57574,7 +57597,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Queue Binding object.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Queue Binding object.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnRestDeliveryPointQueueBinding", "parameters": [ { @@ -57639,7 +57662,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Queue Binding object. Any attribute missing from the request will be left unchanged.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nqueueBindingName|x|x||||||\nrestDeliveryPointName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a Queue Binding object. Any attribute missing from the request will be left unchanged.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueBindingName|x|x|\nrestDeliveryPointName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnRestDeliveryPointQueueBinding", "parameters": [ { @@ -57713,7 +57736,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\nqueueBindingName|x|x||||||\nrestDeliveryPointName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\nqueueBindingName|x|x|\nrestDeliveryPointName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnRestDeliveryPointQueueBinding", "parameters": [ { @@ -57789,7 +57812,7 @@ }, "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/protectedRequestHeaders": { "get": { - "description": "Get a list of Protected Request Header objects.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheaderName|x|||\nheaderValue||x||x\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.30.", + "description": "Get a list of Protected Request Header objects.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nheaderName|x||\nheaderValue||x|x\nmsgVpnName|x||\nqueueBindingName|x||\nrestDeliveryPointName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.30.", "operationId": "getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeaders", "parameters": [ { @@ -57866,7 +57889,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Protected Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|x||||\nheaderValue|||||x||x\nmsgVpnName|x|||x|||\nqueueBindingName|x|||x|||\nrestDeliveryPointName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.30.", + "description": "Create a Protected Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|x|||\nheaderValue|||||x|x\nmsgVpnName|x|||x||\nqueueBindingName|x|||x||\nrestDeliveryPointName|x|||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.30.", "operationId": "createMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", "parameters": [ { @@ -58008,7 +58031,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Protected Request Header object.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheaderName|x|||\nheaderValue||x||x\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.30.", + "description": "Get a Protected Request Header object.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nheaderName|x||\nheaderValue||x|x\nmsgVpnName|x||\nqueueBindingName|x||\nrestDeliveryPointName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.30.", "operationId": "getMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", "parameters": [ { @@ -58080,7 +58103,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Protected Request Header object. Any attribute missing from the request will be left unchanged.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x||||||\nheaderValue||||x||||x\nmsgVpnName|x||x|||||\nqueueBindingName|x||x|||||\nrestDeliveryPointName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.30.", + "description": "Update a Protected Request Header object. Any attribute missing from the request will be left unchanged.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|||\nheaderValue||||x|x\nmsgVpnName|x||x||\nqueueBindingName|x||x||\nrestDeliveryPointName|x||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.30.", "operationId": "updateMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", "parameters": [ { @@ -58161,7 +58184,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Protected Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x||||||\nheaderValue||||x||||x\nmsgVpnName|x||x|||||\nqueueBindingName|x||x|||||\nrestDeliveryPointName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.30.", + "description": "Replace a Protected Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|||\nheaderValue||||x|x\nmsgVpnName|x||x||\nqueueBindingName|x||x||\nrestDeliveryPointName|x||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.30.", "operationId": "replaceMsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader", "parameters": [ { @@ -58244,7 +58267,7 @@ }, "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders": { "get": { - "description": "Get a list of Request Header objects.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheaderName|x|||\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.23.", + "description": "Get a list of Request Header objects.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying\n:---|:---:\nheaderName|x\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.23.", "operationId": "getMsgVpnRestDeliveryPointQueueBindingRequestHeaders", "parameters": [ { @@ -58321,7 +58344,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x|x||||\nmsgVpnName|x|||x|||\nqueueBindingName|x|||x|||\nrestDeliveryPointName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", + "description": "Create a Request Header object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nheaderName|x|x|x|\nmsgVpnName|x|||x\nqueueBindingName|x|||x\nrestDeliveryPointName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", "operationId": "createMsgVpnRestDeliveryPointQueueBindingRequestHeader", "parameters": [ { @@ -58463,7 +58486,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Request Header object.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheaderName|x|||\nmsgVpnName|x|||\nqueueBindingName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.23.", + "description": "Get a Request Header object.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying\n:---|:---:\nheaderName|x\nmsgVpnName|x\nqueueBindingName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.23.", "operationId": "getMsgVpnRestDeliveryPointQueueBindingRequestHeader", "parameters": [ { @@ -58535,7 +58558,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Request Header object. Any attribute missing from the request will be left unchanged.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x||||||\nmsgVpnName|x||x|||||\nqueueBindingName|x||x|||||\nrestDeliveryPointName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", + "description": "Update a Request Header object. Any attribute missing from the request will be left unchanged.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nheaderName|x|x|\nmsgVpnName|x||x\nqueueBindingName|x||x\nrestDeliveryPointName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", "operationId": "updateMsgVpnRestDeliveryPointQueueBindingRequestHeader", "parameters": [ { @@ -58616,7 +58639,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nheaderName|x|x||||||\nmsgVpnName|x||x|||||\nqueueBindingName|x||x|||||\nrestDeliveryPointName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", + "description": "Replace a Request Header object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nheaderName|x|x|\nmsgVpnName|x||x\nqueueBindingName|x||x\nrestDeliveryPointName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.23.", "operationId": "replaceMsgVpnRestDeliveryPointQueueBindingRequestHeader", "parameters": [ { @@ -58699,7 +58722,7 @@ }, "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers": { "get": { - "description": "Get a list of REST Consumer objects.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationHttpBasicPassword||x||x\nauthenticationHttpHeaderValue||x||x\nauthenticationOauthClientSecret||x||x\nauthenticationOauthJwtSecretKey||x||x\nmsgVpnName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of REST Consumer objects.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationHttpBasicPassword||x|x\nauthenticationHttpHeaderValue||x|x\nauthenticationOauthClientSecret||x|x\nauthenticationOauthJwtSecretKey||x|x\nmsgVpnName|x||\nrestConsumerName|x||\nrestDeliveryPointName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnRestDeliveryPointRestConsumers", "parameters": [ { @@ -58769,7 +58792,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey|||||x||x\nauthenticationClientCertContent|||||x||x\nauthenticationClientCertPassword|||||x||\nauthenticationHttpBasicPassword|||||x||x\nauthenticationHttpHeaderValue|||||x||x\nauthenticationOauthClientSecret|||||x||x\nauthenticationOauthJwtSecretKey|||||x||x\nmsgVpnName|x|||x|||\nrestConsumerName|x|x|x||||\nrestDeliveryPointName|x|||x|||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword|\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled|\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a REST Consumer object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationHttpBasicPassword|||||x|x\nauthenticationHttpHeaderValue|||||x|x\nauthenticationOauthClientSecret|||||x|x\nauthenticationOauthJwtSecretKey|||||x|x\nmsgVpnName|x|||x||\nrestConsumerName|x|x|x|||\nrestDeliveryPointName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnRestDeliveryPointRestConsumer", "parameters": [ { @@ -58897,7 +58920,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a REST Consumer object.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x||x\nauthenticationClientCertContent||x||x\nauthenticationClientCertPassword||x||\nauthenticationHttpBasicPassword||x||x\nauthenticationHttpHeaderValue||x||x\nauthenticationOauthClientSecret||x||x\nauthenticationOauthJwtSecretKey||x||x\nmsgVpnName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a REST Consumer object.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationHttpBasicPassword||x|x\nauthenticationHttpHeaderValue||x|x\nauthenticationOauthClientSecret||x|x\nauthenticationOauthJwtSecretKey||x|x\nmsgVpnName|x||\nrestConsumerName|x||\nrestDeliveryPointName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnRestDeliveryPointRestConsumer", "parameters": [ { @@ -58962,7 +58985,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a REST Consumer object. Any attribute missing from the request will be left unchanged.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||||x||||x\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\nauthenticationHttpBasicPassword||||x||x||x\nauthenticationHttpBasicUsername||||||x||\nauthenticationHttpHeaderValue||||x||||x\nauthenticationOauthClientId||||||x||\nauthenticationOauthClientScope||||||x||\nauthenticationOauthClientSecret||||x||x||x\nauthenticationOauthClientTokenEndpoint||||||x||\nauthenticationOauthClientTokenExpiryDefault||||||x||\nauthenticationOauthJwtSecretKey||||x||x||x\nauthenticationOauthJwtTokenEndpoint||||||x||\nauthenticationOauthJwtTokenExpiryDefault||||||x||\nauthenticationScheme||||||x||\nmsgVpnName|x||x|||||\noutgoingConnectionCount||||||x||\nremoteHost||||||x||\nremotePort||||||x||\nrestConsumerName|x|x||||||\nrestDeliveryPointName|x||x|||||\ntlsCipherSuiteList||||||x||\ntlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword|\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled|\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Update a REST Consumer object. Any attribute missing from the request will be left unchanged.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||||x||x\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationHttpBasicPassword||||x|x|x\nauthenticationHttpBasicUsername|||||x|\nauthenticationHttpHeaderValue||||x||x\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationOauthClientTokenExpiryDefault|||||x|\nauthenticationOauthJwtSecretKey||||x|x|x\nauthenticationOauthJwtTokenEndpoint|||||x|\nauthenticationOauthJwtTokenExpiryDefault|||||x|\nauthenticationScheme|||||x|\nmsgVpnName|x||x|||\noutgoingConnectionCount|||||x|\nremoteHost|||||x|\nremotePort|||||x|\nrestConsumerName|x|x||||\nrestDeliveryPointName|x||x|||\ntlsCipherSuiteList|||||x|\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "updateMsgVpnRestDeliveryPointRestConsumer", "parameters": [ { @@ -59036,7 +59059,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||||x||||x\nauthenticationClientCertContent||||x||x||x\nauthenticationClientCertPassword||||x||x||\nauthenticationHttpBasicPassword||||x||x||x\nauthenticationHttpBasicUsername||||||x||\nauthenticationHttpHeaderValue||||x||||x\nauthenticationOauthClientId||||||x||\nauthenticationOauthClientScope||||||x||\nauthenticationOauthClientSecret||||x||x||x\nauthenticationOauthClientTokenEndpoint||||||x||\nauthenticationOauthClientTokenExpiryDefault||||||x||\nauthenticationOauthJwtSecretKey||||x||x||x\nauthenticationOauthJwtTokenEndpoint||||||x||\nauthenticationOauthJwtTokenExpiryDefault||||||x||\nauthenticationScheme||||||x||\nmsgVpnName|x||x|||||\noutgoingConnectionCount||||||x||\nremoteHost||||||x||\nremotePort||||||x||\nrestConsumerName|x|x||||||\nrestDeliveryPointName|x||x|||||\ntlsCipherSuiteList||||||x||\ntlsEnabled||||||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername|\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword|\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled|\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationAwsSecretAccessKey||||x||x\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationHttpBasicPassword||||x|x|x\nauthenticationHttpBasicUsername|||||x|\nauthenticationHttpHeaderValue||||x||x\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationOauthClientTokenExpiryDefault|||||x|\nauthenticationOauthJwtSecretKey||||x|x|x\nauthenticationOauthJwtTokenEndpoint|||||x|\nauthenticationOauthJwtTokenExpiryDefault|||||x|\nauthenticationScheme|||||x|\nmsgVpnName|x||x|||\noutgoingConnectionCount|||||x|\nremoteHost|||||x|\nremotePort|||||x|\nrestConsumerName|x|x||||\nrestDeliveryPointName|x||x|||\ntlsCipherSuiteList|||||x|\ntlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnRestDeliveryPointRestConsumer|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicPassword|authenticationHttpBasicUsername\nMsgVpnRestDeliveryPointRestConsumer|authenticationHttpBasicUsername|authenticationHttpBasicPassword\nMsgVpnRestDeliveryPointRestConsumer|remotePort|tlsEnabled\nMsgVpnRestDeliveryPointRestConsumer|tlsEnabled|remotePort\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "replaceMsgVpnRestDeliveryPointRestConsumer", "parameters": [ { @@ -59112,7 +59135,7 @@ }, "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims": { "get": { - "description": "Get a list of Claim objects.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthJwtClaimName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.21.", + "description": "Get a list of Claim objects.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthJwtClaimName|x\nrestConsumerName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.21.", "operationId": "getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaims", "parameters": [ { @@ -59189,7 +59212,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\noauthJwtClaimName|x|x|x||||\noauthJwtClaimValue||x|x||||\nrestConsumerName|x|||x|||\nrestDeliveryPointName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.21.", + "description": "Create a Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\noauthJwtClaimName|x|x|x|\noauthJwtClaimValue||x|x|\nrestConsumerName|x|||x\nrestDeliveryPointName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.21.", "operationId": "createMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", "parameters": [ { @@ -59331,7 +59354,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Claim object.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthJwtClaimName|x|||\nrestConsumerName|x|||\nrestDeliveryPointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.21.", + "description": "Get a Claim object.\n\nA Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthJwtClaimName|x\nrestConsumerName|x\nrestDeliveryPointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.21.", "operationId": "getMsgVpnRestDeliveryPointRestConsumerOauthJwtClaim", "parameters": [ { @@ -59406,7 +59429,7 @@ "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/tlsTrustedCommonNames": { "get": { "deprecated": true, - "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|\nrestConsumerName|x||x|\nrestDeliveryPointName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Get a list of Trusted Common Name objects.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\nrestConsumerName|x|x\nrestDeliveryPointName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonNames", "parameters": [ { @@ -59475,7 +59498,7 @@ }, "post": { "deprecated": true, - "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x||x|\nrestConsumerName|x|||x||x|\nrestDeliveryPointName|x|||x||x|\ntlsTrustedCommonName|x|x|x|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Create a Trusted Common Name object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|x\nrestConsumerName|x|||x|x\nrestDeliveryPointName|x|||x|x\ntlsTrustedCommonName|x|x|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "createMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", "parameters": [ { @@ -59619,7 +59642,7 @@ }, "get": { "deprecated": true, - "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|\nrestConsumerName|x||x|\nrestDeliveryPointName|x||x|\ntlsTrustedCommonName|x||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", + "description": "Get a Trusted Common Name object.\n\nThe Trusted Common Names for the REST Consumer are used by encrypted transports to verify the name in the certificate presented by the remote REST consumer. They must include the common name of the remote REST consumer's server certificate.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\nrestConsumerName|x|x\nrestDeliveryPointName|x|x\ntlsTrustedCommonName|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.", "operationId": "getMsgVpnRestDeliveryPointRestConsumerTlsTrustedCommonName", "parameters": [ { @@ -59693,7 +59716,7 @@ }, "/msgVpns/{msgVpnName}/sequencedTopics": { "get": { - "description": "Get a list of Sequenced Topic objects.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nsequencedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", + "description": "Get a list of Sequenced Topic objects.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsequencedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnSequencedTopics", "parameters": [ { @@ -59755,7 +59778,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nsequencedTopic|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Create a Sequenced Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nsequencedTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "createMsgVpnSequencedTopic", "parameters": [ { @@ -59867,7 +59890,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Sequenced Topic object.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nsequencedTopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", + "description": "Get a Sequenced Topic object.\n\nA Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsequencedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.0.", "operationId": "getMsgVpnSequencedTopic", "parameters": [ { @@ -59926,7 +59949,7 @@ }, "/msgVpns/{msgVpnName}/telemetryProfiles": { "get": { - "description": "Get a list of Telemetry Profile objects.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntelemetryProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", + "description": "Get a list of Telemetry Profile objects.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfiles", "parameters": [ { @@ -59989,7 +60012,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Telemetry Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\ntelemetryProfileName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Create a Telemetry Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntelemetryProfileName|x|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "createMsgVpnTelemetryProfile", "parameters": [ { @@ -60103,7 +60126,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Telemetry Profile object.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntelemetryProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Get a Telemetry Profile object.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfile", "parameters": [ { @@ -60161,7 +60184,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Telemetry Profile object. Any attribute missing from the request will be left unchanged.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntelemetryProfileName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Update a Telemetry Profile object. Any attribute missing from the request will be left unchanged.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "updateMsgVpnTelemetryProfile", "parameters": [ { @@ -60228,7 +60251,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Telemetry Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntelemetryProfileName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Replace a Telemetry Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nUsing the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileQueueEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTelemetryProfileReceiverEventConnectionCountPerClientUsernameThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "replaceMsgVpnTelemetryProfile", "parameters": [ { @@ -60297,7 +60320,7 @@ }, "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/receiverAclConnectExceptions": { "get": { - "description": "Get a list of Receiver ACL Connect Exception objects.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreceiverAclConnectExceptionAddress|x|||\ntelemetryProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", + "description": "Get a list of Receiver ACL Connect Exception objects.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreceiverAclConnectExceptionAddress|x\ntelemetryProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfileReceiverAclConnectExceptions", "parameters": [ { @@ -60367,7 +60390,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Receiver ACL Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nreceiverAclConnectExceptionAddress|x|x|x||||\ntelemetryProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Create a Receiver ACL Connect Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreceiverAclConnectExceptionAddress|x|x|x|\ntelemetryProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "createMsgVpnTelemetryProfileReceiverAclConnectException", "parameters": [ { @@ -60495,7 +60518,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Receiver ACL Connect Exception object.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nreceiverAclConnectExceptionAddress|x|||\ntelemetryProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Get a Receiver ACL Connect Exception object.\n\nA Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreceiverAclConnectExceptionAddress|x\ntelemetryProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfileReceiverAclConnectException", "parameters": [ { @@ -60562,7 +60585,7 @@ }, "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters": { "get": { - "description": "Get a list of Trace Filter objects.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntelemetryProfileName|x|||\ntraceFilterName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", + "description": "Get a list of Trace Filter objects.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|x\ntraceFilterName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfileTraceFilters", "parameters": [ { @@ -60632,7 +60655,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Trace Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\ntelemetryProfileName|x|||x|||\ntraceFilterName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Create a Trace Filter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntelemetryProfileName|x|||x\ntraceFilterName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "createMsgVpnTelemetryProfileTraceFilter", "parameters": [ { @@ -60760,7 +60783,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Trace Filter object.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntelemetryProfileName|x|||\ntraceFilterName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Get a Trace Filter object.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntelemetryProfileName|x\ntraceFilterName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfileTraceFilter", "parameters": [ { @@ -60825,7 +60848,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Trace Filter object. Any attribute missing from the request will be left unchanged.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntelemetryProfileName|x||x|||||\ntraceFilterName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Update a Trace Filter object. Any attribute missing from the request will be left unchanged.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|x||x\ntraceFilterName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "updateMsgVpnTelemetryProfileTraceFilter", "parameters": [ { @@ -60899,7 +60922,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Trace Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntelemetryProfileName|x||x|||||\ntraceFilterName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Replace a Trace Filter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntelemetryProfileName|x||x\ntraceFilterName|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "replaceMsgVpnTelemetryProfileTraceFilter", "parameters": [ { @@ -60975,7 +60998,7 @@ }, "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}/subscriptions": { "get": { - "description": "Get a list of Telemetry Trace Filter Subscription objects.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nsubscription|x|||\nsubscriptionSyntax|x|||\ntelemetryProfileName|x|||\ntraceFilterName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", + "description": "Get a list of Telemetry Trace Filter Subscription objects.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsubscription|x\nsubscriptionSyntax|x\ntelemetryProfileName|x\ntraceFilterName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfileTraceFilterSubscriptions", "parameters": [ { @@ -61052,7 +61075,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Telemetry Trace Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\nsubscription|x|x|x||||\nsubscriptionSyntax|x|x|x||||\ntelemetryProfileName|x|||x|||\ntraceFilterName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Create a Telemetry Trace Filter Subscription object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nsubscription|x|x|x|\nsubscriptionSyntax|x|x|x|\ntelemetryProfileName|x|||x\ntraceFilterName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "createMsgVpnTelemetryProfileTraceFilterSubscription", "parameters": [ { @@ -61201,7 +61224,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Telemetry Trace Filter Subscription object.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\nsubscription|x|||\nsubscriptionSyntax|x|||\ntelemetryProfileName|x|||\ntraceFilterName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", + "description": "Get a Telemetry Trace Filter Subscription object.\n\nTrace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nsubscription|x\nsubscriptionSyntax|x\ntelemetryProfileName|x\ntraceFilterName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.31.", "operationId": "getMsgVpnTelemetryProfileTraceFilterSubscription", "parameters": [ { @@ -61282,7 +61305,7 @@ }, "/msgVpns/{msgVpnName}/topicEndpointTemplates": { "get": { - "description": "Get a list of Topic Endpoint Template objects.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.14.", + "description": "Get a list of Topic Endpoint Template objects.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointTemplateName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnTopicEndpointTemplates", "parameters": [ { @@ -61345,7 +61368,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\ntopicEndpointTemplateName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Create a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicEndpointTemplateName|x|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "createMsgVpnTopicEndpointTemplate", "parameters": [ { @@ -61459,7 +61482,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Topic Endpoint Template object.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointTemplateName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Get a Topic Endpoint Template object.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointTemplateName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "getMsgVpnTopicEndpointTemplate", "parameters": [ { @@ -61517,7 +61540,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntopicEndpointTemplateName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Update a Topic Endpoint Template object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicEndpointTemplateName|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "updateMsgVpnTopicEndpointTemplate", "parameters": [ { @@ -61584,7 +61607,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x||x|||||\ntopicEndpointTemplateName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", + "description": "Replace a Topic Endpoint Template object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x||x\ntopicEndpointTemplateName|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventMsgSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointTemplateEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.14.", "operationId": "replaceMsgVpnTopicEndpointTemplate", "parameters": [ { @@ -61653,7 +61676,7 @@ }, "/msgVpns/{msgVpnName}/topicEndpoints": { "get": { - "description": "Get a list of Topic Endpoint objects.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of Topic Endpoint objects.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnTopicEndpoints", "parameters": [ { @@ -61716,7 +61739,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|||\ntopicEndpointName|x|x|x||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Create a Topic Endpoint object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\ntopicEndpointName|x|x|x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "createMsgVpnTopicEndpoint", "parameters": [ { @@ -61830,7 +61853,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Topic Endpoint object.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\ntopicEndpointName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Get a Topic Endpoint object.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnTopicEndpoint", "parameters": [ { @@ -61888,7 +61911,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naccessType||||||x||\nmsgVpnName|x||x|||||\nowner||||||x||\npermission||||||x||\nredeliveryDelayEnabled||||||x||\nredeliveryDelayInitialInterval||||||x||\nredeliveryDelayMaxInterval||||||x||\nredeliveryDelayMultiplier||||||x||\nrejectMsgToSenderOnDiscardBehavior||||||x||\nrespectMsgPriorityEnabled||||||x||\ntopicEndpointName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Update a Topic Endpoint object. Any attribute missing from the request will be left unchanged.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\ntopicEndpointName|x|x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "updateMsgVpnTopicEndpoint", "parameters": [ { @@ -61955,7 +61978,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\naccessType||||||x||\nmsgVpnName|x||x|||||\nowner||||||x||\npermission||||||x||\nredeliveryDelayEnabled||||||x||\nredeliveryDelayInitialInterval||||||x||\nredeliveryDelayMaxInterval||||||x||\nredeliveryDelayMultiplier||||||x||\nrejectMsgToSenderOnDiscardBehavior||||||x||\nrespectMsgPriorityEnabled||||||x||\ntopicEndpointName|x|x||||||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", + "description": "Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\naccessType||||x\nmsgVpnName|x||x|\nowner||||x\npermission||||x\nredeliveryDelayEnabled||||x\nredeliveryDelayInitialInterval||||x\nredeliveryDelayMaxInterval||||x\nredeliveryDelayMultiplier||||x\nrejectMsgToSenderOnDiscardBehavior||||x\nrespectMsgPriorityEnabled||||x\ntopicEndpointName|x|x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires|Conflicts\n:---|:---|:---|:---\nMsgVpnTopicEndpointEventBindCountThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventBindCountThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventBindCountThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventRejectLowPriorityMsgLimitThreshold|setValue|clearValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearPercent|setPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|clearValue|setValue|clearPercent, setPercent\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setPercent|clearPercent|clearValue, setValue\nMsgVpnTopicEndpointEventSpoolUsageThreshold|setValue|clearValue|clearPercent, setPercent\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", "operationId": "replaceMsgVpnTopicEndpoint", "parameters": [ { @@ -62024,7 +62047,7 @@ }, "/oauthProfiles": { "get": { - "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfiles", "parameters": [ { @@ -62079,7 +62102,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret|||||x||x\noauthProfileName|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\noauthProfileName|x|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "createOauthProfile", "parameters": [ { @@ -62177,7 +62200,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret||x||x\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfile", "parameters": [ { @@ -62227,7 +62250,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x||||x\noauthProfileName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", + "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret|||x|x\noauthProfileName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", "operationId": "updateOauthProfile", "parameters": [ { @@ -62286,7 +62309,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x||||x\noauthProfileName|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", + "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret|||x|x\noauthProfileName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", "operationId": "replaceOauthProfile", "parameters": [ { @@ -62347,7 +62370,7 @@ }, "/oauthProfiles/{oauthProfileName}/accessLevelGroups": { "get": { - "description": "Get a list of Group Access Level objects.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of Group Access Level objects.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileAccessLevelGroups", "parameters": [ { @@ -62409,7 +62432,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x|x|x||||\noauthProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", + "description": "Create a Group Access Level object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ngroupName|x|x|x|\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. An access scope/level of \"global/admin\" is required to create access level groups with a global access level greater than \"none\". Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", "operationId": "createOauthProfileAccessLevelGroup", "parameters": [ { @@ -62470,7 +62493,7 @@ }, "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}": { "delete": { - "description": "Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Delete a Group Access Level object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. An access scope/level of \"global/admin\" is required to delete access level groups with a global access level greater than \"none\".\n\nThis has been available since 2.24.", "operationId": "deleteOauthProfileAccessLevelGroup", "parameters": [ { @@ -62521,7 +62544,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Group Access Level object.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get a Group Access Level object.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileAccessLevelGroup", "parameters": [ { @@ -62578,7 +62601,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Group Access Level object. Any attribute missing from the request will be left unchanged.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", + "description": "Update a Group Access Level object. Any attribute missing from the request will be left unchanged.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", "operationId": "updateOauthProfileAccessLevelGroup", "parameters": [ { @@ -62644,7 +62667,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", + "description": "Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nThe name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nglobalAccessLevel|global/admin\n\n\n\nThis has been available since 2.24.", "operationId": "replaceOauthProfileAccessLevelGroup", "parameters": [ { @@ -62712,7 +62735,7 @@ }, "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions": { "get": { - "description": "Get a list of Message VPN Access-Level Exception objects.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of Message VPN Access-Level Exception objects.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileAccessLevelGroupMsgVpnAccessLevelExceptions", "parameters": [ { @@ -62781,7 +62804,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x|||x|||\nmsgVpnName|x|x|x||||\noauthProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||x\nmsgVpnName|x|x|x|\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "createOauthProfileAccessLevelGroupMsgVpnAccessLevelException", "parameters": [ { @@ -62907,7 +62930,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Message VPN Access-Level Exception object.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroupName|x|||\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get a Message VPN Access-Level Exception object.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying\n:---|:---:\ngroupName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileAccessLevelGroupMsgVpnAccessLevelException", "parameters": [ { @@ -62971,7 +62994,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x||x|||||\nmsgVpnName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x||x\nmsgVpnName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "updateOauthProfileAccessLevelGroupMsgVpnAccessLevelException", "parameters": [ { @@ -63044,7 +63067,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\ngroupName|x||x|||||\nmsgVpnName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nMessage VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\ngroupName|x||x\nmsgVpnName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "replaceOauthProfileAccessLevelGroupMsgVpnAccessLevelException", "parameters": [ { @@ -63119,7 +63142,7 @@ }, "/oauthProfiles/{oauthProfileName}/clientAllowedHosts": { "get": { - "description": "Get a list of Allowed Host Value objects.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowedHost|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of Allowed Host Value objects.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying\n:---|:---:\nallowedHost|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileClientAllowedHosts", "parameters": [ { @@ -63181,7 +63204,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nallowedHost|x|x|x||||\noauthProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Create an Allowed Host Value object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nallowedHost|x|x|x|\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "createOauthProfileClientAllowedHost", "parameters": [ { @@ -63293,7 +63316,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an Allowed Host Value object.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowedHost|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get an Allowed Host Value object.\n\nA valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying\n:---|:---:\nallowedHost|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileClientAllowedHost", "parameters": [ { @@ -63352,7 +63375,7 @@ }, "/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters": { "get": { - "description": "Get a list of Authorization Parameter objects.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of Authorization Parameter objects.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nauthorizationParameterName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileClientAuthorizationParameters", "parameters": [ { @@ -63414,7 +63437,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|x|x||||\noauthProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Create an Authorization Parameter object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|x|x|\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "createOauthProfileClientAuthorizationParameter", "parameters": [ { @@ -63526,7 +63549,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get an Authorization Parameter object.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get an Authorization Parameter object.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nauthorizationParameterName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileClientAuthorizationParameter", "parameters": [ { @@ -63583,7 +63606,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Update an Authorization Parameter object. Any attribute missing from the request will be left unchanged.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nauthorizationParameterName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "updateOauthProfileClientAuthorizationParameter", "parameters": [ { @@ -63649,7 +63672,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nauthorizationParameterName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Replace an Authorization Parameter object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nAdditional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nauthorizationParameterName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "replaceOauthProfileClientAuthorizationParameter", "parameters": [ { @@ -63717,7 +63740,7 @@ }, "/oauthProfiles/{oauthProfileName}/clientRequiredClaims": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileClientRequiredClaims", "parameters": [ { @@ -63779,7 +63802,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x||||\nclientRequiredClaimValue||x|x||||\noauthProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x|\nclientRequiredClaimValue||x|x|\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "createOauthProfileClientRequiredClaim", "parameters": [ { @@ -63891,7 +63914,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileClientRequiredClaim", "parameters": [ { @@ -63950,7 +63973,7 @@ }, "/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions": { "get": { - "description": "Get a list of Message VPN Access-Level Exception objects.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of Message VPN Access-Level Exception objects.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileDefaultMsgVpnAccessLevelExceptions", "parameters": [ { @@ -64012,7 +64035,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|x|x||||\noauthProfileName|x|||x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Create a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|x|x|\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "createOauthProfileDefaultMsgVpnAccessLevelException", "parameters": [ { @@ -64124,7 +64147,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Message VPN Access-Level Exception object.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||\noauthProfileName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get a Message VPN Access-Level Exception object.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileDefaultMsgVpnAccessLevelException", "parameters": [ { @@ -64181,7 +64204,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Update a Message VPN Access-Level Exception object. Any attribute missing from the request will be left unchanged.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "updateOauthProfileDefaultMsgVpnAccessLevelException", "parameters": [ { @@ -64247,7 +64270,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|x||||||\noauthProfileName|x||x|||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Replace a Message VPN Access-Level Exception object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nDefault message VPN access-level exceptions.\n\n\nAttribute|Identifying|Const|Read-Only\n:---|:---:|:---:|:---:\nmsgVpnName|x|x|\noauthProfileName|x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "replaceOauthProfileDefaultMsgVpnAccessLevelException", "parameters": [ { @@ -64315,7 +64338,7 @@ }, "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileResourceServerRequiredClaims", "parameters": [ { @@ -64377,7 +64400,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\noauthProfileName|x|||x|||\nresourceServerRequiredClaimName|x|x|x||||\nresourceServerRequiredClaimValue||x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\noauthProfileName|x|||x\nresourceServerRequiredClaimName|x|x|x|\nresourceServerRequiredClaimValue||x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "createOauthProfileResourceServerRequiredClaim", "parameters": [ { @@ -64489,7 +64512,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\noauthProfileName|x|||\nresourceServerRequiredClaimName|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.24.", "operationId": "getOauthProfileResourceServerRequiredClaim", "parameters": [ { @@ -64549,7 +64572,7 @@ "/systemInformation": { "get": { "deprecated": true, - "description": "Get a System Information object.\n\nThe System Information object provides metadata about the SEMP API.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nplatform|||x|\nsempVersion|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been deprecated since 2.2. /systemInformation was replaced by /about/api.", + "description": "Get a System Information object.\n\nThe System Information object provides metadata about the SEMP API.\n\n\nAttribute|Deprecated\n:---|:---:\nplatform|x\nsempVersion|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been deprecated since 2.2. /systemInformation was replaced by /about/api.", "operationId": "getSystemInformation", "parameters": [ { @@ -64594,7 +64617,7 @@ }, "/virtualHostnames": { "get": { - "description": "Get a list of Virtual Hostname objects.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nvirtualHostname|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.17.", + "description": "Get a list of Virtual Hostname objects.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying\n:---|:---:\nvirtualHostname|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.17.", "operationId": "getVirtualHostnames", "parameters": [ { @@ -64649,7 +64672,7 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nvirtualHostname|x|x|x||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", + "description": "Create a Virtual Hostname object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const|Required\n:---|:---:|:---:|:---:\nvirtualHostname|x|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", "operationId": "createVirtualHostname", "parameters": [ { @@ -64747,7 +64770,7 @@ "x-supportedInSempDirect": true }, "get": { - "description": "Get a Virtual Hostname object.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nvirtualHostname|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.17.", + "description": "Get a Virtual Hostname object.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying\n:---|:---:\nvirtualHostname|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.17.", "operationId": "getVirtualHostname", "parameters": [ { @@ -64797,7 +64820,7 @@ "x-supportedInSempDirect": true }, "patch": { - "description": "Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nvirtualHostname|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", + "description": "Update a Virtual Hostname object. Any attribute missing from the request will be left unchanged.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\nvirtualHostname|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", "operationId": "updateVirtualHostname", "parameters": [ { @@ -64856,7 +64879,7 @@ "x-supportedInSempDirect": true }, "put": { - "description": "Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Requires-Disable|Auto-Disable|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:\nvirtualHostname|x|x||||||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", + "description": "Replace a Virtual Hostname object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nA Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Const\n:---|:---:|:---:\nvirtualHostname|x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.17.", "operationId": "replaceVirtualHostname", "parameters": [ { diff --git a/ci/whitesource/whitesource-agent.config b/ci/whitesource/whitesource-agent.config new file mode 100644 index 00000000..eb0f83b0 --- /dev/null +++ b/ci/whitesource/whitesource-agent.config @@ -0,0 +1,72 @@ +#################################################################### +# WhiteSource FS-Agent configuration file +#################################################################### +########################################## +# GENERAL SCAN MODE: Files and Package Managers +########################################## +checkPolicies=true +updateInventory=true +forceCheckAllDependencies=true +forceUpdate=false +forceUpdate.failBuildOnPolicyViolation=true +offline=false +forceCheckAllDependencies=true +enableLicenseViolations=true +#dependenciesOnly=true + +wss.url=https://saas.whitesourcesoftware.com/agent + +npm.resolveDependencies=false +bower.resolveDependencies=false +nuget.resolveDependencies=false +python.resolveDependencies=false +maven.resolveDependencies=false +gradle.resolveDependencies = true +paket.resolveDependencies=false +ruby.resolveDependencies = false +sbt.resolveDependencies=false +html.resolveDependencies=false + + +##GO Configuration +go.resolveDependencies=false +go.collectDependenciesAtRuntime=true +go.modules.resolveDependencies=true +go.modules.ignoreSourceFiles=true +go.modules.removeDuplicateDependencies=true +go.modules.includeTestDependencies=false +#go.modules.includeTestDependencies=true + +#userKey is required if WhiteSource administrator has enabled "Enforce user level access" option +#userKey= + +projectName= +projectVersion= +projectToken= + +productName= +productVersion= +productToken= +updateType=OVERRIDE +#requesterEmail=user@provider.com + +######################################################################################### +# Includes/Excludes Glob patterns - PLEASE USE ONLY ONE EXCLUDE LINE AND ONE INCLUDE LINE +######################################################################################### +includes=**/*.go **/*.yaml + +case.sensitive.glob=false +followSymbolicLinks=true + + +############################################## +# SCAN MODE: Linux package manager settings +############################################## +scanPackageManager=false + +################################## +# SCAN MODE: Docker images +################################## +docker.includes=**/* +#docker.excludes=.*.* +#docker.scanImages=true diff --git a/cmd/broker/client.go b/cmd/broker/client.go index 4e01d360..846d0ca1 100644 --- a/cmd/broker/client.go +++ b/cmd/broker/client.go @@ -16,7 +16,6 @@ package broker import ( - "net/http/cookiejar" "os" "strings" "terraform-provider-solacebroker/cmd/command" @@ -59,11 +58,10 @@ func CliClient(url string) *semp.Client { terraform.LogCLIError("\nError: Unable to parse provider attribute. " + err.Error()) os.Exit(1) } - jar, _ := cookiejar.New(nil) client := semp.NewClient( getFullSempAPIURL(url), insecure_skip_verify, - jar, + false, // this is a client for the generator semp.BasicAuth(username, password), semp.BearerToken(bearerToken), semp.Retries(uint(retries), retryMinInterval, retryMaxInterval), diff --git a/cmd/command/configgenerator.go b/cmd/command/configgenerator.go index 95386598..e120756e 100644 --- a/cmd/command/configgenerator.go +++ b/cmd/command/configgenerator.go @@ -31,15 +31,10 @@ import ( type BrokerObjectType string -type IdentifyingAttribute struct { - key, value string -} - type GeneratorTerraformOutput struct { TerraformOutput map[string]ResourceConfig SEMPDataResponse map[string]map[string]any } -type BrokerObjectAttributes []IdentifyingAttribute var BrokerObjectRelationship = map[BrokerObjectType][]BrokerObjectType{} @@ -129,58 +124,52 @@ func ParseTerraformObject(ctx context.Context, client semp.Client, resourceName } } var path string - var err error if len(parentResult) > 0 { - path, err = ResolveSempPathWithParent(entityToRead.PathTemplate, parentResult) - if err != nil { - LogCLIError("Error calling Broker Endpoint") - os.Exit(1) - } + path, _ = ResolveSempPathWithParent(entityToRead.PathTemplate, parentResult) } else { - path, err = ResolveSempPath(entityToRead.PathTemplate, providerSpecificIdentifier) - if err != nil { - LogCLIError("Error calling Broker Endpoint") - os.Exit(1) - } + path, _ = ResolveSempPath(entityToRead.PathTemplate, providerSpecificIdentifier) } - sempData, err := client.RequestWithoutBodyForGenerator(ctx, generated.BasePath, http.MethodGet, path, []map[string]any{}) - if err != nil { - if err == semp.ErrResourceNotFound { - // continue if error is resource not found - if len(parentResult) > 0 { - print("..") - } - sempData = []map[string]any{} - } else if errors.Is(err, semp.ErrBadRequest) { - // continue if error is also bad request - if len(parentResult) > 0 { - print("..") + if len(path) > 0 { + + sempData, err := client.RequestWithoutBodyForGenerator(ctx, generated.BasePath, http.MethodGet, path, []map[string]any{}) + if err != nil { + if err == semp.ErrResourceNotFound { + // continue if error is resource not found + if len(parentResult) > 0 { + print("..") + } + sempData = []map[string]any{} + } else if errors.Is(err, semp.ErrBadRequest) { + // continue if error is also bad request + if len(parentResult) > 0 { + print("..") + } + sempData = []map[string]any{} + } else { + LogCLIError("SEMP call failed. " + err.Error() + " on path " + path) + os.Exit(1) } - sempData = []map[string]any{} - } else { - LogCLIError("SEMP call failed. " + err.Error() + " on path " + path) - os.Exit(1) } - } - resourceKey := "solacebroker_" + brokerObjectTerraformName + " " + resourceName + resourceKey := "solacebroker_" + brokerObjectTerraformName + " " + resourceName - resourceValues, err := GenerateTerraformString(entityToRead.Attributes, sempData, parentBrokerResourceAttributesRelationship, brokerObjectTerraformName) + resourceValues, err := GenerateTerraformString(entityToRead.Attributes, sempData, parentBrokerResourceAttributesRelationship, brokerObjectTerraformName) - //check resource names used and deduplicate to avoid collision - for i := range resourceValues { - totalOccurrence := 1 - objectName = strings.ToLower(resourceKey) + GetNameForResource(strings.ToLower(resourceKey), resourceValues[i]) - count, objectNameExists := ObjectNamesCount[objectName] - if objectNameExists { - totalOccurrence = count + 1 + //check resource names used and deduplicate to avoid collision + for i := range resourceValues { + totalOccurrence := 1 + objectName = strings.ToLower(resourceKey) + GetNameForResource(strings.ToLower(resourceKey), resourceValues[i]) + count, objectNameExists := ObjectNamesCount[objectName] + if objectNameExists { + totalOccurrence = count + 1 + } + ObjectNamesCount[objectName] = totalOccurrence + objectName = objectName + "_" + fmt.Sprint(totalOccurrence) + tfObject[objectName] = resourceValues[i] + tfObjectSempDataResponse[objectName] = sempData[i] } - ObjectNamesCount[objectName] = totalOccurrence - objectName = objectName + "_" + fmt.Sprint(totalOccurrence) - tfObject[objectName] = resourceValues[i] - tfObjectSempDataResponse[objectName] = sempData[i] } return GeneratorTerraformOutput{ TerraformOutput: tfObject, diff --git a/cmd/command/configwriter.go b/cmd/command/configwriter.go index 4be79122..317b21c0 100644 --- a/cmd/command/configwriter.go +++ b/cmd/command/configwriter.go @@ -19,6 +19,7 @@ import ( "bytes" "embed" "os" + "strings" "text/template" ) @@ -31,7 +32,14 @@ var terraformTemplate *template.Template func init() { var err error terraformTemplateString, _ := templatefiles.ReadFile("templates/terraform.template") - terraformTemplate, err = template.New("Object Template").Parse(string(terraformTemplateString)) + terraformTemplate, err = template.New("Object Template").Funcs(template.FuncMap{ + "splitHCLResourceName": func(value string) []string { + return strings.Split(value, " ") + }, + "readHCLResourceName": func(slice []string, index int) string { + return slice[index] + }, + }).Parse(string(terraformTemplateString)) if err != nil { panic(err) } diff --git a/cmd/command/configwriter_test.go b/cmd/command/configwriter_test.go index 0fc93fb8..83114aee 100644 --- a/cmd/command/configwriter_test.go +++ b/cmd/command/configwriter_test.go @@ -34,7 +34,7 @@ func TestGenerateTerraformFile(t *testing.T) { Username: "admin", Password: "admin", BearerToken: "", - FileName: "somefile.tf", + FileName: "/tmp/somefile.tf", BrokerResources: []map[string]string{}}, }, false, diff --git a/cmd/command/templates/terraform.template b/cmd/command/templates/terraform.template index 293fa847..2a0a923f 100644 --- a/cmd/command/templates/terraform.template +++ b/cmd/command/templates/terraform.template @@ -7,7 +7,7 @@ terraform { } } -provider solacebroker { +provider "solacebroker" { # username = "admin" # This is a placeholder. # password = "admin" # This is a placeholder. url = "{{.BrokerURL}}" @@ -16,7 +16,8 @@ provider solacebroker { {{range .BrokerResources}} {{range $k, $v := . -}} -resource {{$k}} { +{{$kslice := splitHCLResourceName $k}} +resource "{{readHCLResourceName $kslice 0 }}" "{{readHCLResourceName $kslice 1}}" { {{$v}} } {{end -}} diff --git a/cmd/command/util.go b/cmd/command/util.go index 69c42143..7bf40805 100644 --- a/cmd/command/util.go +++ b/cmd/command/util.go @@ -21,6 +21,7 @@ import ( "errors" "fmt" "math/rand" + "net/url" "os" "reflect" "regexp" @@ -131,7 +132,9 @@ func ResolveSempPath(pathTemplate string, v string) (string, error) { for i := range identifiersValues { if i < len(out) { - generatedPath = strings.ReplaceAll(generatedPath, out[i][0], identifiersValues[i]) + //encode all, if param is url friendly this does nothing. + value := url.QueryEscape(fmt.Sprint(identifiersValues[i])) + generatedPath = strings.ReplaceAll(generatedPath, out[i][0], value) } } if len(out) > len(identifiersValues) { @@ -141,11 +144,21 @@ func ResolveSempPath(pathTemplate string, v string) (string, error) { } } + //special conditions + //for /url/{param1},{param2},{param3}.. valid semp query to fetch all items when all parameters are empty + //for /url1/{param1},{param2},{param3}/url2.. invalid when all parameters are empty as it becomes /url1/url2 + if strings.Contains(generatedPath, "/,,/") || strings.Contains(generatedPath, "/,/") { + return "", errors.New("not all parameters found. SEMP call will be invalid") + } + path := strings.ReplaceAll(generatedPath, "/,,", "") path = strings.ReplaceAll(path, "/,", "") if strings.HasSuffix(path, "/") { path = strings.TrimSuffix(path, "/") } + if strings.Contains(path, "//") { + return "", errors.New("not all parameters found. SEMP call will be invalid") + } return path, nil } func ResolveSempPathWithParent(pathTemplate string, parentValues map[string]any) (string, error) { @@ -163,6 +176,8 @@ func ResolveSempPathWithParent(pathTemplate string, parentValues map[string]any) value, found := parentValues[key] if found { + //url encode, if param is url friendly this does nothing. + value = url.QueryEscape(fmt.Sprint(value)) generatedPath = strings.ReplaceAll(generatedPath, out[i][0], fmt.Sprint(value)) } } @@ -171,12 +186,21 @@ func ResolveSempPathWithParent(pathTemplate string, parentValues map[string]any) for i := range out { generatedPath = strings.ReplaceAll(generatedPath, out[i][0], "") } + //special conditions + //for /url/{param1},{param2},{param3}.. valid semp query to fetch all items when all parameters are empty + //for /url1/{param1},{param2},{param3}/url2.. invalid when all parameters are empty as it becomes /url1/url2 + if strings.Contains(generatedPath, "/,,/") || strings.Contains(generatedPath, "/,/") { + return "", errors.New("not all parameters found. SEMP call will be invalid") + } path := strings.ReplaceAll(generatedPath, "/,,", "") path = strings.ReplaceAll(path, "/,", "") if strings.HasSuffix(path, "/") { path = strings.TrimSuffix(path, "/") } + if strings.Contains(path, "//") { + return "", errors.New("not all parameters found. SEMP call will be invalid") + } return path, nil } @@ -227,7 +251,7 @@ func GenerateTerraformString(attributes []*broker.AttributeInfo, values []map[st if reflect.TypeOf(valuesRes) == nil || valuesRes == "" { continue } - if attr.Identifying && strings.Contains(valuesRes.(string), "#") { + if attr.Identifying && valuesRes.(string)[0] == '#' && valuesRes.(string) != "#DEAD_MESSAGE_QUEUE" { systemProvisioned = true } if reflect.TypeOf(attr.Default) != nil && fmt.Sprint(attr.Default) == fmt.Sprint(valuesRes) { @@ -237,17 +261,10 @@ func GenerateTerraformString(attributes []*broker.AttributeInfo, values []map[st attributesWithDefaultValue = append(attributesWithDefaultValue, attr.TerraformName) continue } else { - fmt.Println("Applying workaround: not ignoring default for `msg_vpn` attribute `authentication_basic_type`") + LogCLIInfo("Applying workaround: not ignoring default for `msg_vpn` attribute `authentication_basic_type`") } } - - /// => value in val - - val := "\"" + valuesRes.(string) + "\"" - if strings.Contains(valuesRes.(string), "{") { - valueOutput := strings.ReplaceAll(valuesRes.(string), "\"", "\\\"") - val = "\"" + valueOutput + "\"" - } + val := "\"" + SanitizeHclStringValue(valuesRes.(string)) + "\"" resourceConfig.ResourceAttributes[attr.TerraformName] = newAttributeInfo(val) case broker.Int64: if valuesRes == nil { @@ -257,7 +274,6 @@ func GenerateTerraformString(attributes []*broker.AttributeInfo, values []map[st if reflect.TypeOf(attr.Default) != nil && fmt.Sprint(attr.Default) == fmt.Sprint(intValue) { //attributes with default values will be skipped attributesWithDefaultValue = append(attributesWithDefaultValue, attr.TerraformName) - continue } val := fmt.Sprintf("%v", intValue) @@ -401,10 +417,21 @@ func hclFormatResource(resourceConfig ResourceConfig) string { } func SanitizeHclIdentifierName(name string) string { - name = regexp.MustCompile(`[^a-zA-Z0-9 ]+`).ReplaceAllString(strings.TrimSpace(name), "_") + name = regexp.MustCompile(`[^a-zA-Z0-9 ]+`).ReplaceAllString(strings.ReplaceAll(name, " ", ""), "_") if len(name) == 0 || (name[0] >= '0' && name[0] <= '9') || (len(name) == 1 && name[0] == '_') { //just prepend static string to avoid checking all characters name = "gn_" + name } return name } + +func SanitizeHclStringValue(value string) string { + b, err := json.Marshal(value) + if err != nil { + } + s := string(b) + output := s[1 : len(s)-1] + output = strings.ReplaceAll(output, "${", "$${") + output = strings.ReplaceAll(output, "%{", "%%{") + return output +} diff --git a/cmd/command/util_test.go b/cmd/command/util_test.go index 941dd633..1828b3f9 100644 --- a/cmd/command/util_test.go +++ b/cmd/command/util_test.go @@ -261,6 +261,11 @@ func TestSanitizeHclIdentifierName(t *testing.T) { args{name: "#"}, "gn__", }, + { + "SanitizeTextOnlySpecialCharacterTwo", + args{name: "\\"}, + "gn__", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -270,3 +275,81 @@ func TestSanitizeHclIdentifierName(t *testing.T) { }) } } +func TestSanitizeHclValue(t *testing.T) { + type args struct { + name string + } + tests := []struct { + name string + args args + want string + }{ + { + "SanitizeValueStartingWithNumber", + args{name: "1testing"}, + "1testing", + }, + { + "SanitizeValueContainingSpecialCharacters", + args{name: "*testing*"}, + "*testing*", + }, + { + "SanitizeJSONValue", + args{name: "{\"as\":\"ds\"}"}, + "{\\\"as\\\":\\\"ds\\\"}", + }, + { + "SanitizeOnlySpecialCharacterValue", + args{name: "\\"}, + "\\\\", + }, + { + "SanitizeOnlySpecialCharacterValueTwo", + args{name: "*"}, + "*", + }, + { + "SanitizeOnlySpecialCharacterValueThree", + args{name: "\""}, + "\\\"", + }, + { + "SanitizeSubstituitionExpression", + args{name: "time/${now()}"}, + "time/$${now()}", + }, + { + "SanitizeSubstituitionExpression", + args{name: "time/%{now()}"}, + "time/%%{now()}", + }, + { + "SanitizeSubstituitionExpression", + args{name: "time/$/test"}, + "time/$/test", + }, + { + "SanitizeSubstituitionExpression", + args{name: "time/%/test"}, + "time/%/test", + }, + { + "SanitizeSubstituitionExpression", + args{name: "${"}, + "$${", + }, + { + "SanitizeSubstituitionExpression", + args{name: "${utcDate(\"/\")}/${utcTime(\"/\")}/${BASE32(randomBytes(15))}"}, + "$${utcDate(\\\"/\\\")}/$${utcTime(\\\"/\\\")}/$${BASE32(randomBytes(15))}", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := SanitizeHclStringValue(tt.args.name); got != tt.want { + t.Errorf("SanitizeHclStringValue() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/cmd/generate.go b/cmd/generate.go index 14dc824d..27fc7e85 100644 --- a/cmd/generate.go +++ b/cmd/generate.go @@ -23,9 +23,9 @@ import ( "strings" "terraform-provider-solacebroker/cmd/broker" command "terraform-provider-solacebroker/cmd/command" + "terraform-provider-solacebroker/internal/broker/generated" "terraform-provider-solacebroker/internal/semp" - "github.com/hashicorp/go-version" "github.com/spf13/cobra" "golang.org/x/exp/maps" ) @@ -33,20 +33,21 @@ import ( // generateCmd represents the generate command var generateCmd = &cobra.Command{ Use: "generate --url= ", - Short: "Generates a Terraform configuration file for a specified PubSubPlus Broker object and all child objects known to the provider", + Short: "Generates a Terraform configuration file for a specified PubSub+ event broker object and all child objects known to the provider", Long: `The generate command on the provider binary generates a Terraform configuration file for the specified object and all child objects known to the provider. -This is not a Terraform command. One can download the provider binary and can execute that binary with the "generate" command to generate a Terraform configuration file from the current configuration of a PubSubPlus event broker. +This is not a Terraform command. One can download the provider binary and can execute that binary with the "generate" command to generate a Terraform configuration file from the current configuration of a PubSub+ event broker. generate where; - is the broker provider binary, - is the terraform resource address, for example http://localhost:8080, - are the similar to the Terraform Import command,this is the resource name and possible values to find a specific resource, - is the desirable name of the generated filename. + is the broker provider binary + is the broker SEMP API address, for example http://: + is similar to the Terraform Import command. This is the resource name and possible values to find a specific resource + is the desirable name of the generated filename -For example: - terraform-provider-solacebroker generate --url=https://localhost:8080 solacebroker_msg_vpn.mq default my-messagevpn.tf +Example: + SOLACEBROKER_USERNAME=adminuser SOLACEBROKER_PASSWORD=pass \ + terraform-provider-solacebroker generate --url=https://localhost:8080 solacebroker_msg_vpn.mq default my-messagevpn.tf This command would create a file my-messagevpn.tf that contains a resource definition for the default message VPN and any child objects, assuming the appropriate broker credentials were set in environment variables.`, @@ -85,6 +86,11 @@ This command would create a file my-messagevpn.tf that contains a resource defin fileName = fileName + ".tf" } + skipApiCheck, err := command.BooleanWithDefaultFromEnv("skip_api_check", false, false) + if err != nil { + command.LogCLIError("\nError: Unable to parse provider attribute. " + err.Error()) + os.Exit(1) + } //Confirm SEMP version and connection via client aboutPath := "/about/api" result, err := client.RequestWithoutBody(cmd.Context(), http.MethodGet, aboutPath) @@ -92,15 +98,16 @@ This command would create a file my-messagevpn.tf that contains a resource defin command.LogCLIError("SEMP call failed. " + err.Error()) os.Exit(1) } - brokerSempVersion, err := version.NewVersion(result["sempVersion"].(string)) - if err != nil { - command.LogCLIError("Unable to parse SEMP version from API") + brokerSempVersion := result["sempVersion"].(string) + brokerPlatform := result["platform"].(string) + if !skipApiCheck && brokerPlatform != generated.Platform { + command.LogCLIError(fmt.Sprintf("Broker platform \"%s\" does not match generator supported platform: %s", BrokerPlatformName[brokerPlatform], BrokerPlatformName[generated.Platform])) os.Exit(1) } - command.LogCLIInfo("Connection successful") - command.LogCLIInfo("Broker SEMP version is " + brokerSempVersion.String()) + command.LogCLIInfo("Connection successful.") + command.LogCLIInfo(fmt.Sprintf("Broker SEMP version is %s, Generator SEMP version is %s", brokerSempVersion, generated.SempVersion)) - command.LogCLIInfo("Attempt generation for broker object: " + brokerObjectType + " of " + providerSpecificIdentifier + " in file " + fileName) + command.LogCLIInfo("Attempting config generation for object and its child-objects: " + brokerObjectType + ", identifier: " + providerSpecificIdentifier + ", destination file: " + fileName) object := &command.ObjectInfo{} @@ -132,7 +139,7 @@ This command would create a file my-messagevpn.tf that contains a resource defin maps.Copy(generatedResource, generatedResourceChildren) } - fmt.Println("\nReplacing hardcoded names of inter-object dependencies by references where required ...") + command.LogCLIInfo("Replacing hardcoded names of inter-object dependencies by references where required") fixInterObjectDependencies(brokerResources) // Format the results @@ -153,9 +160,9 @@ This command would create a file my-messagevpn.tf that contains a resource defin } object.FileName = fileName - command.LogCLIInfo("Found all resources. Generation started for file " + fileName) + command.LogCLIInfo("Found all resources. Writing file " + fileName) _ = command.GenerateTerraformFile(object) - command.LogCLIInfo(fileName + " created successfully.") + command.LogCLIInfo(fileName + " created successfully.\n") os.Exit(0) }, } diff --git a/cmd/root.go b/cmd/root.go index e549e465..5ebc7327 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -24,7 +24,7 @@ import ( var rootCmd = &cobra.Command{ Use: "terraform-provider-solacebroker", Short: "", - Long: `Terraform provider for the Solace PubSubPlus Software Event Broker. + Long: `Terraform provider for the Solace PubSub+ Event Broker. This binary is both a plugin for Terraform CLI and it also provides command-line options when invoked as standalone. The rest of this help describes the command-line use.`, } diff --git a/cmd/versioncmd.go b/cmd/versioncmd.go index 78cd6d90..9dccf7fa 100644 --- a/cmd/versioncmd.go +++ b/cmd/versioncmd.go @@ -23,13 +23,20 @@ import ( "github.com/spf13/cobra" ) +var ( + BrokerPlatformName = map[string]string{ + "VMR": "Software Event Broker", + "Appliance": "Appliance", + } +) + // versionCmd represents the version command var versionCmd = &cobra.Command{ Use: "version", Short: "Provides version information about the current binary", Long: "", Run: func(cmd *cobra.Command, args []string) { - fmt.Println(fmt.Sprintf("Provider version: %s, based on Semp version %s", broker.ProviderVersion, generated.SempVersion)) + fmt.Println(fmt.Sprintf("Terraform Provider for Solace PubSub+ %s platform, version: %s, based on Semp version %s", BrokerPlatformName[generated.Platform], broker.ProviderVersion, generated.SempVersion)) }, } diff --git a/docs/data-sources/about_api.md b/docs/data-sources/about_api.md index 3cd77fe5..15191580 100644 --- a/docs/data-sources/about_api.md +++ b/docs/data-sources/about_api.md @@ -25,6 +25,5 @@ This has been available since SEMP API version 2.2. ### Read-Only -- `id` (String) Identifier attribute, for internal use only. - `platform` (String) The platform running the SEMP API. - `semp_version` (String) The version of the SEMP API. diff --git a/docs/data-sources/about_user.md b/docs/data-sources/about_user.md index 0382c7ec..7ac08891 100644 --- a/docs/data-sources/about_user.md +++ b/docs/data-sources/about_user.md @@ -34,7 +34,6 @@ This has been available since SEMP API version 2.2. "read-write" - Read and write access. - `global_dmr_bridge_access_enabled` (Boolean) Indicates whether global DMR Bridge access is enabled for the User. This is only for Solace internal use. This attribute may not be returned in a GET. Available since (hidden in public API). -- `id` (String) Identifier attribute, for internal use only. - `session_active` (Boolean) Indicates whether a session is active for this request. Available since SEMP API version 2.24. - `session_create_time` (Number) The timestamp of when the session was created. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since SEMP API version 2.21. - `session_current_time` (Number) The current server timestamp. This is provided as a reference point for the other timestamps provided. This attribute may not be returned in a GET. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time). Available since SEMP API version 2.21. diff --git a/docs/data-sources/about_user_msg_vpn.md b/docs/data-sources/about_user_msg_vpn.md index 3fa92ac9..b41be7f9 100644 --- a/docs/data-sources/about_user_msg_vpn.md +++ b/docs/data-sources/about_user_msg_vpn.md @@ -4,9 +4,9 @@ page_title: "solacebroker_about_user_msg_vpn Data Source - solacebroker" subcategory: "" description: |- This provides information about the Message VPN access level for the username used to access the SEMP API. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -16,9 +16,9 @@ description: |- This provides information about the Message VPN access level for the username used to access the SEMP API. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x @@ -44,4 +44,3 @@ This has been available since SEMP API version 2.2. "read-only" - Read only access. "read-write" - Read and write access. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/broker.md b/docs/data-sources/broker.md index 7a45871d..08b9f0a3 100644 --- a/docs/data-sources/broker.md +++ b/docs/data-sources/broker.md @@ -4,11 +4,11 @@ page_title: "solacebroker_broker Data Source - solacebroker" subcategory: "" description: |- This object contains global configuration for the message broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - tlsservercertcontent||x||x - tlsservercertpassword||x|| - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. Requests which include the following attributes require greater access scope/level: + Attribute|Write-Only|Opaque + :---|:---:|:---: + tlsservercertcontent|x|x + tlsservercertpassword|x| + A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than "vpn/read-only": Attribute|Access Scope/Level :---|:---: authclientcertrevocationcheckmode|global/read-only @@ -128,12 +128,7 @@ description: |- tlsciphersuitesecureshelllist|global/read-only tlscrimeexploitprotectionenabled|global/read-only tlsservercertcontent|global/read-only - tlsstandarddomaincertificateauthoritiesenabled|vpn/read-only - tlsticketlifetime|global/read-only - webmanagerallowunencryptedwizardsenabled|vpn/read-only - webmanagercustomization|vpn/read-only - webmanagerredirecthttpenabled|vpn/read-only - webmanagerredirecthttpoverridetls_port|vpn/read-only + tlsticket_lifetime|global/read-only This has been available since SEMP API version 2.13. --- @@ -142,14 +137,14 @@ description: |- This object contains global configuration for the message broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -tls_server_cert_content||x||x -tls_server_cert_password||x|| +Attribute|Write-Only|Opaque +:---|:---:|:---: +tls_server_cert_content|x|x +tls_server_cert_password|x| -A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. Requests which include the following attributes require greater access scope/level: +A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than "vpn/read-only": Attribute|Access Scope/Level @@ -271,12 +266,7 @@ tls_cipher_suite_msg_backbone_list|global/read-only tls_cipher_suite_secure_shell_list|global/read-only tls_crime_exploit_protection_enabled|global/read-only tls_server_cert_content|global/read-only -tls_standard_domain_certificate_authorities_enabled|vpn/read-only tls_ticket_lifetime|global/read-only -web_manager_allow_unencrypted_wizards_enabled|vpn/read-only -web_manager_customization|vpn/read-only -web_manager_redirect_http_enabled|vpn/read-only -web_manager_redirect_http_override_tls_port|vpn/read-only @@ -339,7 +329,6 @@ This has been available since SEMP API version 2.13. "transacted" - All transactions originated by clients are replicated to the standby site using transactions. Available since SEMP API version 2.18. -- `id` (String) Identifier attribute, for internal use only. - `oauth_profile_default` (String) The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. Available since SEMP API version 2.24. - `service_amqp_enabled` (Boolean) Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since SEMP API version 2.17. - `service_amqp_tls_listen_port` (Number) TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as service_amqp_enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since SEMP API version 2.17. diff --git a/docs/data-sources/client_cert_authority.md b/docs/data-sources/client_cert_authority.md index ebe3c22d..e2c89581 100644 --- a/docs/data-sources/client_cert_authority.md +++ b/docs/data-sources/client_cert_authority.md @@ -4,9 +4,9 @@ page_title: "solacebroker_client_cert_authority Data Source - solacebroker" subcategory: "" description: |- Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certauthorityname|x||| + Attribute|Identifying + :---|:---: + certauthorityname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.19. --- @@ -16,9 +16,9 @@ description: |- Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cert_authority_name|x||| +Attribute|Identifying +:---|:---: +cert_authority_name|x @@ -41,7 +41,6 @@ This has been available since SEMP API version 2.19. - `crl_day_list` (String) The scheduled CRL refresh day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The empty-string ("") can also be specified, indicating no schedule is configured ("crl_time_list" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"daily"`. - `crl_time_list` (String) The scheduled CRL refresh time(s), specified as "hourly" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string ("") can also be specified, indicating no schedule is configured ("crl_day_list" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"3:00"`. - `crl_url` (String) The URL for the CRL source. This is a required attribute for CRL to be operational and the URL must be complete with http:// included. IPv6 addresses must be enclosed in square-brackets. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as revocation_check_enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. -- `id` (String) Identifier attribute, for internal use only. - `ocsp_non_responder_cert_enabled` (Boolean) Enable or disable allowing a non-responder certificate to sign an OCSP response. Typically used with an OCSP override URL in cases where a single certificate is used to sign client certificates and OCSP responses. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `ocsp_override_url` (String) The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `ocsp_timeout` (Number) The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. diff --git a/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md b/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md index 4f2399d7..cef30a05 100644 --- a/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md +++ b/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md @@ -4,10 +4,10 @@ page_title: "solacebroker_client_cert_authority_ocsp_tls_trusted_common_name Dat subcategory: "" description: |- When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certauthorityname|x||| - ocsptlstrustedcommonname|x||| + Attribute|Identifying + :---|:---: + certauthorityname|x + ocsptlstrustedcommonname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.19. --- @@ -17,10 +17,10 @@ description: |- When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cert_authority_name|x||| -ocsp_tls_trusted_common_name|x||| +Attribute|Identifying +:---|:---: +cert_authority_name|x +ocsp_tls_trusted_common_name|x @@ -37,7 +37,3 @@ This has been available since SEMP API version 2.19. - `cert_authority_name` (String) The name of the Certificate Authority. - `ocsp_tls_trusted_common_name` (String) The expected Trusted Common Name of the OCSP responder remote certificate. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/dmr_cluster.md b/docs/data-sources/dmr_cluster.md index 1c672641..c67ca55e 100644 --- a/docs/data-sources/dmr_cluster.md +++ b/docs/data-sources/dmr_cluster.md @@ -55,7 +55,6 @@ This has been available since SEMP API version 2.11. - `authentication_client_cert_enabled` (Boolean) Enable or disable client certificate authentication for Cluster Links. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `direct_only_enabled` (Boolean) Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The default value is `false`. - `enabled` (Boolean) Enable or disable the Cluster. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `node_name` (String) The name of this node in the Cluster. This is the name that this broker (or redundant group of brokers) is know by to other nodes in the Cluster. The name is chosen automatically to be either this broker's Router Name or Mate Router Name, depending on which Active Standby Role (primary or backup) this broker plays in its redundancy group. - `tls_server_cert_max_chain_depth` (Number) The maximum allowed depth of a certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. - `tls_server_cert_validate_date_enabled` (Boolean) Enable or disable the validation of the "Not Before" and "Not After" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. diff --git a/docs/data-sources/dmr_cluster_cert_matching_rule.md b/docs/data-sources/dmr_cluster_cert_matching_rule.md index 7025e7f7..99079189 100644 --- a/docs/data-sources/dmr_cluster_cert_matching_rule.md +++ b/docs/data-sources/dmr_cluster_cert_matching_rule.md @@ -4,10 +4,10 @@ page_title: "solacebroker_dmr_cluster_cert_matching_rule Data Source - solacebro subcategory: "" description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrclustername|x||| - rule_name|x||| + Attribute|Identifying + :---|:---: + dmrclustername|x + rule_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -17,10 +17,10 @@ description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -dmr_cluster_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +dmr_cluster_name|x +rule_name|x @@ -41,4 +41,3 @@ This has been available since SEMP API version 2.28. ### Read-Only - `enabled` (Boolean) Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md b/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md index 8c2271e2..249d4816 100644 --- a/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md +++ b/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md @@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_cert_matching_rule_attribute_filter Data S subcategory: "" description: |- A Cert Matching Rule Attribute Filter compares a link attribute to a string. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrclustername|x||| - filtername|x||| - rulename|x||| + Attribute|Identifying + :---|:---: + dmrclustername|x + filtername|x + rulename|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Attribute Filter compares a link attribute to a string. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -dmr_cluster_name|x||| -filter_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +dmr_cluster_name|x +filter_name|x +rule_name|x @@ -45,4 +45,3 @@ This has been available since SEMP API version 2.28. - `attribute_name` (String) Link Attribute to be tested. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `attribute_value` (String) Expected attribute value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md b/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md index a1c11244..cbdaddf4 100644 --- a/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md +++ b/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md @@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_cert_matching_rule_condition Data Source - subcategory: "" description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrclustername|x||| - rule_name|x||| - source|x||| + Attribute|Identifying + :---|:---: + dmrclustername|x + rule_name|x + source|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -dmr_cluster_name|x||| -rule_name|x||| -source|x||| +Attribute|Identifying +:---|:---: +dmr_cluster_name|x +rule_name|x +source|x @@ -61,4 +61,3 @@ This has been available since SEMP API version 2.28. - `attribute` (String) Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`. - `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/dmr_cluster_link.md b/docs/data-sources/dmr_cluster_link.md index efebc866..a4d2248d 100644 --- a/docs/data-sources/dmr_cluster_link.md +++ b/docs/data-sources/dmr_cluster_link.md @@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_link Data Source - solacebroker" subcategory: "" description: |- A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationbasicpassword||x||x - dmrclustername|x||| - remotenodename|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + authenticationbasicpassword||x|x + dmrclustername|x|| + remotenodename|x|| A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -18,11 +18,11 @@ description: |- A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authentication_basic_password||x||x -dmr_cluster_name|x||| -remote_node_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +authentication_basic_password||x|x +dmr_cluster_name|x|| +remote_node_name|x|| @@ -57,7 +57,7 @@ This has been available since SEMP API version 2.11. - `client_profile_queue_direct3_max_depth` (Number) The maximum depth of the "Direct 3" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. - `client_profile_queue_direct3_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the `client_profile_queue_direct3_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. - `client_profile_queue_guaranteed1_max_depth` (Number) The maximum depth of the "Guaranteed 1" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. -- `client_profile_queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-3) priority queue, regardless of the `client_profile_queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. +- `client_profile_queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-1) priority queue, regardless of the `client_profile_queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. - `client_profile_tcp_congestion_window_size` (Number) The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`. - `client_profile_tcp_keepalive_count` (Number) The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. - `client_profile_tcp_keepalive_idle_time` (Number) The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. @@ -66,7 +66,6 @@ This has been available since SEMP API version 2.11. - `client_profile_tcp_max_window_size` (Number) The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. This setting is ignored on the software broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`. - `egress_flow_window_size` (Number) The number of outstanding guaranteed messages that can be sent over the Link before acknowledgment is received by the sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. - `enabled` (Boolean) Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `initiator` (String) The initiator of the Link's TCP connections. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"lexical"`. The allowed values and their meaning are: 
diff --git a/docs/data-sources/dmr_cluster_link_attribute.md b/docs/data-sources/dmr_cluster_link_attribute.md
index 7f5aebc8..cc5ebfb1 100644
--- a/docs/data-sources/dmr_cluster_link_attribute.md
+++ b/docs/data-sources/dmr_cluster_link_attribute.md
@@ -4,12 +4,12 @@ page_title: "solacebroker_dmr_cluster_link_attribute Data Source - solacebroker"
 subcategory: ""
 description: |-
   A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  attributename|x|||
-  attributevalue|x|||
-  dmrclustername|x|||
-  remotenodename|x|||
+  Attribute|Identifying
+  :---|:---:
+  attributename|x
+  attributevalue|x
+  dmrclustername|x
+  remotenodename|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
 ---
@@ -19,12 +19,12 @@ description: |-
 A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-attribute_name|x|||
-attribute_value|x|||
-dmr_cluster_name|x|||
-remote_node_name|x|||
+Attribute|Identifying
+:---|:---:
+attribute_name|x
+attribute_value|x
+dmr_cluster_name|x
+remote_node_name|x
 
 
 
@@ -43,7 +43,3 @@ This has been available since SEMP API version 2.28.
 - `attribute_value` (String) The value of the Attribute.
 - `dmr_cluster_name` (String) The name of the Cluster.
 - `remote_node_name` (String) The name of the node at the remote end of the Link.
-
-### Read-Only
-
-- `id` (String) Identifier attribute, for internal use only.
diff --git a/docs/data-sources/dmr_cluster_link_remote_address.md b/docs/data-sources/dmr_cluster_link_remote_address.md
index 645fa855..173df6f3 100644
--- a/docs/data-sources/dmr_cluster_link_remote_address.md
+++ b/docs/data-sources/dmr_cluster_link_remote_address.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_link_remote_address Data Source - solacebr
 subcategory: ""
 description: |-
   Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  dmrclustername|x|||
-  remoteaddress|x|||
-  remotenode_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  dmrclustername|x
+  remoteaddress|x
+  remotenode_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
 ---
@@ -18,11 +18,11 @@ description: |-
 Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-dmr_cluster_name|x|||
-remote_address|x|||
-remote_node_name|x|||
+Attribute|Identifying
+:---|:---:
+dmr_cluster_name|x
+remote_address|x
+remote_node_name|x
 
 
 
@@ -40,7 +40,3 @@ This has been available since SEMP API version 2.11.
 - `dmr_cluster_name` (String) The name of the Cluster.
 - `remote_address` (String) The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).
 - `remote_node_name` (String) The name of the node at the remote end of the Link.
-
-### Read-Only
-
-- `id` (String) Identifier attribute, for internal use only.
diff --git a/docs/data-sources/domain_cert_authority.md b/docs/data-sources/domain_cert_authority.md
index 02c1d611..4a783b73 100644
--- a/docs/data-sources/domain_cert_authority.md
+++ b/docs/data-sources/domain_cert_authority.md
@@ -4,9 +4,9 @@ page_title: "solacebroker_domain_cert_authority Data Source - solacebroker"
 subcategory: ""
 description: |-
   Certificate Authorities trusted for domain verification.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  certauthorityname|x|||
+  Attribute|Identifying
+  :---|:---:
+  certauthorityname|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.19.
 ---
@@ -16,9 +16,9 @@ description: |-
 Certificate Authorities trusted for domain verification.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-cert_authority_name|x|||
+Attribute|Identifying
+:---|:---:
+cert_authority_name|x
 
 
 
@@ -38,4 +38,3 @@ This has been available since SEMP API version 2.19.
 ### Read-Only
 
 - `cert_content` (String) The PEM formatted content for the trusted root certificate of a domain Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`.
-- `id` (String) Identifier attribute, for internal use only.
diff --git a/docs/data-sources/msg_vpn.md b/docs/data-sources/msg_vpn.md
index c4e948e7..66ddcd45 100644
--- a/docs/data-sources/msg_vpn.md
+++ b/docs/data-sources/msg_vpn.md
@@ -55,7 +55,9 @@ This has been available since SEMP API version 2.0.
 
 - `alias` (String) The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.
 
-Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.14.
+Aliases may form a non-circular chain, cascading one to the next.
+
+Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.14.
 - `authentication_basic_enabled` (Boolean) Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.
 - `authentication_basic_profile_name` (String) The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`.
 - `authentication_basic_radius_domain` (String) The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
@@ -140,12 +142,12 @@ Aliases may form a non-circular chain, cascading one to the next. Changes to thi
 - `event_transacted_session_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_transacted_session_count_threshold))
 - `event_transaction_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_transaction_count_threshold))
 - `export_subscriptions_enabled` (Boolean) Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `id` (String) Identifier attribute, for internal use only.
 - `jndi_enabled` (Boolean) Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.2.
 - `max_connection_count` (Number) The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.
 - `max_egress_flow_count` (Number) The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.
 - `max_endpoint_count` (Number) The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.
 - `max_ingress_flow_count` (Number) The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.
+- `max_kafka_broker_connection_count` (Number) The maximum number of simultaneous Kafka broker connections of the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since SEMP API version 2.39.
 - `max_msg_spool_usage` (Number) The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.
 - `max_subscription_count` (Number) The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.
 - `max_transacted_session_count` (Number) The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.
@@ -218,7 +220,7 @@ Aliases may form a non-circular chain, cascading one to the next. Changes to thi
 "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn >  authentication > client-certificate > shutdown".
Available since SEMP API version 2.21. -- `service_rest_incoming_authorization_header_handling` (String) The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"drop"`. The allowed values and their meaning are: +- `service_rest_incoming_authorization_header_handling` (String) The handling of Authorization headers for incoming REST connections. Authorization header handling settings apply only when the Message VPN is in gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"drop"`. The allowed values and their meaning are: 
 "drop" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.
diff --git a/docs/data-sources/msg_vpn_acl_profile.md b/docs/data-sources/msg_vpn_acl_profile.md
index 80e22bf7..27f33ab4 100644
--- a/docs/data-sources/msg_vpn_acl_profile.md
+++ b/docs/data-sources/msg_vpn_acl_profile.md
@@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_acl_profile Data Source - solacebroker"
 subcategory: ""
 description: |-
   An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  aclprofilename|x|||
-  msgvpnname|x|||
+  Attribute|Identifying
+  :---|:---:
+  aclprofilename|x
+  msgvpnname|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
 ---
@@ -17,10 +17,10 @@ description: |-
 An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-acl_profile_name|x|||
-msg_vpn_name|x|||
+Attribute|Identifying
+:---|:---:
+acl_profile_name|x
+msg_vpn_name|x
 
 
 
@@ -46,7 +46,6 @@ This has been available since SEMP API version 2.0.
 "allow" - Allow client connection unless an exception is found for it.
 "disallow" - Disallow client connection unless an exception is found for it.
-- `id` (String) Identifier attribute, for internal use only. - `publish_topic_default_action` (String) The default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"disallow"`. The allowed values and their meaning are: 
diff --git a/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md b/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md
index 64a96636..0f3f79d8 100644
--- a/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md
+++ b/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_acl_profile_client_connect_exception Data Sour
 subcategory: ""
 description: |-
   A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  aclprofilename|x|||
-  clientconnectexceptionaddress|x|||
-  msgvpn_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  aclprofilename|x
+  clientconnectexceptionaddress|x
+  msgvpn_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
 ---
@@ -18,11 +18,11 @@ description: |-
 A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-acl_profile_name|x|||
-client_connect_exception_address|x|||
-msg_vpn_name|x|||
+Attribute|Identifying
+:---|:---:
+acl_profile_name|x
+client_connect_exception_address|x
+msg_vpn_name|x
 
 
 
@@ -40,7 +40,3 @@ This has been available since SEMP API version 2.0.
 - `acl_profile_name` (String) The name of the ACL Profile.
 - `client_connect_exception_address` (String) The IP address/netmask of the client connect exception in canonical CIDR form.
 - `msg_vpn_name` (String) The name of the Message VPN.
-
-### Read-Only
-
-- `id` (String) Identifier attribute, for internal use only.
diff --git a/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md b/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md
index 6c49896c..f5a6847f 100644
--- a/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md
+++ b/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md
@@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_acl_profile_publish_topic_exception Data Sourc
 subcategory: ""
 description: |-
   A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  aclprofilename|x|||
-  msgvpnname|x|||
-  publishtopicexception|x|||
-  publishtopicexception_syntax|x|||
+  Attribute|Identifying
+  :---|:---:
+  aclprofilename|x
+  msgvpnname|x
+  publishtopicexception|x
+  publishtopicexception_syntax|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.14.
 ---
@@ -19,12 +19,12 @@ description: |-
 A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-acl_profile_name|x|||
-msg_vpn_name|x|||
-publish_topic_exception|x|||
-publish_topic_exception_syntax|x|||
+Attribute|Identifying
+:---|:---:
+acl_profile_name|x
+msg_vpn_name|x
+publish_topic_exception|x
+publish_topic_exception_syntax|x
 
 
 
@@ -48,7 +48,3 @@ This has been available since SEMP API version 2.14.
 "smf" - Topic uses SMF syntax.
 "mqtt" - Topic uses MQTT syntax.
- -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md b/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md index 6dd67261..7741ac95 100644 --- a/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md +++ b/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_share_name_exception Dat subcategory: "" description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclprofilename|x||| - msgvpnname|x||| - subscribesharenameexception|x||| - subscribesharenameexception_syntax|x||| + Attribute|Identifying + :---|:---: + aclprofilename|x + msgvpnname|x + subscribesharenameexception|x + subscribesharenameexception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,12 +19,12 @@ description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -acl_profile_name|x||| -msg_vpn_name|x||| -subscribe_share_name_exception|x||| -subscribe_share_name_exception_syntax|x||| +Attribute|Identifying +:---|:---: +acl_profile_name|x +msg_vpn_name|x +subscribe_share_name_exception|x +subscribe_share_name_exception_syntax|x @@ -48,7 +48,3 @@ This has been available since SEMP API version 2.14. "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md b/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md index 8e7ff1f6..74e62ec0 100644 --- a/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md +++ b/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_topic_exception Data Sou subcategory: "" description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclprofilename|x||| - msgvpnname|x||| - subscribetopicexception|x||| - subscribetopicexception_syntax|x||| + Attribute|Identifying + :---|:---: + aclprofilename|x + msgvpnname|x + subscribetopicexception|x + subscribetopicexception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,12 +19,12 @@ description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -acl_profile_name|x||| -msg_vpn_name|x||| -subscribe_topic_exception|x||| -subscribe_topic_exception_syntax|x||| +Attribute|Identifying +:---|:---: +acl_profile_name|x +msg_vpn_name|x +subscribe_topic_exception|x +subscribe_topic_exception_syntax|x @@ -48,7 +48,3 @@ This has been available since SEMP API version 2.14. "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_authentication_oauth_profile.md b/docs/data-sources/msg_vpn_authentication_oauth_profile.md index 8366d7ec..e31f0b47 100644 --- a/docs/data-sources/msg_vpn_authentication_oauth_profile.md +++ b/docs/data-sources/msg_vpn_authentication_oauth_profile.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile Data Source - sol subcategory: "" description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientsecret||x||x - msgvpnname|x||| - oauthprofile_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + clientsecret||x|x + msgvpnname|x|| + oauthprofile_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,11 +18,11 @@ description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_secret||x||x -msg_vpn_name|x||| -oauth_profile_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +client_secret||x|x +msg_vpn_name|x|| +oauth_profile_name|x|| @@ -63,7 +63,6 @@ This has been available since SEMP API version 2.25. - `endpoint_jwks_refresh_interval` (Number) The number of seconds between JWKS endpoint requests. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `86400`. - `endpoint_userinfo` (String) The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `endpoint_userinfo_timeout` (Number) The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. -- `id` (String) Identifier attribute, for internal use only. - `issuer` (String) The Issuer Identifier for the OAuth provider. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `mqtt_username_validate_enabled` (Boolean) Enable or disable whether the API provided MQTT client username will be validated against the username calculated from the token(s). When enabled, connection attempts by MQTT clients are rejected if they differ. Note that this value only applies to MQTT clients; SMF client usernames will not be validated. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `oauth_role` (String) The OAuth role of the broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"client"`. The allowed values and their meaning are: diff --git a/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md b/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md index 34db7b66..bfcf15a5 100644 --- a/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md +++ b/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_client_required_c subcategory: "" description: |- Additional claims to be verified in the ID token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientrequiredclaimname|x||| - msgvpnname|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + clientrequiredclaimname|x + msgvpnname|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,11 +18,11 @@ description: |- Additional claims to be verified in the ID token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_required_claim_name|x||| -msg_vpn_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +client_required_claim_name|x +msg_vpn_name|x +oauth_profile_name|x @@ -44,4 +44,3 @@ This has been available since SEMP API version 2.25. ### Read-Only - `client_required_claim_value` (String) The required claim value. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md b/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md index d61e338d..00e7d09b 100644 --- a/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md +++ b/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_resource_server_r subcategory: "" description: |- Additional claims to be verified in the access token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - oauthprofilename|x||| - resourceserverrequiredclaimname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + oauthprofilename|x + resourceserverrequiredclaimname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,11 +18,11 @@ description: |- Additional claims to be verified in the access token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -oauth_profile_name|x||| -resource_server_required_claim_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +oauth_profile_name|x +resource_server_required_claim_name|x @@ -43,5 +43,4 @@ This has been available since SEMP API version 2.25. ### Read-Only -- `id` (String) Identifier attribute, for internal use only. - `resource_server_required_claim_value` (String) The required claim value. diff --git a/docs/data-sources/msg_vpn_authorization_group.md b/docs/data-sources/msg_vpn_authorization_group.md index 80762627..6e95065d 100644 --- a/docs/data-sources/msg_vpn_authorization_group.md +++ b/docs/data-sources/msg_vpn_authorization_group.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_authorization_group Data Source - solacebroker subcategory: "" description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationgroupname|x||| - msgvpnname|x||| - orderafterauthorizationgroupname||x|| - orderbeforeauthorizationgroupname||x|| + Attribute|Identifying|Write-Only + :---|:---:|:---: + authorizationgroupname|x| + msgvpnname|x| + orderafterauthorizationgroupname||x + orderbeforeauthorizationgroupname||x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -19,12 +19,12 @@ description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authorization_group_name|x||| -msg_vpn_name|x||| -order_after_authorization_group_name||x|| -order_before_authorization_group_name||x|| +Attribute|Identifying|Write-Only +:---|:---:|:---: +authorization_group_name|x| +msg_vpn_name|x| +order_after_authorization_group_name||x +order_before_authorization_group_name||x @@ -47,4 +47,3 @@ This has been available since SEMP API version 2.0. - `acl_profile_name` (String) The ACL Profile of the Authorization Group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`. - `client_profile_name` (String) The Client Profile of the Authorization Group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`. - `enabled` (Boolean) Enable or disable the Authorization Group in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_bridge.md b/docs/data-sources/msg_vpn_bridge.md index 396e8ec6..da680190 100644 --- a/docs/data-sources/msg_vpn_bridge.md +++ b/docs/data-sources/msg_vpn_bridge.md @@ -4,14 +4,14 @@ page_title: "solacebroker_msg_vpn_bridge Data Source - solacebroker" subcategory: "" description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgename|x||| - bridgevirtualrouter|x||| - msgvpnname|x||| - remoteauthenticationbasicpassword||x||x - remoteauthenticationclientcertcontent||x||x - remoteauthenticationclientcertpassword||x|| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + bridgename|x|| + bridgevirtualrouter|x|| + msgvpnname|x|| + remoteauthenticationbasicpassword||x|x + remoteauthenticationclientcertcontent||x|x + remoteauthenticationclientcertpassword||x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -21,14 +21,14 @@ description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -bridge_name|x||| -bridge_virtual_router|x||| -msg_vpn_name|x||| -remote_authentication_basic_password||x||x -remote_authentication_client_cert_content||x||x -remote_authentication_client_cert_password||x|| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +bridge_name|x|| +bridge_virtual_router|x|| +msg_vpn_name|x|| +remote_authentication_basic_password||x|x +remote_authentication_client_cert_content||x|x +remote_authentication_client_cert_password||x| @@ -56,7 +56,6 @@ This has been available since SEMP API version 2.0. ### Read-Only - `enabled` (Boolean) Enable or disable the Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `max_ttl` (Number) The maximum time-to-live (TTL) in hops. Messages are discarded if their TTL exceeds this value. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `8`. - `remote_authentication_basic_client_username` (String) The Client Username the Bridge uses to login to the remote Message VPN. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `remote_authentication_scheme` (String) The authentication scheme for the remote Message VPN. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"basic"`. The allowed values and their meaning are: diff --git a/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md b/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md index 9e69a806..90ae4d70 100644 --- a/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md +++ b/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md @@ -4,15 +4,15 @@ page_title: "solacebroker_msg_vpn_bridge_remote_msg_vpn Data Source - solacebrok subcategory: "" description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgename|x||| - bridgevirtualrouter|x||| - msgvpnname|x||| - password||x||x - remotemsgvpninterface|x||| - remotemsgvpnlocation|x||| - remotemsgvpnname|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + bridgename|x|| + bridgevirtualrouter|x|| + msgvpnname|x|| + password||x|x + remotemsgvpninterface|x|| + remotemsgvpnlocation|x|| + remotemsgvpnname|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -22,15 +22,15 @@ description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -bridge_name|x||| -bridge_virtual_router|x||| -msg_vpn_name|x||| -password||x||x -remote_msg_vpn_interface|x||| -remote_msg_vpn_location|x||| -remote_msg_vpn_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +bridge_name|x|| +bridge_virtual_router|x|| +msg_vpn_name|x|| +password||x|x +remote_msg_vpn_interface|x|| +remote_msg_vpn_location|x|| +remote_msg_vpn_name|x|| @@ -65,7 +65,6 @@ This has been available since SEMP API version 2.0. - `connect_order` (Number) The preference given to incoming connections from remote Message VPN hosts, from 1 (highest priority) to 4 (lowest priority). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - `egress_flow_window_size` (Number) The number of outstanding guaranteed messages that can be transmitted over the remote Message VPN connection before an acknowledgment is received. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. - `enabled` (Boolean) Enable or disable the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `queue_binding` (String) The queue binding of the Bridge in the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `tls_enabled` (Boolean) Enable or disable encryption (TLS) for the remote Message VPN connection. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `unidirectional_client_profile` (String) The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2 MB. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"#client-profile"`. diff --git a/docs/data-sources/msg_vpn_bridge_remote_subscription.md b/docs/data-sources/msg_vpn_bridge_remote_subscription.md index 35bf993a..941b9241 100644 --- a/docs/data-sources/msg_vpn_bridge_remote_subscription.md +++ b/docs/data-sources/msg_vpn_bridge_remote_subscription.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_bridge_remote_subscription Data Source - solac subcategory: "" description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgename|x||| - bridgevirtualrouter|x||| - msgvpnname|x||| - remotesubscription_topic|x||| + Attribute|Identifying + :---|:---: + bridgename|x + bridgevirtualrouter|x + msgvpnname|x + remotesubscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -19,12 +19,12 @@ description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -bridge_name|x||| -bridge_virtual_router|x||| -msg_vpn_name|x||| -remote_subscription_topic|x||| +Attribute|Identifying +:---|:---: +bridge_name|x +bridge_virtual_router|x +msg_vpn_name|x +remote_subscription_topic|x @@ -53,4 +53,3 @@ This has been available since SEMP API version 2.0. ### Read-Only - `deliver_always_enabled` (Boolean) Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_cert_matching_rule.md b/docs/data-sources/msg_vpn_cert_matching_rule.md index d1cc3423..a12fbe1c 100644 --- a/docs/data-sources/msg_vpn_cert_matching_rule.md +++ b/docs/data-sources/msg_vpn_cert_matching_rule.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule Data Source - solacebroker" subcategory: "" description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - rule_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + rule_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -17,10 +17,10 @@ description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +rule_name|x @@ -41,4 +41,3 @@ This has been available since SEMP API version 2.27. ### Read-Only - `enabled` (Boolean) Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md b/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md index 3ec06853..f23f6040 100644 --- a/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md +++ b/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_attribute_filter Data Sourc subcategory: "" description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - filtername|x||| - msgvpnname|x||| - rulename|x||| + Attribute|Identifying + :---|:---: + filtername|x + msgvpnname|x + rulename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -filter_name|x||| -msg_vpn_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +filter_name|x +msg_vpn_name|x +rule_name|x @@ -45,4 +45,3 @@ This has been available since SEMP API version 2.28. - `attribute_name` (String) Client Username Attribute to be tested. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `attribute_value` (String) Expected attribute value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_cert_matching_rule_condition.md b/docs/data-sources/msg_vpn_cert_matching_rule_condition.md index 87d0081b..3a8878c6 100644 --- a/docs/data-sources/msg_vpn_cert_matching_rule_condition.md +++ b/docs/data-sources/msg_vpn_cert_matching_rule_condition.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_condition Data Source - sol subcategory: "" description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - rule_name|x||| - source|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + rule_name|x + source|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -rule_name|x||| -source|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +rule_name|x +source|x @@ -61,4 +61,3 @@ This has been available since SEMP API version 2.27. - `attribute` (String) Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`. - `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_client_profile.md b/docs/data-sources/msg_vpn_client_profile.md index 7f7474c3..141178f7 100644 --- a/docs/data-sources/msg_vpn_client_profile.md +++ b/docs/data-sources/msg_vpn_client_profile.md @@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_client_profile Data Source - solacebroker" subcategory: "" description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowcutthroughforwardingenabled|||x| - apiqueuemanagementcopyfromoncreatename|||x| - apitopicendpointmanagementcopyfromoncreatename|||x| - clientprofilename|x||| - msgvpn_name|x||| + Attribute|Identifying|Deprecated + :---|:---:|:---: + allowcutthroughforwardingenabled||x + apiqueuemanagementcopyfromoncreatename||x + apitopicendpointmanagementcopyfromoncreatename||x + clientprofilename|x| + msgvpn_name|x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -20,13 +20,13 @@ description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -allow_cut_through_forwarding_enabled|||x| -api_queue_management_copy_from_on_create_name|||x| -api_topic_endpoint_management_copy_from_on_create_name|||x| -client_profile_name|x||| -msg_vpn_name|x||| +Attribute|Identifying|Deprecated +:---|:---:|:---: +allow_cut_through_forwarding_enabled||x +api_queue_management_copy_from_on_create_name||x +api_topic_endpoint_management_copy_from_on_create_name||x +client_profile_name|x| +msg_vpn_name|x| @@ -76,7 +76,6 @@ This has been available since SEMP API version 2.0. - `event_subscription_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_subscription_count_threshold)) - `event_transacted_session_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_transacted_session_count_threshold)) - `event_transaction_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_transaction_count_threshold)) -- `id` (String) Identifier attribute, for internal use only. - `max_connection_count_per_client_username` (Number) The maximum number of client connections per Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. - `max_egress_flow_count` (Number) The maximum number of transmit flows that can be created by one client using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - `max_endpoint_count_per_client_username` (Number) The maximum number of queues and topic endpoints that can be created by clients with the same Client Username using the Client Profile. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. @@ -94,7 +93,7 @@ This has been available since SEMP API version 2.0. - `queue_direct3_max_depth` (Number) The maximum depth of the "Direct 3" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. - `queue_direct3_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the `queue_direct3_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - `queue_guaranteed1_max_depth` (Number) The maximum depth of the "Guaranteed 1" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. -- `queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-3) priority queue, regardless of the `queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. +- `queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-1) priority queue, regardless of the `queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. - `reject_msg_to_sender_on_no_subscription_match_enabled` (Boolean) Enable or disable the sending of a negative acknowledgment (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.2. - `replication_allow_client_connect_when_standby_enabled` (Boolean) Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `service_min_keepalive_timeout` (Number) The minimum client keepalive timeout which will be enforced for client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. Available since SEMP API version 2.19. diff --git a/docs/data-sources/msg_vpn_client_username.md b/docs/data-sources/msg_vpn_client_username.md index 3d52ac7f..ebca952a 100644 --- a/docs/data-sources/msg_vpn_client_username.md +++ b/docs/data-sources/msg_vpn_client_username.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_client_username Data Source - solacebroker" subcategory: "" description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientusername|x||| - msgvpn_name|x||| - password||x||x + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + clientusername|x|| + msgvpn_name|x|| + password||x|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,11 +18,11 @@ description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_username|x||| -msg_vpn_name|x||| -password||x||x +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +client_username|x|| +msg_vpn_name|x|| +password||x|x @@ -46,5 +46,4 @@ This has been available since SEMP API version 2.0. - `client_profile_name` (String) The Client Profile of the Client Username. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`. - `enabled` (Boolean) Enable or disable the Client Username. When disabled, all clients currently connected as the Client Username are disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `guaranteed_endpoint_permission_override_enabled` (Boolean) Enable or disable guaranteed endpoint permission override for the Client Username. When enabled all guaranteed endpoints may be accessed, modified or deleted with the same permission as the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `subscription_manager_enabled` (Boolean) Enable or disable the subscription management capability of the Client Username. This is the ability to manage subscriptions on behalf of other Client Usernames. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. diff --git a/docs/data-sources/msg_vpn_client_username_attribute.md b/docs/data-sources/msg_vpn_client_username_attribute.md index cc246760..ef5e52c0 100644 --- a/docs/data-sources/msg_vpn_client_username_attribute.md +++ b/docs/data-sources/msg_vpn_client_username_attribute.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_client_username_attribute Data Source - solace subcategory: "" description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - attributename|x||| - attributevalue|x||| - clientusername|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + attributename|x + attributevalue|x + clientusername|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -19,12 +19,12 @@ description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -attribute_name|x||| -attribute_value|x||| -client_username|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +attribute_name|x +attribute_value|x +client_username|x +msg_vpn_name|x @@ -43,7 +43,3 @@ This has been available since SEMP API version 2.27. - `attribute_value` (String) The value of the Attribute. - `client_username` (String) The name of the Client Username. - `msg_vpn_name` (String) The name of the Message VPN. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_distributed_cache.md b/docs/data-sources/msg_vpn_distributed_cache.md index fdbc7a4a..9ddc68dc 100644 --- a/docs/data-sources/msg_vpn_distributed_cache.md +++ b/docs/data-sources/msg_vpn_distributed_cache.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_distributed_cache Data Source - solacebroker" subcategory: "" description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + cachename|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,10 +17,10 @@ description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +msg_vpn_name|x @@ -48,6 +48,5 @@ This has been available since SEMP API version 2.11. Available since SEMP API version 2.28. - `enabled` (Boolean) Enable or disable the Distributed Cache. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `heartbeat` (Number) The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`. -- `id` (String) Identifier attribute, for internal use only. - `scheduled_delete_msg_day_list` (String) The scheduled delete message day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduled_delete_msg_time_list" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `scheduled_delete_msg_time_list` (String) The scheduled delete message time(s), specified as "hourly" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduled_delete_msg_day_list" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster.md b/docs/data-sources/msg_vpn_distributed_cache_cluster.md index b1136695..a46a010d 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster Data Source - solace subcategory: "" description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - msgvpnname|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -18,11 +18,11 @@ description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +msg_vpn_name|x @@ -55,7 +55,6 @@ This has been available since SEMP API version 2.11. - `global_caching_enabled` (Boolean) Enable or disable global caching for the Cache Cluster. When enabled, the Cache Instances will fetch topics from remote Home Cache Clusters when requested, and subscribe to those topics to cache them locally. When disabled, the Cache Instances will remove all subscriptions and cached messages for topics from remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `global_caching_heartbeat` (Number) The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the remote Home Cache Clusters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - `global_caching_topic_lifetime` (Number) The topic lifetime, in seconds. If no client requests are received for a given global topic over the duration of the topic lifetime, then the Cache Instance will remove the subscription and cached messages for that topic. A value of 0 disables aging. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3600`. -- `id` (String) Identifier attribute, for internal use only. - `max_memory` (Number) The maximum memory usage, in megabytes (MB), for each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2048`. - `max_msgs_per_topic` (Number) The maximum number of messages per topic for each Cache Instance in the Cache Cluster. When at the maximum, old messages are removed as new messages arrive. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - `max_request_queue_depth` (Number) The maximum queue depth for cache requests received by the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `100000`. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md index c93cd8d9..1ffda305 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - homeclustername|x||| - msgvpnname|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + homeclustername|x + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,12 +19,12 @@ description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -home_cluster_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +home_cluster_name|x +msg_vpn_name|x @@ -43,7 +43,3 @@ This has been available since SEMP API version 2.11. - `cluster_name` (String) The name of the Cache Cluster. - `home_cluster_name` (String) The name of the remote Home Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md index b595cf5c..0ce756d8 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md @@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - homeclustername|x||| - msgvpnname|x||| - topic_prefix|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + homeclustername|x + msgvpnname|x + topic_prefix|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -20,13 +20,13 @@ description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -home_cluster_name|x||| -msg_vpn_name|x||| -topic_prefix|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +home_cluster_name|x +msg_vpn_name|x +topic_prefix|x @@ -46,7 +46,3 @@ This has been available since SEMP API version 2.11. - `home_cluster_name` (String) The name of the remote Home Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. - `topic_prefix` (String) A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md index 9510fa30..d9fd3cbd 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_instance Data Source subcategory: "" description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - instancename|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + instancename|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,12 +19,12 @@ description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -instance_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +instance_name|x +msg_vpn_name|x @@ -48,5 +48,4 @@ This has been available since SEMP API version 2.11. - `auto_start_enabled` (Boolean) Enable or disable auto-start for the Cache Instance. When enabled, the Cache Instance will automatically attempt to transition from the Stopped operational state to Up whenever it restarts or reconnects to the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `enabled` (Boolean) Enable or disable the Cache Instance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `stop_on_lost_msg_enabled` (Boolean) Enable or disable stop-on-lost-message for the Cache Instance. When enabled, the Cache Instance will transition to the stopped operational state upon losing a message. When stopped, it cannot accept or respond to cache requests, but continues to cache messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md index 0d999211..3f8883b7 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_topic Data Source - subcategory: "" description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - msgvpnname|x||| - topic|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + msgvpnname|x + topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,12 +19,12 @@ description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -msg_vpn_name|x||| -topic|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +msg_vpn_name|x +topic|x @@ -43,7 +43,3 @@ This has been available since SEMP API version 2.11. - `cluster_name` (String) The name of the Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. - `topic` (String) The value of the Topic in the form a/b/c. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_dmr_bridge.md b/docs/data-sources/msg_vpn_dmr_bridge.md index b9b3e5ce..4401d906 100644 --- a/docs/data-sources/msg_vpn_dmr_bridge.md +++ b/docs/data-sources/msg_vpn_dmr_bridge.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_dmr_bridge Data Source - solacebroker" subcategory: "" description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - remotenodename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + remotenodename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,10 +17,10 @@ description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -remote_node_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +remote_node_name|x @@ -40,5 +40,4 @@ This has been available since SEMP API version 2.11. ### Read-Only -- `id` (String) Identifier attribute, for internal use only. - `remote_msg_vpn_name` (String) The remote Message VPN of the DMR Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. diff --git a/docs/data-sources/msg_vpn_jndi_connection_factory.md b/docs/data-sources/msg_vpn_jndi_connection_factory.md index c3bea014..f195f5f0 100644 --- a/docs/data-sources/msg_vpn_jndi_connection_factory.md +++ b/docs/data-sources/msg_vpn_jndi_connection_factory.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_jndi_connection_factory Data Source - solacebr subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - connectionfactoryname|x||| - msgvpnname|x||| + Attribute|Identifying + :---|:---: + connectionfactoryname|x + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -17,10 +17,10 @@ description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -connection_factory_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +connection_factory_name|x +msg_vpn_name|x @@ -56,7 +56,6 @@ This has been available since SEMP API version 2.2. - `guaranteed_receive_window_size_ack_threshold` (Number) The threshold for sending the acknowledgment (ACK) for guaranteed messages received by the Subscriber (Consumer) as a percentage of `guaranteed_receive_window_size`. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60`. - `guaranteed_send_ack_timeout` (Number) The timeout for receiving the acknowledgment (ACK) for guaranteed messages sent by the Publisher (Producer), in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `2000`. - `guaranteed_send_window_size` (Number) The size of the window for non-persistent guaranteed messages sent by the Publisher (Producer), in messages. For persistent messages the window size is fixed at 1. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. -- `id` (String) Identifier attribute, for internal use only. - `messaging_default_delivery_mode` (String) The default delivery mode for messages sent by the Publisher (Producer). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"persistent"`. The allowed values and their meaning are: 
diff --git a/docs/data-sources/msg_vpn_jndi_queue.md b/docs/data-sources/msg_vpn_jndi_queue.md
index be0a0b84..5ed252e1 100644
--- a/docs/data-sources/msg_vpn_jndi_queue.md
+++ b/docs/data-sources/msg_vpn_jndi_queue.md
@@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_jndi_queue Data Source - solacebroker"
 subcategory: ""
 description: |-
   The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  msgvpnname|x|||
-  queue_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  msgvpnname|x
+  queue_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.2.
 ---
@@ -17,10 +17,10 @@ description: |-
 The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-msg_vpn_name|x|||
-queue_name|x|||
+Attribute|Identifying
+:---|:---:
+msg_vpn_name|x
+queue_name|x
 
 
 
@@ -40,5 +40,4 @@ This has been available since SEMP API version 2.2.
 
 ### Read-Only
 
-- `id` (String) Identifier attribute, for internal use only.
 - `physical_name` (String) The physical name of the JMS Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
diff --git a/docs/data-sources/msg_vpn_jndi_topic.md b/docs/data-sources/msg_vpn_jndi_topic.md
index 3a32182d..4ddc7243 100644
--- a/docs/data-sources/msg_vpn_jndi_topic.md
+++ b/docs/data-sources/msg_vpn_jndi_topic.md
@@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_jndi_topic Data Source - solacebroker"
 subcategory: ""
 description: |-
   The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  msgvpnname|x|||
-  topic_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  msgvpnname|x
+  topic_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.2.
 ---
@@ -17,10 +17,10 @@ description: |-
 The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-msg_vpn_name|x|||
-topic_name|x|||
+Attribute|Identifying
+:---|:---:
+msg_vpn_name|x
+topic_name|x
 
 
 
@@ -40,5 +40,4 @@ This has been available since SEMP API version 2.2.
 
 ### Read-Only
 
-- `id` (String) Identifier attribute, for internal use only.
 - `physical_name` (String) The physical name of the JMS Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
diff --git a/docs/data-sources/msg_vpn_kafka_receiver.md b/docs/data-sources/msg_vpn_kafka_receiver.md
index 4acc9d60..2c8411d5 100644
--- a/docs/data-sources/msg_vpn_kafka_receiver.md
+++ b/docs/data-sources/msg_vpn_kafka_receiver.md
@@ -4,16 +4,15 @@ page_title: "solacebroker_msg_vpn_kafka_receiver Data Source - solacebroker"
 subcategory: ""
 description: |-
   A Kafka Receiver receives messages from a Kafka Cluster.
-  WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authenticationbasicpassword||x||x
-  authenticationclientcertcontent||x||x
-  authenticationclientcertpassword||x||
-  authenticationoauthclientsecret||x||x
-  authenticationscrampassword||x||x
-  kafkareceivername|x|||
-  msgvpn_name|x|||
+  Attribute|Identifying|Write-Only|Opaque
+  :---|:---:|:---:|:---:
+  authenticationbasicpassword||x|x
+  authenticationclientcertcontent||x|x
+  authenticationclientcertpassword||x|
+  authenticationoauthclientsecret||x|x
+  authenticationscrampassword||x|x
+  kafkareceivername|x||
+  msgvpn_name|x||
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.36.
 ---
@@ -22,18 +21,16 @@ description: |-
 
 A Kafka Receiver receives messages from a Kafka Cluster.
 
-WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.
 
-
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_basic_password||x||x
-authentication_client_cert_content||x||x
-authentication_client_cert_password||x||
-authentication_oauth_client_secret||x||x
-authentication_scram_password||x||x
-kafka_receiver_name|x|||
-msg_vpn_name|x|||
+Attribute|Identifying|Write-Only|Opaque
+:---|:---:|:---:|:---:
+authentication_basic_password||x|x
+authentication_client_cert_content||x|x
+authentication_client_cert_password||x|
+authentication_oauth_client_secret||x|x
+authentication_scram_password||x|x
+kafka_receiver_name|x||
+msg_vpn_name|x||
 
 
 
@@ -53,41 +50,72 @@ This has been available since SEMP API version 2.36.
 
 ### Read-Only
 
-- `authentication_basic_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_oauth_client_id` (String) The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_oauth_client_scope` (String) The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with "https". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_scheme` (String) The authentication scheme for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are:
+- `authentication_basic_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authentication_scheme is "basic". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_oauth_client_id` (String) The OAuth client ID. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_oauth_client_scope` (String) The OAuth scope. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with "https". To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_scheme` (String) The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are:
 
 
-"none" - Anonymous Authentication.
-"basic" - Basic Authentication.
-"scram" - Salted Challenge Response Authentication.
-"client-certificate" - Client Certificate Authentication.
-"oauth-client" - Oauth Authentication.
+"none" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.
+"basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.
+"oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.
 

-- `authentication_scram_hash` (String) The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are:
+- `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are:
 
 
 "sha-256" - SHA-2 256 bits.
 "sha-512" - SHA-2 512 bits.
 

-- `authentication_scram_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`.
-- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.
-- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_scram_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis.
+
+This corresponds to the Kafka consumer API `fetch.max.wait.ms` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`.
+- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis.
+
+This corresponds to the Kafka consumer API `fetch.min.bytes` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.
+- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.
+
+This corresponds to the Kafka consumer API `bootstrap.servers` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
 - `enabled` (Boolean) Enable or disable the Kafka Receiver. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `group_id` (String) The id of the Kafka consumer group for the Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `group_keepalive_interval` (Number) The time between sending keepalives to the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.
-- `group_keepalive_timeout` (Number) The time until unresponsive group members are removed, triggering a partition rebalance across other members of the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`.
-- `group_membership_type` (String) The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within group_keepalive_timeout) without prompting a group rebalance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"dynamic"`. The allowed values and their meaning are:
+- `group_id` (String) The id of the Kafka consumer group for the Receiver.
+
+This corresponds to the Kafka consumer API `group.id` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `group_keepalive_interval` (Number) The time (in ms) between sending keepalives to the group.
+
+This corresponds to the Kafka consumer API `heartbeat.interval.ms` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.
+- `group_keepalive_timeout` (Number) The time (in ms) until unresponsive group members are removed, triggering a partition rebalance across other members of the group.
+
+This corresponds to the Kafka consumer API `session.timeout.ms` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`.
+- `group_membership_type` (String) The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within group_keepalive_timeout) without prompting a group rebalance.
+
+This corresponds to the Kafka consumer API `group.instance.id` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"dynamic"`. The allowed values and their meaning are:
 
 
 "dynamic" - Dynamic Membership.
 "static" - Static Membership.
 

-- `group_partition_scheme_list` (String) The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager ("range", "roundrobin") and Cooperative ("cooperative-sticky") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"range,roundrobin"`.
-- `id` (String) Identifier attribute, for internal use only.
+- `group_partition_scheme_list` (String) The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager ("range", "roundrobin") and Cooperative ("cooperative-sticky") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation.
+
+This corresponds to the Kafka consumer API `partition.assignment.strategy` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"range,roundrobin"`.
 - `metadata_topic_exclude_list` (String) A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
 - `metadata_topic_refresh_interval` (Number) The time between refreshes of topic metadata from the Kafka Cluster. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`.
-- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
+- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Receiver. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
diff --git a/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md b/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md
index d740e546..943f9f65 100644
--- a/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md
+++ b/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_kafka_receiver_topic_binding Data Source - sol
 subcategory: ""
 description: |-
   A Topic Binding receives messages from a remote Kafka Topic.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  kafkareceivername|x|||
-  msgvpnname|x|||
-  topic_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  kafkareceivername|x
+  msgvpnname|x
+  topic_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.36.
 ---
@@ -18,11 +18,11 @@ description: |-
 A Topic Binding receives messages from a remote Kafka Topic.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-kafka_receiver_name|x|||
-msg_vpn_name|x|||
-topic_name|x|||
+Attribute|Identifying
+:---|:---:
+kafka_receiver_name|x
+msg_vpn_name|x
+topic_name|x
 
 
 
@@ -44,8 +44,11 @@ This has been available since SEMP API version 2.36.
 ### Read-Only
 
 - `enabled` (Boolean) Enable or disable this topic binding of the Kafka Receiver. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `id` (String) Identifier attribute, for internal use only.
-- `initial_offset` (String) The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"end"`. The allowed values and their meaning are:
+- `initial_offset` (String) The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition.
+
+This corresponds to the Kafka consumer API `auto.offset.reset` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"end"`. The allowed values and their meaning are:
 
 
 "beginning" - Start with the earliest offset available.
@@ -53,7 +56,11 @@ This has been available since SEMP API version 2.36.
 

 - `local_key` (String) The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.
 
-If empty, no key is included for each message as it is published into Solace. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+If empty, no key is included for each message as it is published into Solace.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
 - `local_topic` (String) The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.
 
-If empty, the Topic Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+If empty, the Topic Binding will not be operational.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
diff --git a/docs/data-sources/msg_vpn_kafka_sender.md b/docs/data-sources/msg_vpn_kafka_sender.md
index a910fe94..5a2b20b0 100644
--- a/docs/data-sources/msg_vpn_kafka_sender.md
+++ b/docs/data-sources/msg_vpn_kafka_sender.md
@@ -4,16 +4,15 @@ page_title: "solacebroker_msg_vpn_kafka_sender Data Source - solacebroker"
 subcategory: ""
 description: |-
   A Kafka Sender sends messages to a Kafka Cluster.
-  WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authenticationbasicpassword||x||x
-  authenticationclientcertcontent||x||x
-  authenticationclientcertpassword||x||
-  authenticationoauthclientsecret||x||x
-  authenticationscrampassword||x||x
-  kafkasendername|x|||
-  msgvpn_name|x|||
+  Attribute|Identifying|Write-Only|Opaque
+  :---|:---:|:---:|:---:
+  authenticationbasicpassword||x|x
+  authenticationclientcertcontent||x|x
+  authenticationclientcertpassword||x|
+  authenticationoauthclientsecret||x|x
+  authenticationscrampassword||x|x
+  kafkasendername|x||
+  msgvpn_name|x||
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.36.
 ---
@@ -22,18 +21,16 @@ description: |-
 
 A Kafka Sender sends messages to a Kafka Cluster.
 
-WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.
 
-
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_basic_password||x||x
-authentication_client_cert_content||x||x
-authentication_client_cert_password||x||
-authentication_oauth_client_secret||x||x
-authentication_scram_password||x||x
-kafka_sender_name|x|||
-msg_vpn_name|x|||
+Attribute|Identifying|Write-Only|Opaque
+:---|:---:|:---:|:---:
+authentication_basic_password||x|x
+authentication_client_cert_content||x|x
+authentication_client_cert_password||x|
+authentication_oauth_client_secret||x|x
+authentication_scram_password||x|x
+kafka_sender_name|x||
+msg_vpn_name|x||
 
 
 
@@ -53,36 +50,59 @@ This has been available since SEMP API version 2.36.
 
 ### Read-Only
 
-- `authentication_basic_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_oauth_client_id` (String) The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_oauth_client_scope` (String) The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with "https". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `authentication_scheme` (String) The authentication scheme for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are:
+- `authentication_basic_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authentication_scheme is "basic". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_oauth_client_id` (String) The OAuth client ID. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_oauth_client_scope` (String) The OAuth scope. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with "https". To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `authentication_scheme` (String) The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are:
 
 
-"none" - Anonymous Authentication.
-"basic" - Basic Authentication.
-"scram" - Salted Challenge Response Authentication.
-"client-certificate" - Client Certificate Authentication.
-"oauth-client" - Oauth Authentication.
+"none" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.
+"basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.
+"oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.
 

-- `authentication_scram_hash` (String) The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are:
+- `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are:
 
 
 "sha-256" - SHA-2 256 bits.
 "sha-512" - SHA-2 512 bits.
 

-- `authentication_scram_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.
+- `authentication_scram_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis.
+
+This corresponds to the Kafka producer API `linger.ms` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.
 - `batch_max_msg_count` (Number) Maximum number of messages sent in a single batch. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.
-- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.
-- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis.
+
+This corresponds to the Kafka producer API `batch.size` configuration setting, and should not exceed either the Kafka broker `message.max.bytes` configuration setting, or the per-Topic override of `max.message.bytes`.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.
+- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.
+
+This corresponds to the Kafka producer API `bootstrap.servers` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
 - `enabled` (Boolean) Enable or disable the Kafka Sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `id` (String) Identifier attribute, for internal use only.
-- `idempotence_enabled` (Boolean) Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
+- `idempotence_enabled` (Boolean) Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. When idempotence is enabled the Queue Bindings of the Kafka Sender must have ack_mode of "all" to be operational.
+
+This corresponds to the Kafka producer API `enable.idempotence` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
 - `transport_compression_enabled` (Boolean) Enable or disable compression for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `transport_compression_level` (Number) Compression level. The valid range is dependent on the compression type. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.
-- `transport_compression_type` (String) Compression type. Only relevant if compression is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"gzip"`. The allowed values and their meaning are:
+- `transport_compression_level` (Number) Compression level. The valid range is dependent on the compression type.
+
+This corresponds to the Kafka producer API `compression.level` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.
+- `transport_compression_type` (String) Compression type. Only relevant if compression is enabled.
+
+This corresponds to the Kafka producer API `compression.type` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"gzip"`. The allowed values and their meaning are:
 
 
 "gzip" - GZIP Compression.
@@ -90,4 +110,4 @@ This has been available since SEMP API version 2.36.
 "lz4" - LZ4 Compression.
 "zstd" - Zstandard Compression.
 

-- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
+- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Sender. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
diff --git a/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md b/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md
index 92c667a1..96762ddc 100644
--- a/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md
+++ b/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_kafka_sender_queue_binding Data Source - solac
 subcategory: ""
 description: |-
   A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  kafkasendername|x|||
-  msgvpnname|x|||
-  queue_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  kafkasendername|x
+  msgvpnname|x
+  queue_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.36.
 ---
@@ -18,11 +18,11 @@ description: |-
 A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-kafka_sender_name|x|||
-msg_vpn_name|x|||
-queue_name|x|||
+Attribute|Identifying
+:---|:---:
+kafka_sender_name|x
+msg_vpn_name|x
+queue_name|x
 
 
 
@@ -43,7 +43,11 @@ This has been available since SEMP API version 2.36.
 
 ### Read-Only
 
-- `ack_mode` (String) The number of acks required from the remote Kafka broker. When "none" messages are delivered at-most-once. When "one" or "all" messages are delivered at-least-once but may be reordered. This is overridden to "all" for an idempotent Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"all"`. The allowed values and their meaning are:
+- `ack_mode` (String) The number of acks required from the remote Kafka broker. When "none" messages are delivered at-most-once. When "one" or "all" messages are delivered at-least-once but may be reordered. This must be configured as "all" for an idempotent Kafka Sender, otherwise the Queue Binding will be operationally down.
+
+This corresponds to the Kafka producer API `acks` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"all"`. The allowed values and their meaning are:
 
 
 "none" - No Acks.
@@ -51,7 +55,6 @@ This has been available since SEMP API version 2.36.
 "all" - All Replica Acks.
 

 - `enabled` (Boolean) Enable or disable this queue binding of the Kafka Sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `id` (String) Identifier attribute, for internal use only.
 - `partition_consistent_hash` (String) The hash algorithm to use for consistent partition selection. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"crc"`. The allowed values and their meaning are:
 
 
@@ -61,7 +64,11 @@ This has been available since SEMP API version 2.36.
 

 - `partition_explicit_number` (Number) The partition number to use for explicit partition selection. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.
 - `partition_random_fallback_enabled` (Boolean) Enable or disable fallback to the random partition selection scheme when the consistent partition scheme is being used but no partition key is available for the message. When enabled a random partition will be selected for each unkeyed messages, otherwise some partition will be selected for groups of unkeyed messages. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.
-- `partition_scheme` (String) The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"consistent"`. The allowed values and their meaning are:
+- `partition_scheme` (String) The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to.
+
+This corresponds to the Kafka producer API `partitioner.class` configuration setting.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"consistent"`. The allowed values and their meaning are:
 
 
 "consistent" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number.
@@ -70,7 +77,11 @@ This has been available since SEMP API version 2.36.
 

 - `remote_key` (String) The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue.
 
-If empty, no key is included for each message as it is published into Kafka. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+If empty, no key is included for each message as it is published into Kafka.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
 - `remote_topic` (String) The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to.
 
-If empty, the Queue Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
+If empty, the Queue Binding will not be operational.
+
+Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
diff --git a/docs/data-sources/msg_vpn_mqtt_retain_cache.md b/docs/data-sources/msg_vpn_mqtt_retain_cache.md
index 080e3246..2d554c6d 100644
--- a/docs/data-sources/msg_vpn_mqtt_retain_cache.md
+++ b/docs/data-sources/msg_vpn_mqtt_retain_cache.md
@@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_mqtt_retain_cache Data Source - solacebroker"
 subcategory: ""
 description: |-
   Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  cachename|x|||
-  msgvpn_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  cachename|x
+  msgvpn_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
 ---
@@ -17,10 +17,10 @@ description: |-
 Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-cache_name|x|||
-msg_vpn_name|x|||
+Attribute|Identifying
+:---|:---:
+cache_name|x
+msg_vpn_name|x
 
 
 
@@ -41,5 +41,4 @@ This has been available since SEMP API version 2.11.
 ### Read-Only
 
 - `enabled` (Boolean) Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `id` (String) Identifier attribute, for internal use only.
 - `msg_lifetime` (Number) The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.
diff --git a/docs/data-sources/msg_vpn_mqtt_session.md b/docs/data-sources/msg_vpn_mqtt_session.md
index 07fb6138..7530ac1b 100644
--- a/docs/data-sources/msg_vpn_mqtt_session.md
+++ b/docs/data-sources/msg_vpn_mqtt_session.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_mqtt_session Data Source - solacebroker"
 subcategory: ""
 description: |-
   An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  mqttsessionclientid|x|||
-  mqttsessionvirtualrouter|x|||
-  msgvpnname|x|||
+  Attribute|Identifying
+  :---|:---:
+  mqttsessionclientid|x
+  mqttsessionvirtualrouter|x
+  msgvpnname|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.1.
 ---
@@ -18,11 +18,11 @@ description: |-
 An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-mqtt_session_client_id|x|||
-mqtt_session_virtual_router|x|||
-msg_vpn_name|x|||
+Attribute|Identifying
+:---|:---:
+mqtt_session_client_id|x
+mqtt_session_virtual_router|x
+msg_vpn_name|x
 
 
 
@@ -50,7 +50,6 @@ This has been available since SEMP API version 2.1.
 ### Read-Only
 
 - `enabled` (Boolean) Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `id` (String) Identifier attribute, for internal use only.
 - `owner` (String) The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
 - `queue_consumer_ack_propagation_enabled` (Boolean) Enable or disable the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since SEMP API version 2.14.
 - `queue_dead_msg_queue` (String) The name of the Dead Message Queue (DMQ) used by the MQTT Session Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"#DEAD_MSG_QUEUE"`. Available since SEMP API version 2.14.
diff --git a/docs/data-sources/msg_vpn_mqtt_session_subscription.md b/docs/data-sources/msg_vpn_mqtt_session_subscription.md
index 995a547a..49cc88d0 100644
--- a/docs/data-sources/msg_vpn_mqtt_session_subscription.md
+++ b/docs/data-sources/msg_vpn_mqtt_session_subscription.md
@@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_mqtt_session_subscription Data Source - solace
 subcategory: ""
 description: |-
   An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  mqttsessionclientid|x|||
-  mqttsessionvirtualrouter|x|||
-  msgvpnname|x|||
-  subscription_topic|x|||
+  Attribute|Identifying
+  :---|:---:
+  mqttsessionclientid|x
+  mqttsessionvirtualrouter|x
+  msgvpnname|x
+  subscription_topic|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.1.
 ---
@@ -19,12 +19,12 @@ description: |-
 An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-mqtt_session_client_id|x|||
-mqtt_session_virtual_router|x|||
-msg_vpn_name|x|||
-subscription_topic|x|||
+Attribute|Identifying
+:---|:---:
+mqtt_session_client_id|x
+mqtt_session_virtual_router|x
+msg_vpn_name|x
+subscription_topic|x
 
 
 
@@ -52,5 +52,4 @@ This has been available since SEMP API version 2.1.
 
 ### Read-Only
 
-- `id` (String) Identifier attribute, for internal use only.
 - `subscription_qos` (Number) The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.
diff --git a/docs/data-sources/msg_vpn_proxy.md b/docs/data-sources/msg_vpn_proxy.md
index 2a66acaf..79284a96 100644
--- a/docs/data-sources/msg_vpn_proxy.md
+++ b/docs/data-sources/msg_vpn_proxy.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_proxy Data Source - solacebroker"
 subcategory: ""
 description: |-
   Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authenticationbasicpassword||x||x
-  msgvpnname|x|||
-  proxy_name|x|||
+  Attribute|Identifying|Write-Only|Opaque
+  :---|:---:|:---:|:---:
+  authenticationbasicpassword||x|x
+  msgvpnname|x||
+  proxy_name|x||
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.36.
 ---
@@ -18,11 +18,11 @@ description: |-
 Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_basic_password||x||x
-msg_vpn_name|x|||
-proxy_name|x|||
+Attribute|Identifying|Write-Only|Opaque
+:---|:---:|:---:|:---:
+authentication_basic_password||x|x
+msg_vpn_name|x||
+proxy_name|x||
 
 
 
@@ -51,7 +51,6 @@ This has been available since SEMP API version 2.36.
- `enabled` (Boolean) Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `host` (String) The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. -- `id` (String) Identifier attribute, for internal use only. - `port` (Number) The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. - `proxy_type` (String) The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"direct"`. The allowed values and their meaning are: diff --git a/docs/data-sources/msg_vpn_queue.md b/docs/data-sources/msg_vpn_queue.md index d437c3ee..18289833 100644 --- a/docs/data-sources/msg_vpn_queue.md +++ b/docs/data-sources/msg_vpn_queue.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_queue Data Source - solacebroker" subcategory: "" description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queue_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,10 +17,10 @@ description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_name|x @@ -54,7 +54,6 @@ This has been available since SEMP API version 2.0. - `event_bind_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_bind_count_threshold)) - `event_msg_spool_usage_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_msg_spool_usage_threshold)) - `event_reject_low_priority_msg_limit_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_reject_low_priority_msg_limit_threshold)) -- `id` (String) Identifier attribute, for internal use only. - `ingress_enabled` (Boolean) Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `max_bind_count` (Number) The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - `max_delivered_unacked_msgs_per_flow` (Number) The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. diff --git a/docs/data-sources/msg_vpn_queue_subscription.md b/docs/data-sources/msg_vpn_queue_subscription.md index 189511e8..8b38565d 100644 --- a/docs/data-sources/msg_vpn_queue_subscription.md +++ b/docs/data-sources/msg_vpn_queue_subscription.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_queue_subscription Data Source - solacebroker" subcategory: "" description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queuename|x||| - subscriptiontopic|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queuename|x + subscriptiontopic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,11 +18,11 @@ description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_name|x||| -subscription_topic|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_name|x +subscription_topic|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.0. - `msg_vpn_name` (String) The name of the Message VPN. - `queue_name` (String) The name of the Queue. - `subscription_topic` (String) The topic of the Subscription. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_queue_template.md b/docs/data-sources/msg_vpn_queue_template.md index 48181245..635fdd77 100644 --- a/docs/data-sources/msg_vpn_queue_template.md +++ b/docs/data-sources/msg_vpn_queue_template.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_queue_template Data Source - solacebroker" subcategory: "" description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queuetemplatename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queuetemplatename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -17,10 +17,10 @@ description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_template_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_template_name|x @@ -58,7 +58,6 @@ This has been available since SEMP API version 2.14. - `event_bind_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_bind_count_threshold)) - `event_msg_spool_usage_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_msg_spool_usage_threshold)) - `event_reject_low_priority_msg_limit_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_reject_low_priority_msg_limit_threshold)) -- `id` (String) Identifier attribute, for internal use only. - `max_bind_count` (Number) The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - `max_delivered_unacked_msgs_per_flow` (Number) The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. - `max_msg_size` (Number) The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. diff --git a/docs/data-sources/msg_vpn_replay_log.md b/docs/data-sources/msg_vpn_replay_log.md index b07cb628..6b112976 100644 --- a/docs/data-sources/msg_vpn_replay_log.md +++ b/docs/data-sources/msg_vpn_replay_log.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_replay_log Data Source - solacebroker" subcategory: "" description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - replaylogname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + replaylogname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.10. --- @@ -17,10 +17,10 @@ description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -replay_log_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +replay_log_name|x @@ -41,7 +41,6 @@ This has been available since SEMP API version 2.10. ### Read-Only - `egress_enabled` (Boolean) Enable or disable the transmission of messages from the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `ingress_enabled` (Boolean) Enable or disable the reception of messages to the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `max_spool_usage` (Number) The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - `topic_filter_enabled` (Boolean) Enable or disable topic filtering for the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.27. diff --git a/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md b/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md index d01dfcb1..16ad1028 100644 --- a/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md +++ b/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_replay_log_topic_filter_subscription Data Sour subcategory: "" description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - replaylogname|x||| - topicfiltersubscription|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + replaylogname|x + topicfiltersubscription|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -18,11 +18,11 @@ description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -replay_log_name|x||| -topic_filter_subscription|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +replay_log_name|x +topic_filter_subscription|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.27. - `msg_vpn_name` (String) The name of the Message VPN. - `replay_log_name` (String) The name of the Replay Log. - `topic_filter_subscription` (String) The topic of the Subscription. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_replicated_topic.md b/docs/data-sources/msg_vpn_replicated_topic.md index 754e4e33..fc0eeceb 100644 --- a/docs/data-sources/msg_vpn_replicated_topic.md +++ b/docs/data-sources/msg_vpn_replicated_topic.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_replicated_topic Data Source - solacebroker" subcategory: "" description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - replicated_topic|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + replicated_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -17,10 +17,10 @@ description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -replicated_topic|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +replicated_topic|x @@ -40,7 +40,6 @@ This has been available since SEMP API version 2.1. ### Read-Only -- `id` (String) Identifier attribute, for internal use only. - `replication_mode` (String) The replication mode for the Replicated Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"async"`. The allowed values and their meaning are: 
diff --git a/docs/data-sources/msg_vpn_rest_delivery_point.md b/docs/data-sources/msg_vpn_rest_delivery_point.md
index 9fdcd3d8..7396591f 100644
--- a/docs/data-sources/msg_vpn_rest_delivery_point.md
+++ b/docs/data-sources/msg_vpn_rest_delivery_point.md
@@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point Data Source - solacebroker
 subcategory: ""
 description: |-
   A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  msgvpnname|x|||
-  restdeliverypoint_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  msgvpnname|x
+  restdeliverypoint_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
 ---
@@ -17,10 +17,10 @@ description: |-
 A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-msg_vpn_name|x|||
-rest_delivery_point_name|x|||
+Attribute|Identifying
+:---|:---:
+msg_vpn_name|x
+rest_delivery_point_name|x
 
 
 
@@ -42,6 +42,5 @@ This has been available since SEMP API version 2.0.
 
 - `client_profile_name` (String) The Client Profile of the REST Delivery Point. It must exist in the local Message VPN. Its TCP parameters are used for all REST Consumers in this RDP. Its queue properties are used by the RDP client. The Client Profile is used inside the auto-generated Client Username for this RDP. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`.
 - `enabled` (Boolean) Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
-- `id` (String) Identifier attribute, for internal use only.
 - `service` (String) The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.19.
 - `vendor` (String) The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.19.
diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md
index 5fad84e9..3927504f 100644
--- a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md
+++ b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding Data Source
 subcategory: ""
 description: |-
   A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  msgvpnname|x|||
-  queuebindingname|x|||
-  restdeliverypoint_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  msgvpnname|x
+  queuebindingname|x
+  restdeliverypoint_name|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
 ---
@@ -18,11 +18,11 @@ description: |-
 A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-msg_vpn_name|x|||
-queue_binding_name|x|||
-rest_delivery_point_name|x|||
+Attribute|Identifying
+:---|:---:
+msg_vpn_name|x
+queue_binding_name|x
+rest_delivery_point_name|x
 
 
 
@@ -44,7 +44,6 @@ This has been available since SEMP API version 2.0.
 ### Read-Only
 
 - `gateway_replace_target_authority_enabled` (Boolean) Enable or disable whether the authority for the request-target is replaced with that configured for the REST Consumer remote. When enabled, the broker sends HTTP requests in absolute-form, with the request-target's authority taken from the REST Consumer's remote host and port configuration. When disabled, the broker sends HTTP requests whose request-target matches that of the original request message, including whether to use absolute-form or origin-form. This configuration is applicable only when the Message VPN is in REST gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.6.
-- `id` (String) Identifier attribute, for internal use only.
 - `post_request_target` (String) The request-target string to use when sending requests. It identifies the target resource on the far-end REST Consumer upon which to apply the request. There are generally two common forms for the request-target. The origin-form is most often used in practice and contains the path and query components of the target URI. If the path component is empty then the client must generally send a "/" as the path. When making a request to a proxy, most often the absolute-form is required. This configuration is only applicable when the Message VPN is in REST messaging mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
 - `request_target_evaluation` (String) The type of evaluation to perform on the request target. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are:
 
diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md
index f36db7f5..251ff1f2 100644
--- a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md
+++ b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md
@@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_protected_re
 subcategory: ""
 description: |-
   A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  headername|x|||
-  headervalue||x||x
-  msgvpnname|x|||
-  queuebindingname|x|||
-  restdeliverypoint_name|x|||
+  Attribute|Identifying|Write-Only|Opaque
+  :---|:---:|:---:|:---:
+  headername|x||
+  headervalue||x|x
+  msgvpnname|x||
+  queuebindingname|x||
+  restdeliverypoint_name|x||
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.30.
 ---
@@ -20,13 +20,13 @@ description: |-
 A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-header_name|x|||
-header_value||x||x
-msg_vpn_name|x|||
-queue_binding_name|x|||
-rest_delivery_point_name|x|||
+Attribute|Identifying|Write-Only|Opaque
+:---|:---:|:---:|:---:
+header_name|x||
+header_value||x|x
+msg_vpn_name|x||
+queue_binding_name|x||
+rest_delivery_point_name|x||
 
 
 
@@ -45,7 +45,3 @@ This has been available since SEMP API version 2.30.
 - `msg_vpn_name` (String) The name of the Message VPN.
 - `queue_binding_name` (String) The name of a queue in the Message VPN.
 - `rest_delivery_point_name` (String) The name of the REST Delivery Point.
-
-### Read-Only
-
-- `id` (String) Identifier attribute, for internal use only.
diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md
index f88e28ed..5109fef3 100644
--- a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md
+++ b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md
@@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_head
 subcategory: ""
 description: |-
   A request header to be added to the HTTP request.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  headername|x|||
-  msgvpnname|x|||
-  queuebindingname|x|||
-  restdeliverypointname|x|||
+  Attribute|Identifying
+  :---|:---:
+  headername|x
+  msgvpnname|x
+  queuebindingname|x
+  restdeliverypointname|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.23.
 ---
@@ -19,12 +19,12 @@ description: |-
 A request header to be added to the HTTP request.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-header_name|x|||
-msg_vpn_name|x|||
-queue_binding_name|x|||
-rest_delivery_point_name|x|||
+Attribute|Identifying
+:---|:---:
+header_name|x
+msg_vpn_name|x
+queue_binding_name|x
+rest_delivery_point_name|x
 
 
 
@@ -47,4 +47,3 @@ This has been available since SEMP API version 2.23.
 ### Read-Only
 
 - `header_value` (String) A substitution expression for the value of the HTTP request header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`.
-- `id` (String) Identifier attribute, for internal use only.
diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md
index 9b91f71e..996f3cca 100644
--- a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md
+++ b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md
@@ -4,18 +4,18 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer Data Source
 subcategory: ""
 description: |-
   REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authenticationawssecretaccesskey||x||x
-  authenticationclientcertcontent||x||x
-  authenticationclientcertpassword||x||
-  authenticationhttpbasicpassword||x||x
-  authenticationhttpheadervalue||x||x
-  authenticationoauthclientsecret||x||x
-  authenticationoauthjwtsecretkey||x||x
-  msgvpnname|x|||
-  restconsumername|x|||
-  restdeliverypointname|x|||
+  Attribute|Identifying|Write-Only|Opaque
+  :---|:---:|:---:|:---:
+  authenticationawssecretaccesskey||x|x
+  authenticationclientcertcontent||x|x
+  authenticationclientcertpassword||x|
+  authenticationhttpbasicpassword||x|x
+  authenticationhttpheadervalue||x|x
+  authenticationoauthclientsecret||x|x
+  authenticationoauthjwtsecretkey||x|x
+  msgvpnname|x||
+  restconsumername|x||
+  restdeliverypointname|x||
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
 ---
@@ -25,18 +25,18 @@ description: |-
 REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_aws_secret_access_key||x||x
-authentication_client_cert_content||x||x
-authentication_client_cert_password||x||
-authentication_http_basic_password||x||x
-authentication_http_header_value||x||x
-authentication_oauth_client_secret||x||x
-authentication_oauth_jwt_secret_key||x||x
-msg_vpn_name|x|||
-rest_consumer_name|x|||
-rest_delivery_point_name|x|||
+Attribute|Identifying|Write-Only|Opaque
+:---|:---:|:---:|:---:
+authentication_aws_secret_access_key||x|x
+authentication_client_cert_content||x|x
+authentication_client_cert_password||x|
+authentication_http_basic_password||x|x
+authentication_http_header_value||x|x
+authentication_oauth_client_secret||x|x
+authentication_oauth_jwt_secret_key||x|x
+msg_vpn_name|x||
+rest_consumer_name|x||
+rest_delivery_point_name|x||
 
 
 
@@ -88,7 +88,6 @@ This has been available since SEMP API version 2.0.
 "put" - Use the PUT HTTP method.
Available since SEMP API version 2.17. -- `id` (String) Identifier attribute, for internal use only. - `local_interface` (String) The interface that will be used for all outgoing connections associated with the REST Consumer. When unspecified, an interface is automatically chosen. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `max_post_wait_time` (Number) The maximum amount of time (in seconds) to wait for an HTTP POST response from the REST Consumer. Once this time is exceeded, the TCP connection is reset. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. - `outgoing_connection_count` (Number) The number of concurrent TCP connections open to the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md index 423e1fff..e22441a4 100644 --- a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md +++ b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_cl subcategory: "" description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - oauthjwtclaimname|x||| - restconsumername|x||| - restdeliverypointname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + oauthjwtclaimname|x + restconsumername|x + restdeliverypointname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.21. --- @@ -19,12 +19,12 @@ description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -oauth_jwt_claim_name|x||| -rest_consumer_name|x||| -rest_delivery_point_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +oauth_jwt_claim_name|x +rest_consumer_name|x +rest_delivery_point_name|x @@ -46,5 +46,4 @@ This has been available since SEMP API version 2.21. ### Read-Only -- `id` (String) Identifier attribute, for internal use only. - `oauth_jwt_claim_value` (String) The value of the additional claim, which must be a string containing a valid JSON value. diff --git a/docs/data-sources/msg_vpn_sequenced_topic.md b/docs/data-sources/msg_vpn_sequenced_topic.md index 9fe4a013..36ffac08 100644 --- a/docs/data-sources/msg_vpn_sequenced_topic.md +++ b/docs/data-sources/msg_vpn_sequenced_topic.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_sequenced_topic Data Source - solacebroker" subcategory: "" description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - sequenced_topic|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + sequenced_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,10 +17,10 @@ description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -sequenced_topic|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +sequenced_topic|x @@ -37,7 +37,3 @@ This has been available since SEMP API version 2.0. - `msg_vpn_name` (String) The name of the Message VPN. - `sequenced_topic` (String) Topic for applying sequence numbers. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_telemetry_profile.md b/docs/data-sources/msg_vpn_telemetry_profile.md index 7e8395fd..911ac2d3 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile.md +++ b/docs/data-sources/msg_vpn_telemetry_profile.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_telemetry_profile Data Source - solacebroker" subcategory: "" description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - telemetryprofilename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + telemetryprofilename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -17,10 +17,10 @@ description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -telemetry_profile_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +telemetry_profile_name|x @@ -40,7 +40,6 @@ This has been available since SEMP API version 2.31. ### Read-Only -- `id` (String) Identifier attribute, for internal use only. - `queue_event_bind_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--queue_event_bind_count_threshold)) - `queue_event_msg_spool_usage_threshold` (Attributes) (see [below for nested schema](#nestedatt--queue_event_msg_spool_usage_threshold)) - `queue_max_bind_count` (Number) The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. diff --git a/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md b/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md index ab31be79..dd62e691 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md +++ b/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_receiver_acl_connect_excepti subcategory: "" description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - receiveraclconnectexceptionaddress|x||| - telemetryprofilename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + receiveraclconnectexceptionaddress|x + telemetryprofilename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -18,11 +18,11 @@ description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -receiver_acl_connect_exception_address|x||| -telemetry_profile_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +receiver_acl_connect_exception_address|x +telemetry_profile_name|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.31. - `msg_vpn_name` (String) The name of the Message VPN. - `receiver_acl_connect_exception_address` (String) The IP address/netmask of the receiver connect exception in CIDR form. - `telemetry_profile_name` (String) The name of the Telemetry Profile. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md index 3e20c436..375ac31d 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md +++ b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter Data Source - s subcategory: "" description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - telemetryprofilename|x||| - tracefiltername|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + telemetryprofilename|x + tracefiltername|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -18,11 +18,11 @@ description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -telemetry_profile_name|x||| -trace_filter_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +telemetry_profile_name|x +trace_filter_name|x @@ -44,4 +44,3 @@ This has been available since SEMP API version 2.31. ### Read-Only - `enabled` (Boolean) Enable or disable the trace filter. When the filter is disabled, the filter's subscriptions will not trigger a message to be traced. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md index eae2675f..e5a6ef14 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md +++ b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md @@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter_subscription Da subcategory: "" description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - subscription|x||| - subscriptionsyntax|x||| - telemetryprofilename|x||| - tracefilter_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + subscription|x + subscriptionsyntax|x + telemetryprofilename|x + tracefilter_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -20,13 +20,13 @@ description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -subscription|x||| -subscription_syntax|x||| -telemetry_profile_name|x||| -trace_filter_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +subscription|x +subscription_syntax|x +telemetry_profile_name|x +trace_filter_name|x @@ -51,7 +51,3 @@ This has been available since SEMP API version 2.31. - `telemetry_profile_name` (String) The name of the Telemetry Profile. - `trace_filter_name` (String) A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug". - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/msg_vpn_topic_endpoint.md b/docs/data-sources/msg_vpn_topic_endpoint.md index 318ef0da..9f3467c4 100644 --- a/docs/data-sources/msg_vpn_topic_endpoint.md +++ b/docs/data-sources/msg_vpn_topic_endpoint.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_topic_endpoint Data Source - solacebroker" subcategory: "" description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - topicendpointname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + topicendpointname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -17,10 +17,10 @@ description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -topic_endpoint_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +topic_endpoint_name|x @@ -55,7 +55,6 @@ This has been available since SEMP API version 2.1. - `event_bind_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_bind_count_threshold)) - `event_reject_low_priority_msg_limit_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_reject_low_priority_msg_limit_threshold)) - `event_spool_usage_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_spool_usage_threshold)) -- `id` (String) Identifier attribute, for internal use only. - `ingress_enabled` (Boolean) Enable or disable the reception of messages to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `max_bind_count` (Number) The maximum number of consumer flows that can bind to the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. Available since SEMP API version 2.4. - `max_delivered_unacked_msgs_per_flow` (Number) The maximum number of messages delivered but not acknowledged per flow for the Topic Endpoint. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. diff --git a/docs/data-sources/msg_vpn_topic_endpoint_template.md b/docs/data-sources/msg_vpn_topic_endpoint_template.md index f3c64d60..ae752cfb 100644 --- a/docs/data-sources/msg_vpn_topic_endpoint_template.md +++ b/docs/data-sources/msg_vpn_topic_endpoint_template.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_topic_endpoint_template Data Source - solacebr subcategory: "" description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - topicendpointtemplate_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + topicendpointtemplate_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -17,10 +17,10 @@ description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -topic_endpoint_template_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +topic_endpoint_template_name|x @@ -52,7 +52,6 @@ This has been available since SEMP API version 2.14. - `event_bind_count_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_bind_count_threshold)) - `event_msg_spool_usage_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_msg_spool_usage_threshold)) - `event_reject_low_priority_msg_limit_threshold` (Attributes) (see [below for nested schema](#nestedatt--event_reject_low_priority_msg_limit_threshold)) -- `id` (String) Identifier attribute, for internal use only. - `max_bind_count` (Number) The maximum number of consumer flows that can bind. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. - `max_delivered_unacked_msgs_per_flow` (Number) The maximum number of messages delivered but not acknowledged per flow. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. - `max_msg_size` (Number) The maximum message size allowed, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000000`. diff --git a/docs/data-sources/oauth_profile.md b/docs/data-sources/oauth_profile.md index 66fa1c2e..dc7da4a4 100644 --- a/docs/data-sources/oauth_profile.md +++ b/docs/data-sources/oauth_profile.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile Data Source - solacebroker" subcategory: "" description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientsecret||x||x - oauthprofile_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + clientsecret||x|x + oauthprofile_name|x|| A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_secret||x||x -oauth_profile_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +client_secret||x|x +oauth_profile_name|x|| @@ -80,7 +80,6 @@ This has been available since SEMP API version 2.24. - `endpoint_token_timeout` (Number) The maximum time in seconds a token request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. - `endpoint_userinfo` (String) The OpenID Connect Userinfo endpoint. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `endpoint_userinfo_timeout` (Number) The maximum time in seconds a userinfo request is allowed to take. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`. -- `id` (String) Identifier attribute, for internal use only. - `interactive_enabled` (Boolean) Enable or disable interactive logins via this OAuth provider. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `interactive_prompt_for_expired_session` (String) The value of the prompt parameter provided to the OAuth authorization server for login requests where the session has expired. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `interactive_prompt_for_new_session` (String) The value of the prompt parameter provided to the OAuth authorization server for login requests where the session is new or the user has explicitly logged out. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"select_account"`. diff --git a/docs/data-sources/oauth_profile_access_level_group.md b/docs/data-sources/oauth_profile_access_level_group.md index 2d6622a3..6ee38ed8 100644 --- a/docs/data-sources/oauth_profile_access_level_group.md +++ b/docs/data-sources/oauth_profile_access_level_group.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_access_level_group Data Source - solaceb subcategory: "" description: |- The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - groupname|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + groupname|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- The name of a group as it exists on the OAuth server being used to authenticate SEMP users. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -group_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +group_name|x +oauth_profile_name|x @@ -49,7 +49,6 @@ This has been available since SEMP API version 2.24. "read-write" - User has read-write access to most global data. "admin" - User has read-write access to all global data. -- `id` (String) Identifier attribute, for internal use only. - `msg_vpn_access_level` (String) The default message VPN access level for this group. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: 
diff --git a/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md b/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md
index db5370b2..18d194d5 100644
--- a/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md
+++ b/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md
@@ -4,11 +4,11 @@ page_title: "solacebroker_oauth_profile_access_level_group_msg_vpn_access_level_
 subcategory: ""
 description: |-
   Message VPN access-level exceptions for members of this group.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  groupname|x|||
-  msgvpnname|x|||
-  oauthprofile_name|x|||
+  Attribute|Identifying
+  :---|:---:
+  groupname|x
+  msgvpnname|x
+  oauthprofile_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.24.
 ---
@@ -18,11 +18,11 @@ description: |-
 Message VPN access-level exceptions for members of this group.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-group_name|x|||
-msg_vpn_name|x|||
-oauth_profile_name|x|||
+Attribute|Identifying
+:---|:---:
+group_name|x
+msg_vpn_name|x
+oauth_profile_name|x
 
 
 
@@ -50,4 +50,3 @@ This has been available since SEMP API version 2.24.
 "read-only" - User has read-only access to a Message VPN.
 "read-write" - User has read-write access to most Message VPN settings.
-- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/oauth_profile_client_allowed_host.md b/docs/data-sources/oauth_profile_client_allowed_host.md index 44939ff2..a569a5dc 100644 --- a/docs/data-sources/oauth_profile_client_allowed_host.md +++ b/docs/data-sources/oauth_profile_client_allowed_host.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_client_allowed_host Data Source - solace subcategory: "" description: |- A valid hostname for this broker in OAuth redirects. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowedhost|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + allowedhost|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- A valid hostname for this broker in OAuth redirects. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -allowed_host|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +allowed_host|x +oauth_profile_name|x @@ -37,7 +37,3 @@ This has been available since SEMP API version 2.24. - `allowed_host` (String) An allowed value for the Host header. - `oauth_profile_name` (String) The name of the OAuth profile. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/oauth_profile_client_authorization_parameter.md b/docs/data-sources/oauth_profile_client_authorization_parameter.md index f08ccf30..0b5cb70a 100644 --- a/docs/data-sources/oauth_profile_client_authorization_parameter.md +++ b/docs/data-sources/oauth_profile_client_authorization_parameter.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_client_authorization_parameter Data Sour subcategory: "" description: |- Additional parameters to be passed to the OAuth authorization endpoint. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationparametername|x||| - oauthprofilename|x||| + Attribute|Identifying + :---|:---: + authorizationparametername|x + oauthprofilename|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Additional parameters to be passed to the OAuth authorization endpoint. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authorization_parameter_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +authorization_parameter_name|x +oauth_profile_name|x @@ -41,4 +41,3 @@ This has been available since SEMP API version 2.24. ### Read-Only - `authorization_parameter_value` (String) The authorization parameter value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/oauth_profile_client_required_claim.md b/docs/data-sources/oauth_profile_client_required_claim.md index 36a21d77..4d90174d 100644 --- a/docs/data-sources/oauth_profile_client_required_claim.md +++ b/docs/data-sources/oauth_profile_client_required_claim.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_client_required_claim Data Source - sola subcategory: "" description: |- Additional claims to be verified in the ID token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientrequiredclaimname|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + clientrequiredclaimname|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Additional claims to be verified in the ID token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_required_claim_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +client_required_claim_name|x +oauth_profile_name|x @@ -41,4 +41,3 @@ This has been available since SEMP API version 2.24. ### Read-Only - `client_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md b/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md index 0d1f43ec..e684f979 100644 --- a/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md +++ b/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_default_msg_vpn_access_level_exception D subcategory: "" description: |- Default message VPN access-level exceptions. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - oauthprofilename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + oauthprofilename|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Default message VPN access-level exceptions. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +oauth_profile_name|x @@ -47,4 +47,3 @@ This has been available since SEMP API version 2.24. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/data-sources/oauth_profile_resource_server_required_claim.md b/docs/data-sources/oauth_profile_resource_server_required_claim.md index 0a60bc79..61bab38f 100644 --- a/docs/data-sources/oauth_profile_resource_server_required_claim.md +++ b/docs/data-sources/oauth_profile_resource_server_required_claim.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_resource_server_required_claim Data Sour subcategory: "" description: |- Additional claims to be verified in the access token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - oauthprofilename|x||| - resourceserverrequiredclaimname|x||| + Attribute|Identifying + :---|:---: + oauthprofilename|x + resourceserverrequiredclaimname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Additional claims to be verified in the access token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -oauth_profile_name|x||| -resource_server_required_claim_name|x||| +Attribute|Identifying +:---|:---: +oauth_profile_name|x +resource_server_required_claim_name|x @@ -40,5 +40,4 @@ This has been available since SEMP API version 2.24. ### Read-Only -- `id` (String) Identifier attribute, for internal use only. - `resource_server_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. diff --git a/docs/data-sources/virtual_hostname.md b/docs/data-sources/virtual_hostname.md index 522d039e..380c6ba2 100644 --- a/docs/data-sources/virtual_hostname.md +++ b/docs/data-sources/virtual_hostname.md @@ -6,9 +6,9 @@ description: |- A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - virtual_hostname|x||| + Attribute|Identifying + :---|:---: + virtual_hostname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.17. --- @@ -22,9 +22,9 @@ Clients which connect to a global (as opposed to per Message VPN) port and provi This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -virtual_hostname|x||| +Attribute|Identifying +:---|:---: +virtual_hostname|x @@ -44,5 +44,4 @@ This has been available since SEMP API version 2.17. ### Read-Only - `enabled` (Boolean) Enable or disable Virtual Hostname to Message VPN mapping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. -- `id` (String) Identifier attribute, for internal use only. - `msg_vpn_name` (String) The message VPN to which this virtual hostname is mapped. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. diff --git a/docs/guides/config-generator.md b/docs/guides/config-generator.md index 7dec49be..ad37052a 100644 --- a/docs/guides/config-generator.md +++ b/docs/guides/config-generator.md @@ -16,18 +16,20 @@ You can run the provider binary directly with the `generate` command to generate - `` is the broker provider binary. - `` is the broker address, for example `https://mybroker.example.org:1943/`. -- `` are the similar to the Terraform Import command. This is the resource name and possible values to find a specific resource. +- `` is similar to the Terraform Import command. This is the resource name and possible values to find a specific resource. - `` is the desirable name of the generated filename. - There are also supported options, which mirror the configuration options for the provider object. These can be found [here](#supported-options). +This generator supports configuring software event brokers and will fail if applied against an appliance. This check may be overridden by setting the `SOLACEBROKER_SKIP_API_CHECK=true` environment variable. + ## Important notes -The generated configuration shoud be reviewed for followings: +You should review the generated configuration for the following: -* Provider configuration values (url, username, etc.) may need to be updated. -* Write-only attributes, such as passwords, are omitted from the config as they cannot be read from the broker configuration. They need to be added manually. -* Default resources may be present that may be omitted. -* The generator uses a naming scheme for the resources. This may be updated by manually replacing the generated names. +* You may need to update provider configuration values (URL, username, etc.) +* Write-only attributes, such as passwords, are omitted from the config as they cannot be read from the broker configuration. You need to add them manually. +* Default resources may be present that you can omit. +* The generator uses a naming scheme for the resources. You can update this by manually replacing the generated names. ## Usage @@ -43,9 +45,8 @@ help Help about any command version Provides version information about the current binary ``` -To `generate` the configuration, make sure all ENVIRONMENT VARIABLES, which mirrors the configuration options for the -provider object are set. The list of variables -are listed [here](#supported-options). +To `generate` the configuration, make sure all ENVIRONMENT VARIABLES, which mirror the configuration options for the +provider object are set. You can find the list of variables [here](#supported-options). For example: `SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=admin terraform-provider-solacebroker generate --url=https://localhost:8080 solacebroker_msg_vpn.mq default my-messagevpn.tf` @@ -63,22 +64,23 @@ Message VPN, `default`, assuming a msg_vpn_queue resource called `test` exists f ### Supported Options -The following parameters can be set as ENVIRONMENT VARIABLES. When used as environment variables -each parameter must be preceded with _SOLACEBROKER__. For example for a PubSub+ broker using username and password +The following parameters can be set as ENVIRONMENT VARIABLES. When used as an environment variable, +each parameter must be preceded with _SOLACEBROKER__. An example for a PubSub+ broker using username and password _**admin/password**_ would be: `SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=password` -- `bearer_token`, (String, Sensitive, Mandatory if `password` will not be provided) -- `insecure_skip_verify` (Boolean) Disable validation of server SSL certificates, accept/ignore self-signed. -- `password` (String, Sensitive, Mandatory is `bearer_token` will not be provided) -- `request_min_interval` (String) -- `request_timeout_duration` (String) -- `retries` (Number) -- `retry_max_interval` (String) -- `retry_min_interval` (String) -- `username` (String, Mandatory) The username for the broker request. +- `SOLACEBROKER_BEARER_TOKEN` (String, Sensitive, Mandatory if `password` not provided) +- `SOLACEBROKER_INSECURE_SKIP_VERIFY` (Boolean) Disable validation of server SSL certificates, accept/ignore self-signed. +- `SOLACEBROKER_PASSWORD` (String, Sensitive, Mandatory if `bearer_token` not provided) +- `SOLACEBROKER_REQUEST_MIN_INTERVAL` (String) +- `SOLACEBROKER_REQUEST_TIMEOUT_DURATION` (String) +- `SOLACEBROKER_RETRIES` (Number) +- `SOLACEBROKER_RETRY_MAX_INTERVAL` (String) +- `SOLACEBROKER_RETRY_MIN_INTERVAL` (String) +- `SOLACEBROKER_SKIP_API_CHECK` (String) Disable validation of the broker SEMP API for supported platform and minimum version. +- `SOLACEBROKER_USERNAME` (String, Mandatory) The username for the broker request. ## Troubleshooting @@ -86,8 +88,8 @@ The following issues may arise while using the generator. | Error | SEMP call failed. unexpected status 401 (401 Unauthorized) | |-----------------|----------------------------------------------------------------------------| -| Explanation | Configurations to connect to the PubSub+ Broker not accurate. | -| Possible Action | Check and confirm, configuration details to PubSub+ Broker are accurate. | +| Explanation | Configurations to connect to the PubSub+ broker not accurate. | +| Possible Action | Check and confirm, configuration details to PubSub+ broker are accurate. | | Error | SOLACEBROKER_xxx is mandatory but not available | |-----------------|------------------------------------------------------------------------------------| @@ -108,3 +110,8 @@ The following issues may arise while using the generator. |-----------------|------------------------------------------------------------------------------------------------------------| | Explanation | This indicates the resource by name _xxx_ is not recognized by the generator. | | Possible Action | Ensure the resource name used is available as a Terraform resource for the version of the provider in use. | + +| Error | Error: Broker check failed | +|-----------------|-------------------------------------------------------------------------------------------------------------| +| Explanation | This indicates that broker platform does not match provider supported platform | +| Possible Action | Ensure that an appliance provider is used against a software broker platform and not an appliance platform. | diff --git a/docs/guides/provider.md b/docs/guides/provider.md index 49d6411b..a86fe4e0 100644 --- a/docs/guides/provider.md +++ b/docs/guides/provider.md @@ -6,7 +6,9 @@ page_title: "Solacebroker Provider Guide" The `solacebroker` provider supports Terraform CLI operations including basic CRUD (create, read, update, and delete) and import. -The provider leverages the [SEMP (Solace Element Management Protocol)](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) REST API to configure the PubSub+ event broker. The API reference is available from the [Solace PubSub+ Documentation](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.html). +The provider leverages the [SEMP (Solace Element Management Protocol)](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) REST API to configure the PubSub+ event broker. The API reference is available from the [Solace PubSub+ documentation](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/appliance/config/index.html). + +This provider supports configuring software event brokers and will fail if applied against an appliance. This check may be overridden by specifying the `skip_api_check = true` configuration argument. ## Mapping of SEMP API and Provider Names @@ -34,7 +36,7 @@ A given version of the provider is built to support a specific version of the SE ## Object Relationships -Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "Identifying" attributes that give a hint to required already configured objects. +Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "Identifying" attributes that give a hint to required pre-existing objects. For example: ```terraform @@ -70,9 +72,7 @@ Some attributes don't have a default value. In this case their value will be det ## Importing Resources -When [importing resources to Terraform](https://developer.hashicorp.com/terraform/language/import#syntax) an `id` is required. Note that this `id` is not the same as the internal `id` attribute of resources. - -The `id` to be used shall be constructed as a path from the highest parent object down to the resource. +When [importing resources to Terraform](https://developer.hashicorp.com/terraform/language/import#syntax) an `id` is required. This `id` shall be constructed as a path from the highest parent object down to the resource. For example, when importing a `solacebroker_msg_vpn_queue_subscription`, the parent relationship is `msg_vpn` > `msg_vpn_queue` > `msg_vpn_queue_subscription`. To construct the `id`, concatenate the identifications of parents and the particular resource identification, separated by `/` (slash). Also note that elements containing `/` must be URL-encoded. diff --git a/docs/index.md b/docs/index.md index c505f290..6d1d4f5f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -65,7 +65,7 @@ resource "solacebroker_msg_vpn_queue" "q" { ### Required -- `url` (String) The base URL of the event broker, for example `https://mybroker.example.org:1943/`. The trailing / can be omitted. +- `url` (String) The base URL of the event broker, for example `https://mybroker.example.org:/`. The trailing / can be omitted. ### Optional @@ -77,11 +77,12 @@ resource "solacebroker_msg_vpn_queue" "q" { - `retries` (Number) The number of retries for a SEMP call. The default value is 10. - `retry_max_interval` (String) A [duration](https://pkg.go.dev/maze.io/x/duration#ParseDuration) string indicating the maximum retry interval. The default value is 30s. - `retry_min_interval` (String) A [duration](https://pkg.go.dev/maze.io/x/duration#ParseDuration) string indicating how long to wait after an initial failed request before the first retry. Exponential backoff is used, up to the limit set by retry_max_interval. The default value is 3s. +- `skip_api_check` (Boolean) Disable validation of the broker SEMP API for supported platform and minimum version. The default value is false. - `username` (String) The username to connect to the broker with. Requires password and conflicts with bearer_token. --> All provider configuration values can also be set as environment variables with the same name but uppercase and with the `SOLACEBROKER_` prefix. +-> All provider configuration values can also be set as environment variables with the same name, but uppercase and with the `SOLACEBROKER_` prefix. For example, the password attribute can be set via the `SOLACEBROKER_PASSWORD` environment variable. Values in the configuration take precedence over environment variables. # Release Notes and History -For detailed Release Notes and release history, refer to the Releases section in the [Provider GitHub repository](https://github.com/SolaceProducts/terraform-provider-solacebroker/releases). +For detailed release notes and release history, refer to the Releases section in the [Provider GitHub repository](https://github.com/SolaceProducts/terraform-provider-solacebrokerappliance/releases). diff --git a/docs/resources/broker.md b/docs/resources/broker.md index 48e562e3..ad096931 100644 --- a/docs/resources/broker.md +++ b/docs/resources/broker.md @@ -4,11 +4,11 @@ page_title: "solacebroker_broker Resource - solacebroker" subcategory: "" description: |- This object contains global configuration for the message broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - tlsservercertcontent||x||x - tlsservercertpassword||x|| - A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. Requests which include the following attributes require greater access scope/level: + Attribute|Write-Only|Opaque + :---|:---:|:---: + tlsservercertcontent|x|x + tlsservercertpassword|x| + A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than "vpn/read-only": Attribute|Access Scope/Level :---|:---: authclientcertrevocationcheckmode|global/read-only @@ -128,12 +128,7 @@ description: |- tlsciphersuitesecureshelllist|global/read-only tlscrimeexploitprotectionenabled|global/read-only tlsservercertcontent|global/read-only - tlsstandarddomaincertificateauthoritiesenabled|vpn/read-only - tlsticketlifetime|global/read-only - webmanagerallowunencryptedwizardsenabled|vpn/read-only - webmanagercustomization|vpn/read-only - webmanagerredirecthttpenabled|vpn/read-only - webmanagerredirecthttpoverridetls_port|vpn/read-only + tlsticket_lifetime|global/read-only This has been available since SEMP API version 2.13. --- @@ -142,14 +137,14 @@ description: |- This object contains global configuration for the message broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -tls_server_cert_content||x||x -tls_server_cert_password||x|| +Attribute|Write-Only|Opaque +:---|:---:|:---: +tls_server_cert_content|x|x +tls_server_cert_password|x| -A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. Requests which include the following attributes require greater access scope/level: +A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than "vpn/read-only": Attribute|Access Scope/Level @@ -271,12 +266,7 @@ tls_cipher_suite_msg_backbone_list|global/read-only tls_cipher_suite_secure_shell_list|global/read-only tls_crime_exploit_protection_enabled|global/read-only tls_server_cert_content|global/read-only -tls_standard_domain_certificate_authorities_enabled|vpn/read-only tls_ticket_lifetime|global/read-only -web_manager_allow_unencrypted_wizards_enabled|vpn/read-only -web_manager_customization|vpn/read-only -web_manager_redirect_http_enabled|vpn/read-only -web_manager_redirect_http_override_tls_port|vpn/read-only @@ -387,10 +377,6 @@ This has been available since SEMP API version 2.13. - `web_manager_redirect_http_enabled` (Boolean) Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since SEMP API version 2.24. - `web_manager_redirect_http_override_tls_port` (Number) The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since SEMP API version 2.24. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `guaranteed_msging_event_cache_usage_threshold` diff --git a/docs/resources/client_cert_authority.md b/docs/resources/client_cert_authority.md index 783f44a9..d4c33282 100644 --- a/docs/resources/client_cert_authority.md +++ b/docs/resources/client_cert_authority.md @@ -4,9 +4,9 @@ page_title: "solacebroker_client_cert_authority Resource - solacebroker" subcategory: "" description: |- Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certauthorityname|x||| + Attribute|Identifying + :---|:---: + certauthorityname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.19. --- @@ -16,9 +16,9 @@ description: |- Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cert_authority_name|x||| +Attribute|Identifying +:---|:---: +cert_authority_name|x @@ -45,7 +45,3 @@ This has been available since SEMP API version 2.19. - `ocsp_override_url` (String) The OCSP responder URL to use for overriding the one supplied in the client certificate. The URL must be complete with http:// included. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `ocsp_timeout` (Number) The timeout in seconds to receive a response from the OCSP responder after sending a request or making the initial connection attempt. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. - `revocation_check_enabled` (Boolean) Enable or disable Certificate Authority revocation checking. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md b/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md index d07819eb..54bc6dc6 100644 --- a/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md +++ b/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md @@ -4,10 +4,10 @@ page_title: "solacebroker_client_cert_authority_ocsp_tls_trusted_common_name Res subcategory: "" description: |- When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certauthorityname|x||| - ocsptlstrustedcommonname|x||| + Attribute|Identifying + :---|:---: + certauthorityname|x + ocsptlstrustedcommonname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.19. --- @@ -17,10 +17,10 @@ description: |- When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cert_authority_name|x||| -ocsp_tls_trusted_common_name|x||| +Attribute|Identifying +:---|:---: +cert_authority_name|x +ocsp_tls_trusted_common_name|x @@ -37,7 +37,3 @@ This has been available since SEMP API version 2.19. - `cert_authority_name` (String) The name of the Certificate Authority. - `ocsp_tls_trusted_common_name` (String) The expected Trusted Common Name of the OCSP responder remote certificate. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/dmr_cluster.md b/docs/resources/dmr_cluster.md index 3e589fb0..e8f18369 100644 --- a/docs/resources/dmr_cluster.md +++ b/docs/resources/dmr_cluster.md @@ -61,7 +61,3 @@ This has been available since SEMP API version 2.11. - `tls_server_cert_max_chain_depth` (Number) The maximum allowed depth of a certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. - `tls_server_cert_validate_date_enabled` (Boolean) Enable or disable the validation of the "Not Before" and "Not After" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `tls_server_cert_validate_name_enabled` (Boolean) Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote broker. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since SEMP API version 2.18. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/dmr_cluster_cert_matching_rule.md b/docs/resources/dmr_cluster_cert_matching_rule.md index a0bb05e6..9e0b74b8 100644 --- a/docs/resources/dmr_cluster_cert_matching_rule.md +++ b/docs/resources/dmr_cluster_cert_matching_rule.md @@ -4,10 +4,10 @@ page_title: "solacebroker_dmr_cluster_cert_matching_rule Resource - solacebroker subcategory: "" description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrclustername|x||| - rule_name|x||| + Attribute|Identifying + :---|:---: + dmrclustername|x + rule_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -17,10 +17,10 @@ description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -dmr_cluster_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +dmr_cluster_name|x +rule_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.28. ### Optional - `enabled` (Boolean) Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md b/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md index c14a5b74..38142c9c 100644 --- a/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md +++ b/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md @@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_cert_matching_rule_attribute_filter Resour subcategory: "" description: |- A Cert Matching Rule Attribute Filter compares a link attribute to a string. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrclustername|x||| - filtername|x||| - rulename|x||| + Attribute|Identifying + :---|:---: + dmrclustername|x + filtername|x + rulename|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Attribute Filter compares a link attribute to a string. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -dmr_cluster_name|x||| -filter_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +dmr_cluster_name|x +filter_name|x +rule_name|x @@ -45,7 +45,3 @@ This has been available since SEMP API version 2.28. - `attribute_name` (String) Link Attribute to be tested. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `attribute_value` (String) Expected attribute value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/dmr_cluster_cert_matching_rule_condition.md b/docs/resources/dmr_cluster_cert_matching_rule_condition.md index cfc9d42b..4cf6d8df 100644 --- a/docs/resources/dmr_cluster_cert_matching_rule_condition.md +++ b/docs/resources/dmr_cluster_cert_matching_rule_condition.md @@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_cert_matching_rule_condition Resource - so subcategory: "" description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrclustername|x||| - rule_name|x||| - source|x||| + Attribute|Identifying + :---|:---: + dmrclustername|x + rule_name|x + source|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -dmr_cluster_name|x||| -rule_name|x||| -source|x||| +Attribute|Identifying +:---|:---: +dmr_cluster_name|x +rule_name|x +source|x @@ -61,7 +61,3 @@ This has been available since SEMP API version 2.28. - `attribute` (String) Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`. - `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/dmr_cluster_link.md b/docs/resources/dmr_cluster_link.md index edb341e4..e3e286f1 100644 --- a/docs/resources/dmr_cluster_link.md +++ b/docs/resources/dmr_cluster_link.md @@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_link Resource - solacebroker" subcategory: "" description: |- A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationbasicpassword||x||x - dmrclustername|x||| - remotenodename|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + authenticationbasicpassword||x|x + dmrclustername|x|| + remotenodename|x|| A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -18,11 +18,11 @@ description: |- A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authentication_basic_password||x||x -dmr_cluster_name|x||| -remote_node_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +authentication_basic_password||x|x +dmr_cluster_name|x|| +remote_node_name|x|| @@ -58,7 +58,7 @@ This has been available since SEMP API version 2.11. - `client_profile_queue_direct3_max_depth` (Number) The maximum depth of the "Direct 3" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. - `client_profile_queue_direct3_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the `client_profile_queue_direct3_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `4`. - `client_profile_queue_guaranteed1_max_depth` (Number) The maximum depth of the "Guaranteed 1" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `20000`. -- `client_profile_queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-3) priority queue, regardless of the `client_profile_queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. +- `client_profile_queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-1) priority queue, regardless of the `client_profile_queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`. - `client_profile_tcp_congestion_window_size` (Number) The TCP initial congestion window size, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `2`. - `client_profile_tcp_keepalive_count` (Number) The number of TCP keepalive retransmissions to be carried out before declaring that the remote end is not available. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5`. - `client_profile_tcp_keepalive_idle_time` (Number) The amount of time a connection must remain idle before TCP begins sending keepalive probes, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. @@ -97,10 +97,6 @@ This has been available since SEMP API version 2.11. - `transport_compressed_enabled` (Boolean) Enable or disable compression on the Link. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) on the Link. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `queue_event_spool_usage_threshold` diff --git a/docs/resources/dmr_cluster_link_attribute.md b/docs/resources/dmr_cluster_link_attribute.md index db0dac31..3c905d80 100644 --- a/docs/resources/dmr_cluster_link_attribute.md +++ b/docs/resources/dmr_cluster_link_attribute.md @@ -4,12 +4,12 @@ page_title: "solacebroker_dmr_cluster_link_attribute Resource - solacebroker" subcategory: "" description: |- A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - attributename|x||| - attributevalue|x||| - dmrclustername|x||| - remotenodename|x||| + Attribute|Identifying + :---|:---: + attributename|x + attributevalue|x + dmrclustername|x + remotenodename|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -19,12 +19,12 @@ description: |- A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -attribute_name|x||| -attribute_value|x||| -dmr_cluster_name|x||| -remote_node_name|x||| +Attribute|Identifying +:---|:---: +attribute_name|x +attribute_value|x +dmr_cluster_name|x +remote_node_name|x @@ -43,7 +43,3 @@ This has been available since SEMP API version 2.28. - `attribute_value` (String) The value of the Attribute. - `dmr_cluster_name` (String) The name of the Cluster. - `remote_node_name` (String) The name of the node at the remote end of the Link. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/dmr_cluster_link_remote_address.md b/docs/resources/dmr_cluster_link_remote_address.md index 350b48b3..76c3cd9c 100644 --- a/docs/resources/dmr_cluster_link_remote_address.md +++ b/docs/resources/dmr_cluster_link_remote_address.md @@ -4,11 +4,11 @@ page_title: "solacebroker_dmr_cluster_link_remote_address Resource - solacebroke subcategory: "" description: |- Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - dmrclustername|x||| - remoteaddress|x||| - remotenode_name|x||| + Attribute|Identifying + :---|:---: + dmrclustername|x + remoteaddress|x + remotenode_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -18,11 +18,11 @@ description: |- Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -dmr_cluster_name|x||| -remote_address|x||| -remote_node_name|x||| +Attribute|Identifying +:---|:---: +dmr_cluster_name|x +remote_address|x +remote_node_name|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.11. - `dmr_cluster_name` (String) The name of the Cluster. - `remote_address` (String) The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed). - `remote_node_name` (String) The name of the node at the remote end of the Link. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/domain_cert_authority.md b/docs/resources/domain_cert_authority.md index 6e9c3fd6..56d4a8a8 100644 --- a/docs/resources/domain_cert_authority.md +++ b/docs/resources/domain_cert_authority.md @@ -4,9 +4,9 @@ page_title: "solacebroker_domain_cert_authority Resource - solacebroker" subcategory: "" description: |- Certificate Authorities trusted for domain verification. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - certauthorityname|x||| + Attribute|Identifying + :---|:---: + certauthorityname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.19. --- @@ -16,9 +16,9 @@ description: |- Certificate Authorities trusted for domain verification. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cert_authority_name|x||| +Attribute|Identifying +:---|:---: +cert_authority_name|x @@ -38,7 +38,3 @@ This has been available since SEMP API version 2.19. ### Optional - `cert_content` (String) The PEM formatted content for the trusted root certificate of a domain Certificate Authority. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn.md b/docs/resources/msg_vpn.md index cb9b9a77..b6cba4e4 100644 --- a/docs/resources/msg_vpn.md +++ b/docs/resources/msg_vpn.md @@ -55,7 +55,9 @@ This has been available since SEMP API version 2.0. - `alias` (String) The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN. -Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.14. +Aliases may form a non-circular chain, cascading one to the next. + +Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.14. - `authentication_basic_enabled` (Boolean) Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `authentication_basic_profile_name` (String) The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`. - `authentication_basic_radius_domain` (String) The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. @@ -145,6 +147,7 @@ Aliases may form a non-circular chain, cascading one to the next. Changes to thi - `max_egress_flow_count` (Number) The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - `max_endpoint_count` (Number) The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - `max_ingress_flow_count` (Number) The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. +- `max_kafka_broker_connection_count` (Number) The maximum number of simultaneous Kafka broker connections of the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since SEMP API version 2.39. - `max_msg_spool_usage` (Number) The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - `max_subscription_count` (Number) The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - `max_transacted_session_count` (Number) The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. @@ -227,7 +230,7 @@ Aliases may form a non-circular chain, cascading one to the next. Changes to thi "when-enabled-in-message-vpn" - Only ask for a client-certificate if client certificate authentication is enabled under "message-vpn > authentication > client-certificate > shutdown". Available since SEMP API version 2.21. -- `service_rest_incoming_authorization_header_handling` (String) The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"drop"`. The allowed values and their meaning are: +- `service_rest_incoming_authorization_header_handling` (String) The handling of Authorization headers for incoming REST connections. Authorization header handling settings apply only when the Message VPN is in gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"drop"`. The allowed values and their meaning are: 
 "drop" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.
@@ -264,10 +267,6 @@ Aliases may form a non-circular chain, cascading one to the next. Changes to thi
 - `service_web_tls_enabled` (Boolean) Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.
 - `tls_allow_downgrade_to_plain_text_enabled` (Boolean) Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.
 
-### Read-Only
-
-- `id` (String) Identifier attribute, for internal use only.
-
 
 ### Nested Schema for `event_connection_count_threshold`
 
diff --git a/docs/resources/msg_vpn_acl_profile.md b/docs/resources/msg_vpn_acl_profile.md
index 34c24798..7a4c2847 100644
--- a/docs/resources/msg_vpn_acl_profile.md
+++ b/docs/resources/msg_vpn_acl_profile.md
@@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_acl_profile Resource - solacebroker"
 subcategory: ""
 description: |-
   An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  aclprofilename|x|||
-  msgvpnname|x|||
+  Attribute|Identifying
+  :---|:---:
+  aclprofilename|x
+  msgvpnname|x
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
 ---
@@ -17,10 +17,10 @@ description: |-
 An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-acl_profile_name|x|||
-msg_vpn_name|x|||
+Attribute|Identifying
+:---|:---:
+acl_profile_name|x
+msg_vpn_name|x
 
 
 
@@ -65,7 +65,3 @@ This has been available since SEMP API version 2.0.
 "allow" - Allow topic unless an exception is found for it.
 "disallow" - Disallow topic unless an exception is found for it.
- -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_acl_profile_client_connect_exception.md b/docs/resources/msg_vpn_acl_profile_client_connect_exception.md index 6efe6b7b..41ea8d78 100644 --- a/docs/resources/msg_vpn_acl_profile_client_connect_exception.md +++ b/docs/resources/msg_vpn_acl_profile_client_connect_exception.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_acl_profile_client_connect_exception Resource subcategory: "" description: |- A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclprofilename|x||| - clientconnectexceptionaddress|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + aclprofilename|x + clientconnectexceptionaddress|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,11 +18,11 @@ description: |- A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -acl_profile_name|x||| -client_connect_exception_address|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +acl_profile_name|x +client_connect_exception_address|x +msg_vpn_name|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.0. - `acl_profile_name` (String) The name of the ACL Profile. - `client_connect_exception_address` (String) The IP address/netmask of the client connect exception in canonical CIDR form. - `msg_vpn_name` (String) The name of the Message VPN. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md b/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md index a42ed163..4e1746f5 100644 --- a/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md +++ b/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_acl_profile_publish_topic_exception Resource - subcategory: "" description: |- A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclprofilename|x||| - msgvpnname|x||| - publishtopicexception|x||| - publishtopicexception_syntax|x||| + Attribute|Identifying + :---|:---: + aclprofilename|x + msgvpnname|x + publishtopicexception|x + publishtopicexception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,12 +19,12 @@ description: |- A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -acl_profile_name|x||| -msg_vpn_name|x||| -publish_topic_exception|x||| -publish_topic_exception_syntax|x||| +Attribute|Identifying +:---|:---: +acl_profile_name|x +msg_vpn_name|x +publish_topic_exception|x +publish_topic_exception_syntax|x @@ -48,7 +48,3 @@ This has been available since SEMP API version 2.14. "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md b/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md index 66a60cd5..bfc84eae 100644 --- a/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md +++ b/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_share_name_exception Res subcategory: "" description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclprofilename|x||| - msgvpnname|x||| - subscribesharenameexception|x||| - subscribesharenameexception_syntax|x||| + Attribute|Identifying + :---|:---: + aclprofilename|x + msgvpnname|x + subscribesharenameexception|x + subscribesharenameexception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,12 +19,12 @@ description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -acl_profile_name|x||| -msg_vpn_name|x||| -subscribe_share_name_exception|x||| -subscribe_share_name_exception_syntax|x||| +Attribute|Identifying +:---|:---: +acl_profile_name|x +msg_vpn_name|x +subscribe_share_name_exception|x +subscribe_share_name_exception_syntax|x @@ -48,7 +48,3 @@ This has been available since SEMP API version 2.14. "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md b/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md index bdd850de..7ef12bfe 100644 --- a/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md +++ b/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_topic_exception Resource subcategory: "" description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - aclprofilename|x||| - msgvpnname|x||| - subscribetopicexception|x||| - subscribetopicexception_syntax|x||| + Attribute|Identifying + :---|:---: + aclprofilename|x + msgvpnname|x + subscribetopicexception|x + subscribetopicexception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,12 +19,12 @@ description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -acl_profile_name|x||| -msg_vpn_name|x||| -subscribe_topic_exception|x||| -subscribe_topic_exception_syntax|x||| +Attribute|Identifying +:---|:---: +acl_profile_name|x +msg_vpn_name|x +subscribe_topic_exception|x +subscribe_topic_exception_syntax|x @@ -48,7 +48,3 @@ This has been available since SEMP API version 2.14. "smf" - Topic uses SMF syntax. "mqtt" - Topic uses MQTT syntax. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_authentication_oauth_profile.md b/docs/resources/msg_vpn_authentication_oauth_profile.md index f216c54b..a414b742 100644 --- a/docs/resources/msg_vpn_authentication_oauth_profile.md +++ b/docs/resources/msg_vpn_authentication_oauth_profile.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile Resource - solace subcategory: "" description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientsecret||x||x - msgvpnname|x||| - oauthprofile_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + clientsecret||x|x + msgvpnname|x|| + oauthprofile_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,11 +18,11 @@ description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_secret||x||x -msg_vpn_name|x||| -oauth_profile_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +client_secret||x|x +msg_vpn_name|x|| +oauth_profile_name|x|| @@ -82,7 +82,3 @@ This has been available since SEMP API version 2.25. - `resource_server_validate_scope_enabled` (Boolean) Enable or disable verification of the scope claim in the access token or introspection response. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `resource_server_validate_type_enabled` (Boolean) Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `username_claim_name` (String) The name of the username claim. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sub"`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_authentication_oauth_profile_client_required_claim.md b/docs/resources/msg_vpn_authentication_oauth_profile_client_required_claim.md index 7d0e9eee..40943cdb 100644 --- a/docs/resources/msg_vpn_authentication_oauth_profile_client_required_claim.md +++ b/docs/resources/msg_vpn_authentication_oauth_profile_client_required_claim.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_client_required_c subcategory: "" description: |- Additional claims to be verified in the ID token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientrequiredclaimname|x||| - msgvpnname|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + clientrequiredclaimname|x + msgvpnname|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,11 +18,11 @@ description: |- Additional claims to be verified in the ID token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_required_claim_name|x||| -msg_vpn_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +client_required_claim_name|x +msg_vpn_name|x +oauth_profile_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.25. - `client_required_claim_value` (String) The required claim value. - `msg_vpn_name` (String) The name of the Message VPN. - `oauth_profile_name` (String) The name of the OAuth profile. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md b/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md index 5f5b2082..cc2a7fe6 100644 --- a/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md +++ b/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_resource_server_r subcategory: "" description: |- Additional claims to be verified in the access token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - oauthprofilename|x||| - resourceserverrequiredclaimname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + oauthprofilename|x + resourceserverrequiredclaimname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,11 +18,11 @@ description: |- Additional claims to be verified in the access token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -oauth_profile_name|x||| -resource_server_required_claim_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +oauth_profile_name|x +resource_server_required_claim_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.25. - `oauth_profile_name` (String) The name of the OAuth profile. - `resource_server_required_claim_name` (String) The name of the access token claim to verify. - `resource_server_required_claim_value` (String) The required claim value. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_authorization_group.md b/docs/resources/msg_vpn_authorization_group.md index 36ab7576..9cd2e06d 100644 --- a/docs/resources/msg_vpn_authorization_group.md +++ b/docs/resources/msg_vpn_authorization_group.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_authorization_group Resource - solacebroker" subcategory: "" description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationgroupname|x||| - msgvpnname|x||| - orderafterauthorizationgroupname||x|| - orderbeforeauthorizationgroupname||x|| + Attribute|Identifying|Write-Only + :---|:---:|:---: + authorizationgroupname|x| + msgvpnname|x| + orderafterauthorizationgroupname||x + orderbeforeauthorizationgroupname||x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -19,12 +19,12 @@ description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authorization_group_name|x||| -msg_vpn_name|x||| -order_after_authorization_group_name||x|| -order_before_authorization_group_name||x|| +Attribute|Identifying|Write-Only +:---|:---:|:---: +authorization_group_name|x| +msg_vpn_name|x| +order_after_authorization_group_name||x +order_before_authorization_group_name||x @@ -49,7 +49,3 @@ This has been available since SEMP API version 2.0. - `enabled` (Boolean) Enable or disable the Authorization Group in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `order_after_authorization_group_name` (String, Sensitive) Lower the priority to be less than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable. - `order_before_authorization_group_name` (String, Sensitive) Raise the priority to be greater than this group. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_bridge.md b/docs/resources/msg_vpn_bridge.md index e95a7482..e97e2880 100644 --- a/docs/resources/msg_vpn_bridge.md +++ b/docs/resources/msg_vpn_bridge.md @@ -4,14 +4,14 @@ page_title: "solacebroker_msg_vpn_bridge Resource - solacebroker" subcategory: "" description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgename|x||| - bridgevirtualrouter|x||| - msgvpnname|x||| - remoteauthenticationbasicpassword||x||x - remoteauthenticationclientcertcontent||x||x - remoteauthenticationclientcertpassword||x|| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + bridgename|x|| + bridgevirtualrouter|x|| + msgvpnname|x|| + remoteauthenticationbasicpassword||x|x + remoteauthenticationclientcertcontent||x|x + remoteauthenticationclientcertpassword||x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -21,14 +21,14 @@ description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -bridge_name|x||| -bridge_virtual_router|x||| -msg_vpn_name|x||| -remote_authentication_basic_password||x||x -remote_authentication_client_cert_content||x||x -remote_authentication_client_cert_password||x|| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +bridge_name|x|| +bridge_virtual_router|x|| +msg_vpn_name|x|| +remote_authentication_basic_password||x|x +remote_authentication_client_cert_content||x|x +remote_authentication_client_cert_password||x| @@ -79,7 +79,3 @@ This has been available since SEMP API version 2.0. "da" - Ignore priority and deliver always. - `tls_cipher_suite_list` (String) The colon-separated list of cipher suites supported for TLS connections to the remote Message VPN. The value "default" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_bridge_remote_msg_vpn.md b/docs/resources/msg_vpn_bridge_remote_msg_vpn.md index b4e013a1..0be0cff2 100644 --- a/docs/resources/msg_vpn_bridge_remote_msg_vpn.md +++ b/docs/resources/msg_vpn_bridge_remote_msg_vpn.md @@ -4,15 +4,15 @@ page_title: "solacebroker_msg_vpn_bridge_remote_msg_vpn Resource - solacebroker" subcategory: "" description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgename|x||| - bridgevirtualrouter|x||| - msgvpnname|x||| - password||x||x - remotemsgvpninterface|x||| - remotemsgvpnlocation|x||| - remotemsgvpnname|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + bridgename|x|| + bridgevirtualrouter|x|| + msgvpnname|x|| + password||x|x + remotemsgvpninterface|x|| + remotemsgvpnlocation|x|| + remotemsgvpnname|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -22,15 +22,15 @@ description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -bridge_name|x||| -bridge_virtual_router|x||| -msg_vpn_name|x||| -password||x||x -remote_msg_vpn_interface|x||| -remote_msg_vpn_location|x||| -remote_msg_vpn_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +bridge_name|x|| +bridge_virtual_router|x|| +msg_vpn_name|x|| +password||x|x +remote_msg_vpn_interface|x|| +remote_msg_vpn_location|x|| +remote_msg_vpn_name|x|| @@ -69,7 +69,3 @@ This has been available since SEMP API version 2.0. - `queue_binding` (String) The queue binding of the Bridge in the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `tls_enabled` (Boolean) Enable or disable encryption (TLS) for the remote Message VPN connection. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `unidirectional_client_profile` (String) The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2 MB. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"#client-profile"`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_bridge_remote_subscription.md b/docs/resources/msg_vpn_bridge_remote_subscription.md index 65d3eb22..da2ec98d 100644 --- a/docs/resources/msg_vpn_bridge_remote_subscription.md +++ b/docs/resources/msg_vpn_bridge_remote_subscription.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_bridge_remote_subscription Resource - solacebr subcategory: "" description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - bridgename|x||| - bridgevirtualrouter|x||| - msgvpnname|x||| - remotesubscription_topic|x||| + Attribute|Identifying + :---|:---: + bridgename|x + bridgevirtualrouter|x + msgvpnname|x + remotesubscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -19,12 +19,12 @@ description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -bridge_name|x||| -bridge_virtual_router|x||| -msg_vpn_name|x||| -remote_subscription_topic|x||| +Attribute|Identifying +:---|:---: +bridge_name|x +bridge_virtual_router|x +msg_vpn_name|x +remote_subscription_topic|x @@ -50,7 +50,3 @@ This has been available since SEMP API version 2.0. - `deliver_always_enabled` (Boolean) Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both. - `msg_vpn_name` (String) The name of the Message VPN. - `remote_subscription_topic` (String) The topic of the Bridge remote subscription. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_cert_matching_rule.md b/docs/resources/msg_vpn_cert_matching_rule.md index f2f2a90f..3fe3f33b 100644 --- a/docs/resources/msg_vpn_cert_matching_rule.md +++ b/docs/resources/msg_vpn_cert_matching_rule.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule Resource - solacebroker" subcategory: "" description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - rule_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + rule_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -17,10 +17,10 @@ description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +rule_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.27. ### Optional - `enabled` (Boolean) Enable or disable a certificate matching rule. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md b/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md index 4eca2fcb..2ae71646 100644 --- a/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md +++ b/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_attribute_filter Resource - subcategory: "" description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - filtername|x||| - msgvpnname|x||| - rulename|x||| + Attribute|Identifying + :---|:---: + filtername|x + msgvpnname|x + rulename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -filter_name|x||| -msg_vpn_name|x||| -rule_name|x||| +Attribute|Identifying +:---|:---: +filter_name|x +msg_vpn_name|x +rule_name|x @@ -45,7 +45,3 @@ This has been available since SEMP API version 2.28. - `attribute_name` (String) Client Username Attribute to be tested. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `attribute_value` (String) Expected attribute value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_cert_matching_rule_condition.md b/docs/resources/msg_vpn_cert_matching_rule_condition.md index 5b22018d..497e3634 100644 --- a/docs/resources/msg_vpn_cert_matching_rule_condition.md +++ b/docs/resources/msg_vpn_cert_matching_rule_condition.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_condition Resource - solace subcategory: "" description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - rule_name|x||| - source|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + rule_name|x + source|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -18,11 +18,11 @@ description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -rule_name|x||| -source|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +rule_name|x +source|x @@ -61,7 +61,3 @@ This has been available since SEMP API version 2.27. - `attribute` (String) Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`. - `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_client_profile.md b/docs/resources/msg_vpn_client_profile.md index 797c6ccc..f530aa0d 100644 --- a/docs/resources/msg_vpn_client_profile.md +++ b/docs/resources/msg_vpn_client_profile.md @@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_client_profile Resource - solacebroker" subcategory: "" description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowcutthroughforwardingenabled|||x| - apiqueuemanagementcopyfromoncreatename|||x| - apitopicendpointmanagementcopyfromoncreatename|||x| - clientprofilename|x||| - msgvpn_name|x||| + Attribute|Identifying|Deprecated + :---|:---:|:---: + allowcutthroughforwardingenabled||x + apiqueuemanagementcopyfromoncreatename||x + apitopicendpointmanagementcopyfromoncreatename||x + clientprofilename|x| + msgvpn_name|x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -20,13 +20,13 @@ description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -allow_cut_through_forwarding_enabled|||x| -api_queue_management_copy_from_on_create_name|||x| -api_topic_endpoint_management_copy_from_on_create_name|||x| -client_profile_name|x||| -msg_vpn_name|x||| +Attribute|Identifying|Deprecated +:---|:---:|:---: +allow_cut_through_forwarding_enabled||x +api_queue_management_copy_from_on_create_name||x +api_topic_endpoint_management_copy_from_on_create_name||x +client_profile_name|x| +msg_vpn_name|x| @@ -93,7 +93,7 @@ This has been available since SEMP API version 2.0. - `queue_direct3_max_depth` (Number) The maximum depth of the "Direct 3" (D-3) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. - `queue_direct3_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Direct 3" (D-3) priority queue, regardless of the `queue_direct3_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `4`. - `queue_guaranteed1_max_depth` (Number) The maximum depth of the "Guaranteed 1" (G-1) priority queue, in work units. Each work unit is 2048 bytes of message data. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20000`. -- `queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-3) priority queue, regardless of the `queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. +- `queue_guaranteed1_min_msg_burst` (Number) The number of messages that are always allowed entry into the "Guaranteed 1" (G-1) priority queue, regardless of the `queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`. - `reject_msg_to_sender_on_no_subscription_match_enabled` (Boolean) Enable or disable the sending of a negative acknowledgment (NACK) to a client using the Client Profile when discarding a guaranteed message due to no matching subscription found. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.2. - `replication_allow_client_connect_when_standby_enabled` (Boolean) Enable or disable allowing clients using the Client Profile to connect to the Message VPN when its replication state is standby. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `service_min_keepalive_timeout` (Number) The minimum client keepalive timeout which will be enforced for client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30`. Available since SEMP API version 2.19. @@ -110,10 +110,6 @@ This has been available since SEMP API version 2.0. - `tcp_max_window_size` (Number) The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. This setting is ignored on the software broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `256`. - `tls_allow_downgrade_to_plain_text_enabled` (Boolean) Enable or disable allowing a client using the Client Profile to downgrade an encrypted connection to plain text. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since SEMP API version 2.8. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `event_client_provisioned_endpoint_spool_usage_threshold` diff --git a/docs/resources/msg_vpn_client_username.md b/docs/resources/msg_vpn_client_username.md index bc858bef..5c70d1c5 100644 --- a/docs/resources/msg_vpn_client_username.md +++ b/docs/resources/msg_vpn_client_username.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_client_username Resource - solacebroker" subcategory: "" description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientusername|x||| - msgvpn_name|x||| - password||x||x + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + clientusername|x|| + msgvpn_name|x|| + password||x|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,11 +18,11 @@ description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_username|x||| -msg_vpn_name|x||| -password||x||x +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +client_username|x|| +msg_vpn_name|x|| +password||x|x @@ -48,7 +48,3 @@ This has been available since SEMP API version 2.0. - `guaranteed_endpoint_permission_override_enabled` (Boolean) Enable or disable guaranteed endpoint permission override for the Client Username. When enabled all guaranteed endpoints may be accessed, modified or deleted with the same permission as the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `password` (String, Sensitive) The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `subscription_manager_enabled` (Boolean) Enable or disable the subscription management capability of the Client Username. This is the ability to manage subscriptions on behalf of other Client Usernames. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_client_username_attribute.md b/docs/resources/msg_vpn_client_username_attribute.md index 5d4987ba..e4240bf3 100644 --- a/docs/resources/msg_vpn_client_username_attribute.md +++ b/docs/resources/msg_vpn_client_username_attribute.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_client_username_attribute Resource - solacebro subcategory: "" description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - attributename|x||| - attributevalue|x||| - clientusername|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + attributename|x + attributevalue|x + clientusername|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -19,12 +19,12 @@ description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -attribute_name|x||| -attribute_value|x||| -client_username|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +attribute_name|x +attribute_value|x +client_username|x +msg_vpn_name|x @@ -43,7 +43,3 @@ This has been available since SEMP API version 2.27. - `attribute_value` (String) The value of the Attribute. - `client_username` (String) The name of the Client Username. - `msg_vpn_name` (String) The name of the Message VPN. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_distributed_cache.md b/docs/resources/msg_vpn_distributed_cache.md index 01d87e8c..3c75743c 100644 --- a/docs/resources/msg_vpn_distributed_cache.md +++ b/docs/resources/msg_vpn_distributed_cache.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_distributed_cache Resource - solacebroker" subcategory: "" description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + cachename|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,10 +17,10 @@ description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +msg_vpn_name|x @@ -50,7 +50,3 @@ This has been available since SEMP API version 2.11. - `heartbeat` (Number) The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`. - `scheduled_delete_msg_day_list` (String) The scheduled delete message day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduled_delete_msg_time_list" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `scheduled_delete_msg_time_list` (String) The scheduled delete message time(s), specified as "hourly" or a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduled_delete_msg_day_list" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster.md b/docs/resources/msg_vpn_distributed_cache_cluster.md index 236ecc08..356c7547 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster Resource - solacebro subcategory: "" description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - msgvpnname|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -18,11 +18,11 @@ description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +msg_vpn_name|x @@ -62,10 +62,6 @@ This has been available since SEMP API version 2.11. - `msg_lifetime` (Number) The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the Cache Instance will remove the message. A lifetime of 0 results in the message being retained indefinitely. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - `new_topic_advertisement_enabled` (Boolean) Enable or disable the advertising, onto the message bus, of new topics learned by each Cache Instance in the Cache Cluster. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `event_data_byte_rate_threshold` diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md index a98c7b9e..54bdc4ac 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - homeclustername|x||| - msgvpnname|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + homeclustername|x + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,12 +19,12 @@ description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -home_cluster_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +home_cluster_name|x +msg_vpn_name|x @@ -43,7 +43,3 @@ This has been available since SEMP API version 2.11. - `cluster_name` (String) The name of the Cache Cluster. - `home_cluster_name` (String) The name of the remote Home Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md index 7658e2e4..1f4d5a0a 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md @@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - homeclustername|x||| - msgvpnname|x||| - topic_prefix|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + homeclustername|x + msgvpnname|x + topic_prefix|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -20,13 +20,13 @@ description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -home_cluster_name|x||| -msg_vpn_name|x||| -topic_prefix|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +home_cluster_name|x +msg_vpn_name|x +topic_prefix|x @@ -46,7 +46,3 @@ This has been available since SEMP API version 2.11. - `home_cluster_name` (String) The name of the remote Home Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. - `topic_prefix` (String) A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_instance.md b/docs/resources/msg_vpn_distributed_cache_cluster_instance.md index 0229a0a0..d47d1a8e 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_instance.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_instance.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_instance Resource - subcategory: "" description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - instancename|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + instancename|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,12 +19,12 @@ description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -instance_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +instance_name|x +msg_vpn_name|x @@ -49,7 +49,3 @@ This has been available since SEMP API version 2.11. - `auto_start_enabled` (Boolean) Enable or disable auto-start for the Cache Instance. When enabled, the Cache Instance will automatically attempt to transition from the Stopped operational state to Up whenever it restarts or reconnects to the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `enabled` (Boolean) Enable or disable the Cache Instance. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `stop_on_lost_msg_enabled` (Boolean) Enable or disable stop-on-lost-message for the Cache Instance. When enabled, the Cache Instance will transition to the stopped operational state upon losing a message. When stopped, it cannot accept or respond to cache requests, but continues to cache messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_topic.md b/docs/resources/msg_vpn_distributed_cache_cluster_topic.md index 6113181d..6b4581d6 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_topic.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_topic.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_topic Resource - sol subcategory: "" description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - clustername|x||| - msgvpnname|x||| - topic|x||| + Attribute|Identifying + :---|:---: + cachename|x + clustername|x + msgvpnname|x + topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,12 +19,12 @@ description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -cluster_name|x||| -msg_vpn_name|x||| -topic|x||| +Attribute|Identifying +:---|:---: +cache_name|x +cluster_name|x +msg_vpn_name|x +topic|x @@ -43,7 +43,3 @@ This has been available since SEMP API version 2.11. - `cluster_name` (String) The name of the Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. - `topic` (String) The value of the Topic in the form a/b/c. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_dmr_bridge.md b/docs/resources/msg_vpn_dmr_bridge.md index 57a7017d..9b271e7e 100644 --- a/docs/resources/msg_vpn_dmr_bridge.md +++ b/docs/resources/msg_vpn_dmr_bridge.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_dmr_bridge Resource - solacebroker" subcategory: "" description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - remotenodename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + remotenodename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,10 +17,10 @@ description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -remote_node_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +remote_node_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.11. ### Optional - `remote_msg_vpn_name` (String) The remote Message VPN of the DMR Bridge. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_jndi_connection_factory.md b/docs/resources/msg_vpn_jndi_connection_factory.md index 7d1feb7f..b0821974 100644 --- a/docs/resources/msg_vpn_jndi_connection_factory.md +++ b/docs/resources/msg_vpn_jndi_connection_factory.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_jndi_connection_factory Resource - solacebroke subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - connectionfactoryname|x||| - msgvpnname|x||| + Attribute|Identifying + :---|:---: + connectionfactoryname|x + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -17,10 +17,10 @@ description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -connection_factory_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +connection_factory_name|x +msg_vpn_name|x @@ -84,7 +84,3 @@ This has been available since SEMP API version 2.2. - `transport_send_buffer_size` (Number) The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `65536`. - `transport_tcp_no_delay_enabled` (Boolean) Enable or disable the TCP_NODELAY option. When enabled, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `xa_enabled` (Boolean) Enable or disable this as an XA Connection Factory. When enabled, the Connection Factory can be cast to "XAConnectionFactory", "XAQueueConnectionFactory" or "XATopicConnectionFactory". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_jndi_queue.md b/docs/resources/msg_vpn_jndi_queue.md index 6e951326..bc5036e4 100644 --- a/docs/resources/msg_vpn_jndi_queue.md +++ b/docs/resources/msg_vpn_jndi_queue.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_jndi_queue Resource - solacebroker" subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queue_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -17,10 +17,10 @@ description: |- The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.2. ### Optional - `physical_name` (String) The physical name of the JMS Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_jndi_topic.md b/docs/resources/msg_vpn_jndi_topic.md index 12923215..f3ceca79 100644 --- a/docs/resources/msg_vpn_jndi_topic.md +++ b/docs/resources/msg_vpn_jndi_topic.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_jndi_topic Resource - solacebroker" subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - topic_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + topic_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -17,10 +17,10 @@ description: |- The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -topic_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +topic_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.2. ### Optional - `physical_name` (String) The physical name of the JMS Topic. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_kafka_receiver.md b/docs/resources/msg_vpn_kafka_receiver.md index 5c9bfbb8..8b7c51db 100644 --- a/docs/resources/msg_vpn_kafka_receiver.md +++ b/docs/resources/msg_vpn_kafka_receiver.md @@ -4,16 +4,15 @@ page_title: "solacebroker_msg_vpn_kafka_receiver Resource - solacebroker" subcategory: "" description: |- A Kafka Receiver receives messages from a Kafka Cluster. - WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationbasicpassword||x||x - authenticationclientcertcontent||x||x - authenticationclientcertpassword||x|| - authenticationoauthclientsecret||x||x - authenticationscrampassword||x||x - kafkareceivername|x||| - msgvpn_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + authenticationbasicpassword||x|x + authenticationclientcertcontent||x|x + authenticationclientcertpassword||x| + authenticationoauthclientsecret||x|x + authenticationscrampassword||x|x + kafkareceivername|x|| + msgvpn_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -22,18 +21,16 @@ description: |- A Kafka Receiver receives messages from a Kafka Cluster. -WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades. - -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authentication_basic_password||x||x -authentication_client_cert_content||x||x -authentication_client_cert_password||x|| -authentication_oauth_client_secret||x||x -authentication_scram_password||x||x -kafka_receiver_name|x||| -msg_vpn_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +authentication_basic_password||x|x +authentication_client_cert_content||x|x +authentication_client_cert_password||x| +authentication_oauth_client_secret||x|x +authentication_scram_password||x|x +kafka_receiver_name|x|| +msg_vpn_name|x|| @@ -53,49 +50,77 @@ This has been available since SEMP API version 2.36. ### Optional -- `authentication_basic_password` (String, Sensitive) The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_basic_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. -- `authentication_client_cert_password` (String, Sensitive) The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. -- `authentication_oauth_client_id` (String) The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_oauth_client_scope` (String) The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_oauth_client_secret` (String, Sensitive) The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with "https". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_scheme` (String) The authentication scheme for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are: +- `authentication_basic_password` (String, Sensitive) The password for the Username. To be used when authentication_scheme is "basic". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_basic_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authentication_scheme is "basic". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. To be used when authentication_scheme is "client-certificate". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. +- `authentication_client_cert_password` (String, Sensitive) The password for the client certificate. To be used when authentication_scheme is "client-certificate". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. +- `authentication_oauth_client_id` (String) The OAuth client ID. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_oauth_client_scope` (String) The OAuth scope. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_oauth_client_secret` (String, Sensitive) The OAuth client secret. To be used when authentication_scheme is "oauth-client". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with "https". To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_scheme` (String) The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are: 
-"none" - Anonymous Authentication.
-"basic" - Basic Authentication.
-"scram" - Salted Challenge Response Authentication.
-"client-certificate" - Client Certificate Authentication.
-"oauth-client" - Oauth Authentication.
+"none" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.
+"basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.
+"oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.
-- `authentication_scram_hash` (String) The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: +- `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: 
 "sha-256" - SHA-2 256 bits.
 "sha-512" - SHA-2 512 bits.
-- `authentication_scram_password` (String, Sensitive) The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_scram_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`. -- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. -- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_scram_password` (String, Sensitive) The password for the Username. To be used when authentication_scheme is "scram". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_scram_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis. + +This corresponds to the Kafka consumer API `fetch.max.wait.ms` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`. +- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis. + +This corresponds to the Kafka consumer API `fetch.min.bytes` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`. +- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. + +This corresponds to the Kafka consumer API `bootstrap.servers` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `enabled` (Boolean) Enable or disable the Kafka Receiver. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `group_id` (String) The id of the Kafka consumer group for the Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `group_keepalive_interval` (Number) The time between sending keepalives to the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. -- `group_keepalive_timeout` (Number) The time until unresponsive group members are removed, triggering a partition rebalance across other members of the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`. -- `group_membership_type` (String) The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within group_keepalive_timeout) without prompting a group rebalance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"dynamic"`. The allowed values and their meaning are: +- `group_id` (String) The id of the Kafka consumer group for the Receiver. + +This corresponds to the Kafka consumer API `group.id` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `group_keepalive_interval` (Number) The time (in ms) between sending keepalives to the group. + +This corresponds to the Kafka consumer API `heartbeat.interval.ms` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`. +- `group_keepalive_timeout` (Number) The time (in ms) until unresponsive group members are removed, triggering a partition rebalance across other members of the group. + +This corresponds to the Kafka consumer API `session.timeout.ms` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`. +- `group_membership_type` (String) The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within group_keepalive_timeout) without prompting a group rebalance. + +This corresponds to the Kafka consumer API `group.instance.id` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"dynamic"`. The allowed values and their meaning are: 
 "dynamic" - Dynamic Membership.
 "static" - Static Membership.
-- `group_partition_scheme_list` (String) The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager ("range", "roundrobin") and Cooperative ("cooperative-sticky") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"range,roundrobin"`. -- `metadata_topic_exclude_list` (String) A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `metadata_topic_refresh_interval` (Number) The time between refreshes of topic metadata from the Kafka Cluster. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`. -- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `group_partition_scheme_list` (String) The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager ("range", "roundrobin") and Cooperative ("cooperative-sticky") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation. -### Read-Only +This corresponds to the Kafka consumer API `partition.assignment.strategy` configuration setting. -- `id` (String) Identifier attribute, for internal use only. +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"range,roundrobin"`. +- `metadata_topic_exclude_list` (String) A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `metadata_topic_refresh_interval` (Number) The time between refreshes of topic metadata from the Kafka Cluster. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`. +- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Receiver. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. diff --git a/docs/resources/msg_vpn_kafka_receiver_topic_binding.md b/docs/resources/msg_vpn_kafka_receiver_topic_binding.md index f5e7dd1b..a64887ff 100644 --- a/docs/resources/msg_vpn_kafka_receiver_topic_binding.md +++ b/docs/resources/msg_vpn_kafka_receiver_topic_binding.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_kafka_receiver_topic_binding Resource - solace subcategory: "" description: |- A Topic Binding receives messages from a remote Kafka Topic. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - kafkareceivername|x||| - msgvpnname|x||| - topic_name|x||| + Attribute|Identifying + :---|:---: + kafkareceivername|x + msgvpnname|x + topic_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -18,11 +18,11 @@ description: |- A Topic Binding receives messages from a remote Kafka Topic. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -kafka_receiver_name|x||| -msg_vpn_name|x||| -topic_name|x||| +Attribute|Identifying +:---|:---: +kafka_receiver_name|x +msg_vpn_name|x +topic_name|x @@ -44,7 +44,11 @@ This has been available since SEMP API version 2.36. ### Optional - `enabled` (Boolean) Enable or disable this topic binding of the Kafka Receiver. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `initial_offset` (String) The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"end"`. The allowed values and their meaning are: +- `initial_offset` (String) The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition. + +This corresponds to the Kafka consumer API `auto.offset.reset` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"end"`. The allowed values and their meaning are: 
 "beginning" - Start with the earliest offset available.
@@ -52,11 +56,11 @@ This has been available since SEMP API version 2.36.
- `local_key` (String) The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic. -If empty, no key is included for each message as it is published into Solace. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `local_topic` (String) The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic. +If empty, no key is included for each message as it is published into Solace. -If empty, the Topic Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `local_topic` (String) The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic. -### Read-Only +If empty, the Topic Binding will not be operational. -- `id` (String) Identifier attribute, for internal use only. +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. diff --git a/docs/resources/msg_vpn_kafka_sender.md b/docs/resources/msg_vpn_kafka_sender.md index 8240d05e..b1274788 100644 --- a/docs/resources/msg_vpn_kafka_sender.md +++ b/docs/resources/msg_vpn_kafka_sender.md @@ -4,16 +4,15 @@ page_title: "solacebroker_msg_vpn_kafka_sender Resource - solacebroker" subcategory: "" description: |- A Kafka Sender sends messages to a Kafka Cluster. - WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationbasicpassword||x||x - authenticationclientcertcontent||x||x - authenticationclientcertpassword||x|| - authenticationoauthclientsecret||x||x - authenticationscrampassword||x||x - kafkasendername|x||| - msgvpn_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + authenticationbasicpassword||x|x + authenticationclientcertcontent||x|x + authenticationclientcertpassword||x| + authenticationoauthclientsecret||x|x + authenticationscrampassword||x|x + kafkasendername|x|| + msgvpn_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -22,18 +21,16 @@ description: |- A Kafka Sender sends messages to a Kafka Cluster. -WARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades. - -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authentication_basic_password||x||x -authentication_client_cert_content||x||x -authentication_client_cert_password||x|| -authentication_oauth_client_secret||x||x -authentication_scram_password||x||x -kafka_sender_name|x||| -msg_vpn_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +authentication_basic_password||x|x +authentication_client_cert_content||x|x +authentication_client_cert_password||x| +authentication_oauth_client_secret||x|x +authentication_scram_password||x|x +kafka_sender_name|x|| +msg_vpn_name|x|| @@ -53,40 +50,64 @@ This has been available since SEMP API version 2.36. ### Optional -- `authentication_basic_password` (String, Sensitive) The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_basic_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. -- `authentication_client_cert_password` (String, Sensitive) The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. -- `authentication_oauth_client_id` (String) The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_oauth_client_scope` (String) The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_oauth_client_secret` (String, Sensitive) The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with "https". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_scheme` (String) The authentication scheme for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are: +- `authentication_basic_password` (String, Sensitive) The password for the Username. To be used when authentication_scheme is "basic". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_basic_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authentication_scheme is "basic". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. To be used when authentication_scheme is "client-certificate". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. +- `authentication_client_cert_password` (String, Sensitive) The password for the client certificate. To be used when authentication_scheme is "client-certificate". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of "requested" or "required" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `""`. +- `authentication_oauth_client_id` (String) The OAuth client ID. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_oauth_client_scope` (String) The OAuth scope. To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_oauth_client_secret` (String, Sensitive) The OAuth client secret. To be used when authentication_scheme is "oauth-client". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with "https". To be used when authentication_scheme is "oauth-client". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_scheme` (String) The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"none"`. The allowed values and their meaning are: 
-"none" - Anonymous Authentication.
-"basic" - Basic Authentication.
-"scram" - Salted Challenge Response Authentication.
-"client-certificate" - Client Certificate Authentication.
-"oauth-client" - Oauth Authentication.
+"none" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.
+"basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.
+"client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.
+"oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.
-- `authentication_scram_hash` (String) The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: +- `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: 
 "sha-256" - SHA-2 256 bits.
 "sha-512" - SHA-2 512 bits.
-- `authentication_scram_password` (String, Sensitive) The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `authentication_scram_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`. +- `authentication_scram_password` (String, Sensitive) The password for the Username. To be used when authentication_scheme is "scram". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `authentication_scram_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `batch_delay` (Number) Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis. + +This corresponds to the Kafka producer API `linger.ms` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`. - `batch_max_msg_count` (Number) Maximum number of messages sent in a single batch. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`. -- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`. -- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `batch_max_size` (Number) Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis. + +This corresponds to the Kafka producer API `batch.size` configuration setting, and should not exceed either the Kafka broker `message.max.bytes` configuration setting, or the per-Topic override of `max.message.bytes`. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`. +- `bootstrap_address_list` (String) Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. + +This corresponds to the Kafka producer API `bootstrap.servers` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `enabled` (Boolean) Enable or disable the Kafka Sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `idempotence_enabled` (Boolean) Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `idempotence_enabled` (Boolean) Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. When idempotence is enabled the Queue Bindings of the Kafka Sender must have ack_mode of "all" to be operational. + +This corresponds to the Kafka producer API `enable.idempotence` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `transport_compression_enabled` (Boolean) Enable or disable compression for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `transport_compression_level` (Number) Compression level. The valid range is dependent on the compression type. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. -- `transport_compression_type` (String) Compression type. Only relevant if compression is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"gzip"`. The allowed values and their meaning are: +- `transport_compression_level` (Number) Compression level. The valid range is dependent on the compression type. + +This corresponds to the Kafka producer API `compression.level` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. +- `transport_compression_type` (String) Compression type. Only relevant if compression is enabled. + +This corresponds to the Kafka producer API `compression.type` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"gzip"`. The allowed values and their meaning are: 
 "gzip" - GZIP Compression.
@@ -94,8 +115,4 @@ This has been available since SEMP API version 2.36.
 "lz4" - LZ4 Compression.
 "zstd" - Zstandard Compression.
-- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. +- `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Sender. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. diff --git a/docs/resources/msg_vpn_kafka_sender_queue_binding.md b/docs/resources/msg_vpn_kafka_sender_queue_binding.md index 0fb1c34f..1dde1dd5 100644 --- a/docs/resources/msg_vpn_kafka_sender_queue_binding.md +++ b/docs/resources/msg_vpn_kafka_sender_queue_binding.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_kafka_sender_queue_binding Resource - solacebr subcategory: "" description: |- A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - kafkasendername|x||| - msgvpnname|x||| - queue_name|x||| + Attribute|Identifying + :---|:---: + kafkasendername|x + msgvpnname|x + queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -18,11 +18,11 @@ description: |- A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -kafka_sender_name|x||| -msg_vpn_name|x||| -queue_name|x||| +Attribute|Identifying +:---|:---: +kafka_sender_name|x +msg_vpn_name|x +queue_name|x @@ -43,7 +43,11 @@ This has been available since SEMP API version 2.36. ### Optional -- `ack_mode` (String) The number of acks required from the remote Kafka broker. When "none" messages are delivered at-most-once. When "one" or "all" messages are delivered at-least-once but may be reordered. This is overridden to "all" for an idempotent Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"all"`. The allowed values and their meaning are: +- `ack_mode` (String) The number of acks required from the remote Kafka broker. When "none" messages are delivered at-most-once. When "one" or "all" messages are delivered at-least-once but may be reordered. This must be configured as "all" for an idempotent Kafka Sender, otherwise the Queue Binding will be operationally down. + +This corresponds to the Kafka producer API `acks` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"all"`. The allowed values and their meaning are: 
 "none" - No Acks.
@@ -60,7 +64,11 @@ This has been available since SEMP API version 2.36.
- `partition_explicit_number` (Number) The partition number to use for explicit partition selection. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - `partition_random_fallback_enabled` (Boolean) Enable or disable fallback to the random partition selection scheme when the consistent partition scheme is being used but no partition key is available for the message. When enabled a random partition will be selected for each unkeyed messages, otherwise some partition will be selected for groups of unkeyed messages. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. -- `partition_scheme` (String) The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"consistent"`. The allowed values and their meaning are: +- `partition_scheme` (String) The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to. + +This corresponds to the Kafka producer API `partitioner.class` configuration setting. + +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"consistent"`. The allowed values and their meaning are: 
 "consistent" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number.
@@ -69,11 +77,11 @@ This has been available since SEMP API version 2.36.
- `remote_key` (String) The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue. -If empty, no key is included for each message as it is published into Kafka. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -- `remote_topic` (String) The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to. +If empty, no key is included for each message as it is published into Kafka. -If empty, the Queue Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `remote_topic` (String) The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to. -### Read-Only +If empty, the Queue Binding will not be operational. -- `id` (String) Identifier attribute, for internal use only. +Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. diff --git a/docs/resources/msg_vpn_mqtt_retain_cache.md b/docs/resources/msg_vpn_mqtt_retain_cache.md index c3c389a3..3b5b5142 100644 --- a/docs/resources/msg_vpn_mqtt_retain_cache.md +++ b/docs/resources/msg_vpn_mqtt_retain_cache.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_mqtt_retain_cache Resource - solacebroker" subcategory: "" description: |- Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - cachename|x||| - msgvpn_name|x||| + Attribute|Identifying + :---|:---: + cachename|x + msgvpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,10 +17,10 @@ description: |- Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -cache_name|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +cache_name|x +msg_vpn_name|x @@ -42,7 +42,3 @@ This has been available since SEMP API version 2.11. - `enabled` (Boolean) Enable or disable this MQTT Retain Cache. When the cache is disabled, neither retain messages nor retain requests will be delivered by the cache. However, live retain messages will continue to be delivered to currently connected MQTT clients. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `msg_lifetime` (Number) The message lifetime, in seconds. If a message remains cached for the duration of its lifetime, the cache will remove the message. A lifetime of 0 results in the message being retained indefinitely, otherwise it must be 3 seconds or more. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_mqtt_session.md b/docs/resources/msg_vpn_mqtt_session.md index c9b404ee..18e282b7 100644 --- a/docs/resources/msg_vpn_mqtt_session.md +++ b/docs/resources/msg_vpn_mqtt_session.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_mqtt_session Resource - solacebroker" subcategory: "" description: |- An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - mqttsessionclientid|x||| - mqttsessionvirtualrouter|x||| - msgvpnname|x||| + Attribute|Identifying + :---|:---: + mqttsessionclientid|x + mqttsessionvirtualrouter|x + msgvpnname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -18,11 +18,11 @@ description: |- An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -mqtt_session_client_id|x||| -mqtt_session_virtual_router|x||| -msg_vpn_name|x||| +Attribute|Identifying +:---|:---: +mqtt_session_client_id|x +mqtt_session_virtual_router|x +msg_vpn_name|x @@ -74,10 +74,6 @@ This has been available since SEMP API version 2.1. Available since SEMP API version 2.14. - `queue_respect_ttl_enabled` (Boolean) Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.14. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `queue_event_bind_count_threshold` diff --git a/docs/resources/msg_vpn_mqtt_session_subscription.md b/docs/resources/msg_vpn_mqtt_session_subscription.md index bfb4c374..eb4fa662 100644 --- a/docs/resources/msg_vpn_mqtt_session_subscription.md +++ b/docs/resources/msg_vpn_mqtt_session_subscription.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_mqtt_session_subscription Resource - solacebro subcategory: "" description: |- An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - mqttsessionclientid|x||| - mqttsessionvirtualrouter|x||| - msgvpnname|x||| - subscription_topic|x||| + Attribute|Identifying + :---|:---: + mqttsessionclientid|x + mqttsessionvirtualrouter|x + msgvpnname|x + subscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -19,12 +19,12 @@ description: |- An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -mqtt_session_client_id|x||| -mqtt_session_virtual_router|x||| -msg_vpn_name|x||| -subscription_topic|x||| +Attribute|Identifying +:---|:---: +mqtt_session_client_id|x +mqtt_session_virtual_router|x +msg_vpn_name|x +subscription_topic|x @@ -53,7 +53,3 @@ This has been available since SEMP API version 2.1. ### Optional - `subscription_qos` (Number) The quality of service (QoS) for the subscription as either 0 (deliver at most once) or 1 (deliver at least once). QoS 2 is not supported, but QoS 2 messages attracted by QoS 0 or QoS 1 subscriptions are accepted and delivered accordingly. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_proxy.md b/docs/resources/msg_vpn_proxy.md index 8de066ec..edf9fd5d 100644 --- a/docs/resources/msg_vpn_proxy.md +++ b/docs/resources/msg_vpn_proxy.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_proxy Resource - solacebroker" subcategory: "" description: |- Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationbasicpassword||x||x - msgvpnname|x||| - proxy_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + authenticationbasicpassword||x|x + msgvpnname|x|| + proxy_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -18,11 +18,11 @@ description: |- Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authentication_basic_password||x||x -msg_vpn_name|x||| -proxy_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +authentication_basic_password||x|x +msg_vpn_name|x|| +proxy_name|x|| @@ -59,7 +59,3 @@ This has been available since SEMP API version 2.36. "direct" - Direct connection (no proxy). "http" - HTTP proxy. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_queue.md b/docs/resources/msg_vpn_queue.md index 2061e084..5ec36055 100644 --- a/docs/resources/msg_vpn_queue.md +++ b/docs/resources/msg_vpn_queue.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_queue Resource - solacebroker" subcategory: "" description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queue_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,10 +17,10 @@ description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_name|x @@ -92,10 +92,6 @@ This has been available since SEMP API version 2.0. - `respect_msg_priority_enabled` (Boolean) Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). Regardless of this setting, message priority is not respected when browsing the queue, when the queue is used by a bridge, or if the queue is partitioned. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egress_enabled and ingress_enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.8. - `respect_ttl_enabled` (Boolean) Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `event_bind_count_threshold` diff --git a/docs/resources/msg_vpn_queue_subscription.md b/docs/resources/msg_vpn_queue_subscription.md index bc017bf8..a9fb2825 100644 --- a/docs/resources/msg_vpn_queue_subscription.md +++ b/docs/resources/msg_vpn_queue_subscription.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_queue_subscription Resource - solacebroker" subcategory: "" description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queuename|x||| - subscriptiontopic|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queuename|x + subscriptiontopic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,11 +18,11 @@ description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_name|x||| -subscription_topic|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_name|x +subscription_topic|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.0. - `msg_vpn_name` (String) The name of the Message VPN. - `queue_name` (String) The name of the Queue. - `subscription_topic` (String) The topic of the Subscription. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_queue_template.md b/docs/resources/msg_vpn_queue_template.md index ddddf123..3d0dc7a0 100644 --- a/docs/resources/msg_vpn_queue_template.md +++ b/docs/resources/msg_vpn_queue_template.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_queue_template Resource - solacebroker" subcategory: "" description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queuetemplatename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queuetemplatename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -17,10 +17,10 @@ description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_template_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_template_name|x @@ -91,10 +91,6 @@ This has been available since SEMP API version 2.14. - `respect_msg_priority_enabled` (Boolean) Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `respect_ttl_enabled` (Boolean) Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `event_bind_count_threshold` diff --git a/docs/resources/msg_vpn_replay_log.md b/docs/resources/msg_vpn_replay_log.md index d7c4ef30..acde185c 100644 --- a/docs/resources/msg_vpn_replay_log.md +++ b/docs/resources/msg_vpn_replay_log.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_replay_log Resource - solacebroker" subcategory: "" description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - replaylogname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + replaylogname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.10. --- @@ -17,10 +17,10 @@ description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -replay_log_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +replay_log_name|x @@ -44,7 +44,3 @@ This has been available since SEMP API version 2.10. - `ingress_enabled` (Boolean) Enable or disable the reception of messages to the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `max_spool_usage` (Number) The maximum spool usage allowed by the Replay Log, in megabytes (MB). If this limit is exceeded, old messages will be trimmed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - `topic_filter_enabled` (Boolean) Enable or disable topic filtering for the Replay Log. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.27. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md b/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md index 6a886b78..2e2fd9e2 100644 --- a/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md +++ b/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_replay_log_topic_filter_subscription Resource subcategory: "" description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - replaylogname|x||| - topicfiltersubscription|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + replaylogname|x + topicfiltersubscription|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -18,11 +18,11 @@ description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -replay_log_name|x||| -topic_filter_subscription|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +replay_log_name|x +topic_filter_subscription|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.27. - `msg_vpn_name` (String) The name of the Message VPN. - `replay_log_name` (String) The name of the Replay Log. - `topic_filter_subscription` (String) The topic of the Subscription. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_replicated_topic.md b/docs/resources/msg_vpn_replicated_topic.md index 1dd02cb2..100c63f7 100644 --- a/docs/resources/msg_vpn_replicated_topic.md +++ b/docs/resources/msg_vpn_replicated_topic.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_replicated_topic Resource - solacebroker" subcategory: "" description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - replicated_topic|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + replicated_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -17,10 +17,10 @@ description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -replicated_topic|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +replicated_topic|x @@ -46,7 +46,3 @@ This has been available since SEMP API version 2.1. "sync" - Messages are acknowledged when replicated (spooled remotely). "async" - Messages are acknowledged when pending replication (spooled locally). - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_rest_delivery_point.md b/docs/resources/msg_vpn_rest_delivery_point.md index 8d55f714..66ddee49 100644 --- a/docs/resources/msg_vpn_rest_delivery_point.md +++ b/docs/resources/msg_vpn_rest_delivery_point.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point Resource - solacebroker" subcategory: "" description: |- A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - restdeliverypoint_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + restdeliverypoint_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,10 +17,10 @@ description: |- A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -rest_delivery_point_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +rest_delivery_point_name|x @@ -44,7 +44,3 @@ This has been available since SEMP API version 2.0. - `enabled` (Boolean) Enable or disable the REST Delivery Point. When disabled, no connections are initiated or messages delivered to any of the contained REST Consumers. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `service` (String) The name of the service that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.19. - `vendor` (String) The name of the vendor that this REST Delivery Point connects to. Internally the broker does not use this value; it is informational only. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. Available since SEMP API version 2.19. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md b/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md index b5d38ef1..4afbbe06 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md +++ b/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding Resource - s subcategory: "" description: |- A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - queuebindingname|x||| - restdeliverypoint_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + queuebindingname|x + restdeliverypoint_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,11 +18,11 @@ description: |- A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -queue_binding_name|x||| -rest_delivery_point_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +queue_binding_name|x +rest_delivery_point_name|x @@ -52,7 +52,3 @@ This has been available since SEMP API version 2.0. "substitution-expressions" - Evaluate substitution expressions on the request target. Available since SEMP API version 2.23. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md b/docs/resources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md index ee74f341..a4d9f337 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md +++ b/docs/resources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md @@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_protected_re subcategory: "" description: |- A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - headername|x||| - headervalue||x||x - msgvpnname|x||| - queuebindingname|x||| - restdeliverypoint_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + headername|x|| + headervalue||x|x + msgvpnname|x|| + queuebindingname|x|| + restdeliverypoint_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.30. --- @@ -20,13 +20,13 @@ description: |- A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -header_name|x||| -header_value||x||x -msg_vpn_name|x||| -queue_binding_name|x||| -rest_delivery_point_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +header_name|x|| +header_value||x|x +msg_vpn_name|x|| +queue_binding_name|x|| +rest_delivery_point_name|x|| @@ -49,7 +49,3 @@ This has been available since SEMP API version 2.30. ### Optional - `header_value` (String, Sensitive) The value of the protected HTTP request header. Unlike a non-protected request header, this value cannot be displayed after it is set, and does not support substitution expressions. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md b/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md index 490b52cc..e1644a7a 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md +++ b/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_head subcategory: "" description: |- A request header to be added to the HTTP request. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - headername|x||| - msgvpnname|x||| - queuebindingname|x||| - restdeliverypointname|x||| + Attribute|Identifying + :---|:---: + headername|x + msgvpnname|x + queuebindingname|x + restdeliverypointname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.23. --- @@ -19,12 +19,12 @@ description: |- A request header to be added to the HTTP request. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -header_name|x||| -msg_vpn_name|x||| -queue_binding_name|x||| -rest_delivery_point_name|x||| +Attribute|Identifying +:---|:---: +header_name|x +msg_vpn_name|x +queue_binding_name|x +rest_delivery_point_name|x @@ -47,7 +47,3 @@ This has been available since SEMP API version 2.23. ### Optional - `header_value` (String) A substitution expression for the value of the HTTP request header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md index 1f34358c..6c91567a 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md +++ b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md @@ -4,18 +4,18 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer Resource - s subcategory: "" description: |- REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authenticationawssecretaccesskey||x||x - authenticationclientcertcontent||x||x - authenticationclientcertpassword||x|| - authenticationhttpbasicpassword||x||x - authenticationhttpheadervalue||x||x - authenticationoauthclientsecret||x||x - authenticationoauthjwtsecretkey||x||x - msgvpnname|x||| - restconsumername|x||| - restdeliverypointname|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + authenticationawssecretaccesskey||x|x + authenticationclientcertcontent||x|x + authenticationclientcertpassword||x| + authenticationhttpbasicpassword||x|x + authenticationhttpheadervalue||x|x + authenticationoauthclientsecret||x|x + authenticationoauthjwtsecretkey||x|x + msgvpnname|x|| + restconsumername|x|| + restdeliverypointname|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -25,18 +25,18 @@ description: |- REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authentication_aws_secret_access_key||x||x -authentication_client_cert_content||x||x -authentication_client_cert_password||x|| -authentication_http_basic_password||x||x -authentication_http_header_value||x||x -authentication_oauth_client_secret||x||x -authentication_oauth_jwt_secret_key||x||x -msg_vpn_name|x||| -rest_consumer_name|x||| -rest_delivery_point_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +authentication_aws_secret_access_key||x|x +authentication_client_cert_content||x|x +authentication_client_cert_password||x| +authentication_http_basic_password||x|x +authentication_http_header_value||x|x +authentication_oauth_client_secret||x|x +authentication_oauth_jwt_secret_key||x|x +msg_vpn_name|x|| +rest_consumer_name|x|| +rest_delivery_point_name|x|| @@ -104,7 +104,3 @@ This has been available since SEMP API version 2.0. - `retry_delay` (Number) The number of seconds that must pass before retrying the remote REST Consumer connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - `tls_cipher_suite_list` (String) The colon-separated list of cipher suites the REST Consumer uses in its encrypted connection. The value `"default"` implies all supported suites ordered from most secure to least secure. The list of default cipher suites is available in the `tlsCipherSuiteMsgBackboneDefaultList` attribute of the broker object in the Monitoring API. The REST Consumer should choose the first suite from this list that it supports. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"default"`. - `tls_enabled` (Boolean) Enable or disable encryption (TLS) for the REST Consumer. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md index 7d6c2fad..e5222bc1 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md +++ b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md @@ -4,12 +4,12 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_cl subcategory: "" description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - oauthjwtclaimname|x||| - restconsumername|x||| - restdeliverypointname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + oauthjwtclaimname|x + restconsumername|x + restdeliverypointname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.21. --- @@ -19,12 +19,12 @@ description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -oauth_jwt_claim_name|x||| -rest_consumer_name|x||| -rest_delivery_point_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +oauth_jwt_claim_name|x +rest_consumer_name|x +rest_delivery_point_name|x @@ -44,7 +44,3 @@ This has been available since SEMP API version 2.21. - `oauth_jwt_claim_value` (String) The value of the additional claim, which must be a string containing a valid JSON value. - `rest_consumer_name` (String) The name of the REST Consumer. - `rest_delivery_point_name` (String) The name of the REST Delivery Point. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_sequenced_topic.md b/docs/resources/msg_vpn_sequenced_topic.md index 955b0204..0ac72a0f 100644 --- a/docs/resources/msg_vpn_sequenced_topic.md +++ b/docs/resources/msg_vpn_sequenced_topic.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_sequenced_topic Resource - solacebroker" subcategory: "" description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - sequenced_topic|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + sequenced_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,10 +17,10 @@ description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -sequenced_topic|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +sequenced_topic|x @@ -37,7 +37,3 @@ This has been available since SEMP API version 2.0. - `msg_vpn_name` (String) The name of the Message VPN. - `sequenced_topic` (String) Topic for applying sequence numbers. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_telemetry_profile.md b/docs/resources/msg_vpn_telemetry_profile.md index f63672b4..9fb5e42f 100644 --- a/docs/resources/msg_vpn_telemetry_profile.md +++ b/docs/resources/msg_vpn_telemetry_profile.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_telemetry_profile Resource - solacebroker" subcategory: "" description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - telemetryprofilename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + telemetryprofilename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -17,10 +17,10 @@ description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -telemetry_profile_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +telemetry_profile_name|x @@ -62,10 +62,6 @@ This has been available since SEMP API version 2.31. - `trace_enabled` (Boolean) Enable or disable generation of all trace span data messages. When enabled, the state of configured trace filters control which messages get traced. When disabled, trace span data messages are never generated, regardless of the state of trace filters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `trace_send_span_generation_enabled` (Boolean) Enable or disable generation of send spans. For the most complete view of broker message processing, this should be enabled. If the information provided by send spans are not needed, send spans can be disabled to reduce the performance impact of tracing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since SEMP API version 2.36. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `queue_event_bind_count_threshold` diff --git a/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md b/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md index 1d30fed4..a1c24e3f 100644 --- a/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md +++ b/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_receiver_acl_connect_excepti subcategory: "" description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - receiveraclconnectexceptionaddress|x||| - telemetryprofilename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + receiveraclconnectexceptionaddress|x + telemetryprofilename|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -18,11 +18,11 @@ description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -receiver_acl_connect_exception_address|x||| -telemetry_profile_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +receiver_acl_connect_exception_address|x +telemetry_profile_name|x @@ -40,7 +40,3 @@ This has been available since SEMP API version 2.31. - `msg_vpn_name` (String) The name of the Message VPN. - `receiver_acl_connect_exception_address` (String) The IP address/netmask of the receiver connect exception in CIDR form. - `telemetry_profile_name` (String) The name of the Telemetry Profile. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_telemetry_profile_trace_filter.md b/docs/resources/msg_vpn_telemetry_profile_trace_filter.md index 98b8b20f..6e6d8cc7 100644 --- a/docs/resources/msg_vpn_telemetry_profile_trace_filter.md +++ b/docs/resources/msg_vpn_telemetry_profile_trace_filter.md @@ -4,11 +4,11 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter Resource - sola subcategory: "" description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - telemetryprofilename|x||| - tracefiltername|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + telemetryprofilename|x + tracefiltername|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -18,11 +18,11 @@ description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -telemetry_profile_name|x||| -trace_filter_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +telemetry_profile_name|x +trace_filter_name|x @@ -44,7 +44,3 @@ This has been available since SEMP API version 2.31. ### Optional - `enabled` (Boolean) Enable or disable the trace filter. When the filter is disabled, the filter's subscriptions will not trigger a message to be traced. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md b/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md index b7a124d0..7f27cadd 100644 --- a/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md +++ b/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md @@ -4,13 +4,13 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter_subscription Re subcategory: "" description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - subscription|x||| - subscriptionsyntax|x||| - telemetryprofilename|x||| - tracefilter_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + subscription|x + subscriptionsyntax|x + telemetryprofilename|x + tracefilter_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -20,13 +20,13 @@ description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -subscription|x||| -subscription_syntax|x||| -telemetry_profile_name|x||| -trace_filter_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +subscription|x +subscription_syntax|x +telemetry_profile_name|x +trace_filter_name|x @@ -51,7 +51,3 @@ This has been available since SEMP API version 2.31. - `telemetry_profile_name` (String) The name of the Telemetry Profile. - `trace_filter_name` (String) A name used to identify the trace filter. Consider a name that describes the subscriptions contained within the filter, such as the name of the application and/or the scenario in which the trace filter might be enabled, such as "appNameDebug". - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/msg_vpn_topic_endpoint.md b/docs/resources/msg_vpn_topic_endpoint.md index 1c32c0bf..1c8ff81e 100644 --- a/docs/resources/msg_vpn_topic_endpoint.md +++ b/docs/resources/msg_vpn_topic_endpoint.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_topic_endpoint Resource - solacebroker" subcategory: "" description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - topicendpointname|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + topicendpointname|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -17,10 +17,10 @@ description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -topic_endpoint_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +topic_endpoint_name|x @@ -89,10 +89,6 @@ This has been available since SEMP API version 2.1. - `respect_msg_priority_enabled` (Boolean) Enable or disable the respecting of message priority. When enabled, messages contained in the Topic Endpoint are delivered in priority order, from 9 (highest) to 0 (lowest). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egress_enabled and ingress_enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.8. - `respect_ttl_enabled` (Boolean) Enable or disable the respecting of the time-to-live (TTL) for messages in the Topic Endpoint. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `event_bind_count_threshold` diff --git a/docs/resources/msg_vpn_topic_endpoint_template.md b/docs/resources/msg_vpn_topic_endpoint_template.md index a34bdd81..8a8aee85 100644 --- a/docs/resources/msg_vpn_topic_endpoint_template.md +++ b/docs/resources/msg_vpn_topic_endpoint_template.md @@ -4,10 +4,10 @@ page_title: "solacebroker_msg_vpn_topic_endpoint_template Resource - solacebroke subcategory: "" description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - topicendpointtemplate_name|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + topicendpointtemplate_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -17,10 +17,10 @@ description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -topic_endpoint_template_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +topic_endpoint_template_name|x @@ -85,10 +85,6 @@ This has been available since SEMP API version 2.14. - `respect_ttl_enabled` (Boolean) Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `topic_endpoint_name_filter` (String) A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. - ### Nested Schema for `event_bind_count_threshold` diff --git a/docs/resources/oauth_profile.md b/docs/resources/oauth_profile.md index 5f2aea47..e3570aab 100644 --- a/docs/resources/oauth_profile.md +++ b/docs/resources/oauth_profile.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile Resource - solacebroker" subcategory: "" description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientsecret||x||x - oauthprofile_name|x||| + Attribute|Identifying|Write-Only|Opaque + :---|:---:|:---:|:---: + clientsecret||x|x + oauthprofile_name|x|| A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_secret||x||x -oauth_profile_name|x||| +Attribute|Identifying|Write-Only|Opaque +:---|:---:|:---:|:---: +client_secret||x|x +oauth_profile_name|x|| @@ -102,7 +102,3 @@ This has been available since SEMP API version 2.24. - `resource_server_validate_type_enabled` (Boolean) Enable or disable verification of the TYP field in the access token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `semp_enabled` (Boolean) Enable or disable authentication of SEMP requests with OAuth tokens. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `username_claim_name` (String) The name of the username claim. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"sub"`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/oauth_profile_access_level_group.md b/docs/resources/oauth_profile_access_level_group.md index ba396d3b..2df8df04 100644 --- a/docs/resources/oauth_profile_access_level_group.md +++ b/docs/resources/oauth_profile_access_level_group.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_access_level_group Resource - solacebrok subcategory: "" description: |- The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - groupname|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + groupname|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- The name of a group as it exists on the OAuth server being used to authenticate SEMP users. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -group_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +group_name|x +oauth_profile_name|x @@ -56,7 +56,3 @@ This has been available since SEMP API version 2.24. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md b/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md index 81cc2974..2b004943 100644 --- a/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md +++ b/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md @@ -4,11 +4,11 @@ page_title: "solacebroker_oauth_profile_access_level_group_msg_vpn_access_level_ subcategory: "" description: |- Message VPN access-level exceptions for members of this group. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - groupname|x||| - msgvpnname|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + groupname|x + msgvpnname|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -18,11 +18,11 @@ description: |- Message VPN access-level exceptions for members of this group. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -group_name|x||| -msg_vpn_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +group_name|x +msg_vpn_name|x +oauth_profile_name|x @@ -50,7 +50,3 @@ This has been available since SEMP API version 2.24. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/oauth_profile_client_allowed_host.md b/docs/resources/oauth_profile_client_allowed_host.md index ff205aa7..b2f50078 100644 --- a/docs/resources/oauth_profile_client_allowed_host.md +++ b/docs/resources/oauth_profile_client_allowed_host.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_client_allowed_host Resource - solacebro subcategory: "" description: |- A valid hostname for this broker in OAuth redirects. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - allowedhost|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + allowedhost|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- A valid hostname for this broker in OAuth redirects. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -allowed_host|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +allowed_host|x +oauth_profile_name|x @@ -37,7 +37,3 @@ This has been available since SEMP API version 2.24. - `allowed_host` (String) An allowed value for the Host header. - `oauth_profile_name` (String) The name of the OAuth profile. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/oauth_profile_client_authorization_parameter.md b/docs/resources/oauth_profile_client_authorization_parameter.md index a2a39ea1..92ab9bc4 100644 --- a/docs/resources/oauth_profile_client_authorization_parameter.md +++ b/docs/resources/oauth_profile_client_authorization_parameter.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_client_authorization_parameter Resource subcategory: "" description: |- Additional parameters to be passed to the OAuth authorization endpoint. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - authorizationparametername|x||| - oauthprofilename|x||| + Attribute|Identifying + :---|:---: + authorizationparametername|x + oauthprofilename|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Additional parameters to be passed to the OAuth authorization endpoint. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -authorization_parameter_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +authorization_parameter_name|x +oauth_profile_name|x @@ -41,7 +41,3 @@ This has been available since SEMP API version 2.24. ### Optional - `authorization_parameter_value` (String) The authorization parameter value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/oauth_profile_client_required_claim.md b/docs/resources/oauth_profile_client_required_claim.md index 6e100967..e67868e3 100644 --- a/docs/resources/oauth_profile_client_required_claim.md +++ b/docs/resources/oauth_profile_client_required_claim.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_client_required_claim Resource - solaceb subcategory: "" description: |- Additional claims to be verified in the ID token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - clientrequiredclaimname|x||| - oauthprofile_name|x||| + Attribute|Identifying + :---|:---: + clientrequiredclaimname|x + oauthprofile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Additional claims to be verified in the ID token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -client_required_claim_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +client_required_claim_name|x +oauth_profile_name|x @@ -38,7 +38,3 @@ This has been available since SEMP API version 2.24. - `client_required_claim_name` (String) The name of the ID token claim to verify. - `client_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. - `oauth_profile_name` (String) The name of the OAuth profile. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md b/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md index 191ae522..57c1be35 100644 --- a/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md +++ b/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_default_msg_vpn_access_level_exception R subcategory: "" description: |- Default message VPN access-level exceptions. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - msgvpnname|x||| - oauthprofilename|x||| + Attribute|Identifying + :---|:---: + msgvpnname|x + oauthprofilename|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Default message VPN access-level exceptions. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -msg_vpn_name|x||| -oauth_profile_name|x||| +Attribute|Identifying +:---|:---: +msg_vpn_name|x +oauth_profile_name|x @@ -47,7 +47,3 @@ This has been available since SEMP API version 2.24. "read-only" - User has read-only access to a Message VPN. "read-write" - User has read-write access to most Message VPN settings. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/oauth_profile_resource_server_required_claim.md b/docs/resources/oauth_profile_resource_server_required_claim.md index 874b79ff..53b630f8 100644 --- a/docs/resources/oauth_profile_resource_server_required_claim.md +++ b/docs/resources/oauth_profile_resource_server_required_claim.md @@ -4,10 +4,10 @@ page_title: "solacebroker_oauth_profile_resource_server_required_claim Resource subcategory: "" description: |- Additional claims to be verified in the access token. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - oauthprofilename|x||| - resourceserverrequiredclaimname|x||| + Attribute|Identifying + :---|:---: + oauthprofilename|x + resourceserverrequiredclaimname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- @@ -17,10 +17,10 @@ description: |- Additional claims to be verified in the access token. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -oauth_profile_name|x||| -resource_server_required_claim_name|x||| +Attribute|Identifying +:---|:---: +oauth_profile_name|x +resource_server_required_claim_name|x @@ -38,7 +38,3 @@ This has been available since SEMP API version 2.24. - `oauth_profile_name` (String) The name of the OAuth profile. - `resource_server_required_claim_name` (String) The name of the access token claim to verify. - `resource_server_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/docs/resources/virtual_hostname.md b/docs/resources/virtual_hostname.md index 048526eb..32c684b7 100644 --- a/docs/resources/virtual_hostname.md +++ b/docs/resources/virtual_hostname.md @@ -6,9 +6,9 @@ description: |- A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - Attribute|Identifying|Write-Only|Deprecated|Opaque - :---|:---:|:---:|:---:|:---: - virtual_hostname|x||| + Attribute|Identifying + :---|:---: + virtual_hostname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.17. --- @@ -22,9 +22,9 @@ Clients which connect to a global (as opposed to per Message VPN) port and provi This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. -Attribute|Identifying|Write-Only|Deprecated|Opaque -:---|:---:|:---:|:---:|:---: -virtual_hostname|x||| +Attribute|Identifying +:---|:---: +virtual_hostname|x @@ -45,7 +45,3 @@ This has been available since SEMP API version 2.17. - `enabled` (Boolean) Enable or disable Virtual Hostname to Message VPN mapping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `msg_vpn_name` (String) The message VPN to which this virtual hostname is mapped. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - -### Read-Only - -- `id` (String) Identifier attribute, for internal use only. diff --git a/go.mod b/go.mod index c8a75bc3..5c53d2d6 100644 --- a/go.mod +++ b/go.mod @@ -1,115 +1,113 @@ module terraform-provider-solacebroker -go 1.20 +go 1.21 require ( - github.com/agext/levenshtein v1.2.2 // indirect - github.com/google/go-cmp v0.5.9 // indirect - github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect github.com/hashicorp/go-version v1.6.0 - github.com/hashicorp/hcl/v2 v2.17.0 // indirect - github.com/hashicorp/logutils v1.0.0 // indirect - github.com/hashicorp/terraform-plugin-docs v0.15.0 - github.com/hashicorp/terraform-plugin-framework v1.3.2 - github.com/hashicorp/terraform-plugin-framework-validators v0.10.0 - github.com/hashicorp/terraform-plugin-go v0.18.0 + github.com/hashicorp/terraform-plugin-docs v0.16.0 + github.com/hashicorp/terraform-plugin-framework v1.4.2 + github.com/hashicorp/terraform-plugin-framework-validators v0.12.0 + github.com/hashicorp/terraform-plugin-go v0.19.0 github.com/hashicorp/terraform-plugin-log v0.9.0 - github.com/hashicorp/terraform-plugin-sdk/v2 v2.27.0 // indirect - github.com/mitchellh/go-wordwrap v1.0.0 // indirect - github.com/mitchellh/mapstructure v1.5.0 // indirect - github.com/spf13/cobra v1.7.0 - github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect - golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb - google.golang.org/appengine v1.6.7 // indirect + github.com/hashicorp/terraform-plugin-testing v1.5.1 + github.com/spf13/cobra v1.8.0 + github.com/testcontainers/testcontainers-go v0.26.0 + golang.org/x/exp v0.0.0-20231006140011-7918f672742d ) require ( + dario.cat/mergo v1.0.0 // indirect + github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect github.com/Masterminds/goutils v1.1.1 // indirect - github.com/Masterminds/semver/v3 v3.2.1 // indirect - github.com/Masterminds/sprig/v3 v3.2.3 // indirect - github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8 // indirect - github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect + github.com/Masterminds/semver/v3 v3.1.1 // indirect + github.com/Masterminds/sprig/v3 v3.2.2 // indirect + github.com/Microsoft/go-winio v0.6.1 // indirect + github.com/Microsoft/hcsshim v0.11.1 // indirect + github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95 // indirect + github.com/agext/levenshtein v1.2.2 // indirect + github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect github.com/armon/go-radix v1.0.0 // indirect github.com/bgentry/speakeasy v0.1.0 // indirect + github.com/cenkalti/backoff/v4 v4.2.1 // indirect github.com/cloudflare/circl v1.3.3 // indirect - github.com/fatih/color v1.15.0 // indirect + github.com/containerd/containerd v1.7.7 // indirect + github.com/containerd/log v0.1.0 // indirect + github.com/cpuguy83/dockercfg v0.3.1 // indirect + github.com/docker/distribution v2.8.2+incompatible // indirect + github.com/docker/docker v24.0.6+incompatible // indirect + github.com/docker/go-connections v0.4.0 // indirect + github.com/docker/go-units v0.5.0 // indirect + github.com/fatih/color v1.13.0 // indirect + github.com/go-ole/go-ole v1.2.6 // indirect + github.com/gogo/protobuf v1.3.2 // indirect github.com/golang/protobuf v1.5.3 // indirect + github.com/google/go-cmp v0.6.0 // indirect github.com/google/uuid v1.3.1 // indirect github.com/hashicorp/errwrap v1.1.0 // indirect github.com/hashicorp/go-checkpoint v0.5.0 // indirect github.com/hashicorp/go-cleanhttp v0.5.2 // indirect + github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect github.com/hashicorp/go-hclog v1.5.0 // indirect github.com/hashicorp/go-multierror v1.1.1 // indirect - github.com/hashicorp/go-plugin v1.4.10 // indirect + github.com/hashicorp/go-plugin v1.5.1 // indirect + github.com/hashicorp/go-retryablehttp v0.7.5 github.com/hashicorp/go-uuid v1.0.3 // indirect - github.com/hashicorp/hc-install v0.5.2 // indirect - github.com/hashicorp/terraform-exec v0.18.1 // indirect + github.com/hashicorp/hc-install v0.6.0 // indirect + github.com/hashicorp/hcl/v2 v2.18.0 // indirect + github.com/hashicorp/logutils v1.0.0 // indirect + github.com/hashicorp/terraform-exec v0.19.0 // indirect github.com/hashicorp/terraform-json v0.17.1 // indirect - github.com/hashicorp/terraform-plugin-testing v1.4.0 - github.com/hashicorp/terraform-registry-address v0.2.1 // indirect + github.com/hashicorp/terraform-plugin-sdk/v2 v2.29.0 // indirect + github.com/hashicorp/terraform-registry-address v0.2.2 // indirect github.com/hashicorp/terraform-svchost v0.1.1 // indirect github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect - github.com/huandu/xstrings v1.4.0 // indirect - github.com/imdario/mergo v0.3.13 // indirect + github.com/huandu/xstrings v1.3.2 // indirect + github.com/imdario/mergo v0.3.15 // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/klauspost/compress v1.16.0 // indirect + github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect + github.com/magiconair/properties v1.8.7 // indirect github.com/mattn/go-colorable v0.1.13 // indirect - github.com/mattn/go-isatty v0.0.19 // indirect + github.com/mattn/go-isatty v0.0.16 // indirect github.com/mitchellh/cli v1.1.5 // indirect github.com/mitchellh/copystructure v1.2.0 // indirect github.com/mitchellh/go-testing-interface v1.14.1 // indirect + github.com/mitchellh/go-wordwrap v1.0.0 // indirect + github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/mitchellh/reflectwalk v1.0.2 // indirect - github.com/oklog/run v1.0.0 // indirect - github.com/posener/complete v1.2.3 // indirect - github.com/russross/blackfriday v1.6.0 // indirect - github.com/shopspring/decimal v1.3.1 // indirect - github.com/spf13/cast v1.5.1 // indirect - github.com/spf13/pflag v1.0.5 // indirect - github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect - github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect - github.com/zclconf/go-cty v1.13.2 // indirect - golang.org/x/crypto v0.11.0 // indirect - golang.org/x/mod v0.11.0 // indirect - golang.org/x/net v0.12.0 // indirect - golang.org/x/sys v0.11.0 // indirect - golang.org/x/text v0.11.0 // indirect - google.golang.org/grpc v1.57.0 // indirect - google.golang.org/protobuf v1.31.0 // indirect -) - -require github.com/testcontainers/testcontainers-go v0.24.1 - -require ( - dario.cat/mergo v1.0.0 // indirect - github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect - github.com/Microsoft/go-winio v0.6.1 // indirect - github.com/Microsoft/hcsshim v0.11.0 // indirect - github.com/cenkalti/backoff/v4 v4.2.1 // indirect - github.com/containerd/containerd v1.7.6 // indirect - github.com/cpuguy83/dockercfg v0.3.1 // indirect - github.com/docker/distribution v2.8.2+incompatible // indirect - github.com/docker/docker v24.0.6+incompatible // indirect - github.com/docker/go-connections v0.4.0 // indirect - github.com/docker/go-units v0.5.0 // indirect - github.com/go-ole/go-ole v1.2.6 // indirect - github.com/gogo/protobuf v1.3.2 // indirect - github.com/klauspost/compress v1.16.0 // indirect - github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect - github.com/magiconair/properties v1.8.7 // indirect - github.com/moby/patternmatcher v0.5.0 // indirect + github.com/moby/patternmatcher v0.6.0 // indirect github.com/moby/sys/sequential v0.5.0 // indirect github.com/moby/term v0.5.0 // indirect github.com/morikuni/aec v1.0.0 // indirect + github.com/oklog/run v1.0.0 // indirect github.com/opencontainers/go-digest v1.0.0 // indirect - github.com/opencontainers/image-spec v1.1.0-rc4 // indirect + github.com/opencontainers/image-spec v1.1.0-rc5 // indirect github.com/opencontainers/runc v1.1.5 // indirect github.com/pkg/errors v0.9.1 // indirect + github.com/posener/complete v1.2.3 // indirect github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect - github.com/shirou/gopsutil/v3 v3.23.7 // indirect + github.com/russross/blackfriday v1.6.0 // indirect + github.com/shirou/gopsutil/v3 v3.23.9 // indirect github.com/shoenig/go-m1cpu v0.1.6 // indirect - github.com/sirupsen/logrus v1.9.0 // indirect - github.com/tklauser/go-sysconf v0.3.11 // indirect - github.com/tklauser/numcpus v0.6.0 // indirect + github.com/shopspring/decimal v1.3.1 // indirect + github.com/sirupsen/logrus v1.9.3 // indirect + github.com/spf13/cast v1.5.0 // indirect + github.com/spf13/pflag v1.0.5 // indirect + github.com/tklauser/go-sysconf v0.3.12 // indirect + github.com/tklauser/numcpus v0.6.1 // indirect + github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect + github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect + github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect github.com/yusufpapurcu/wmi v1.2.3 // indirect - golang.org/x/tools v0.7.0 // indirect + github.com/zclconf/go-cty v1.14.0 // indirect + golang.org/x/crypto v0.14.0 // indirect + golang.org/x/mod v0.13.0 // indirect + golang.org/x/net v0.17.0 // indirect + golang.org/x/sys v0.13.0 // indirect + golang.org/x/text v0.13.0 // indirect + golang.org/x/tools v0.14.0 // indirect + google.golang.org/appengine v1.6.7 // indirect google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 // indirect + google.golang.org/grpc v1.57.1 // indirect + google.golang.org/protobuf v1.31.0 // indirect ) diff --git a/go.sum b/go.sum index 2e3068f0..3a4dc430 100644 --- a/go.sum +++ b/go.sum @@ -1,52 +1,56 @@ dario.cat/mergo v1.0.0 h1:AGCNq9Evsj31mOgNPcLyXc+4PNABt905YmuqPYYpBWk= dario.cat/mergo v1.0.0/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk= github.com/AdaLogics/go-fuzz-headers v0.0.0-20230811130428-ced1acdcaa24 h1:bvDV9vkmnHYOMsOr4WLk+Vo07yKIzd94sVoIqshQ4bU= +github.com/AdaLogics/go-fuzz-headers v0.0.0-20230811130428-ced1acdcaa24/go.mod h1:8o94RPi1/7XTJvwPpRSzSUedZrtlirdB3r9Z20bi2f8= github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 h1:UQHMgLO+TxOElx5B5HZ4hJQsoJ/PvUvKRhJHDQXO8P8= github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1/go.mod h1:xomTg63KZ2rFqZQzSB4Vz2SUXa1BpHTVz9L5PTmPC4E= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/Masterminds/goutils v1.1.1 h1:5nUrii3FMTL5diU80unEVvNevw1nH4+ZV4DSLVJLSYI= github.com/Masterminds/goutils v1.1.1/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy863GQaJW2MFNU= +github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc= github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs= -github.com/Masterminds/semver/v3 v3.2.0/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ= -github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0= -github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ= github.com/Masterminds/sprig/v3 v3.2.1/go.mod h1:UoaO7Yp8KlPnJIYWTFkMaqPUYKTfGFPhxNuwnnxkKlk= -github.com/Masterminds/sprig/v3 v3.2.3 h1:eL2fZNezLomi0uOLqjQoN6BfsDD+fyLtgbJMAj9n6YA= -github.com/Masterminds/sprig/v3 v3.2.3/go.mod h1:rXcFaZ2zZbLRJv/xSysmlgIM1u11eBaRMhvYXJNkGuM= +github.com/Masterminds/sprig/v3 v3.2.2 h1:17jRggJu518dr3QaafizSXOjKYp94wKfABxUmyxvxX8= +github.com/Masterminds/sprig/v3 v3.2.2/go.mod h1:UoaO7Yp8KlPnJIYWTFkMaqPUYKTfGFPhxNuwnnxkKlk= github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migciow= github.com/Microsoft/go-winio v0.6.1/go.mod h1:LRdKpFKfdobln8UmuiYcKPot9D2v6svN5+sAH+4kjUM= -github.com/Microsoft/hcsshim v0.11.0 h1:7EFNIY4igHEXUdj1zXgAyU3fLc7QfOKHbkldRVTBdiM= -github.com/Microsoft/hcsshim v0.11.0/go.mod h1:OEthFdQv/AD2RAdzR6Mm1N1KPCztGKDurW1Z8b8VGMM= -github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8 h1:wPbRQzjjwFc0ih8puEVAOFGELsn1zoIIYdxvML7mDxA= -github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8/go.mod h1:I0gYDMZ6Z5GRU7l58bNFSkPTFN6Yl12dsUlAZ8xy98g= +github.com/Microsoft/hcsshim v0.11.1 h1:hJ3s7GbWlGK4YVV92sO88BQSyF4ZLVy7/awqOlPxFbA= +github.com/Microsoft/hcsshim v0.11.1/go.mod h1:nFJmaO4Zr5Y7eADdFOpYswDDlNVbvcIJJNJLECr5JQg= +github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95 h1:KLq8BE0KwCL+mmXnjLWEAOYO+2l2AE4YMmqG1ZpZHBs= +github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0= github.com/acomagu/bufpipe v1.0.4 h1:e3H4WUzM3npvo5uv95QuJM3cQspFNtFBzvJ2oNjKIDQ= +github.com/acomagu/bufpipe v1.0.4/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4= github.com/agext/levenshtein v1.2.2 h1:0S/Yg6LYmFJ5stwQeRp6EeOcCbj7xiqQSdNelsXvaqE= github.com/agext/levenshtein v1.2.2/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= github.com/apparentlymart/go-textseg/v12 v12.0.0/go.mod h1:S/4uRK2UtaQttw1GenVJEynmyUenKwP++x/+DdGV/Ec= -github.com/apparentlymart/go-textseg/v13 v13.0.0 h1:Y+KvPE1NYz0xl601PVImeQfFyEy6iT90AvPUL1NNfNw= -github.com/apparentlymart/go-textseg/v13 v13.0.0/go.mod h1:ZK2fH7c4NqDTLtiYLvIkEghdlcqw7yxLeM89kiTRPUo= +github.com/apparentlymart/go-textseg/v15 v15.0.0 h1:uYvfpb3DyLSCGWnctWKGj857c6ew1u1fNQOlOtuGxQY= +github.com/apparentlymart/go-textseg/v15 v15.0.0/go.mod h1:K8XmNZdhEBkdlyDdvbmmsvpAG721bKi0joRfFdHIWJ4= github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI= github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY= github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs= -github.com/bwesterb/go-ristretto v1.2.0/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0= +github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA= +github.com/bufbuild/protocompile v0.4.0/go.mod h1:3v93+mbWn/v3xzN+31nwkJfrEpAUwp+BagBSZWx+TP8= +github.com/bwesterb/go-ristretto v1.2.3/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0= github.com/cenkalti/backoff/v4 v4.2.1 h1:y4OZtCnogmCPw98Zjyt5a6+QwPLGkiQsYW5oUqylYbM= github.com/cenkalti/backoff/v4 v4.2.1/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE= github.com/checkpoint-restore/go-criu/v5 v5.3.0/go.mod h1:E/eQpaFtUKGOOSEBZgmKAcn+zUUwWxqcaKZlF54wK8E= github.com/cilium/ebpf v0.7.0/go.mod h1:/oI2+1shJiTGAMgl6/RgJr36Eo1jzrRcAWbcXO2usCA= -github.com/cloudflare/circl v1.1.0/go.mod h1:prBCrKB9DV4poKZY1l9zBXg2QJY7mvgRvtMxxK7fi4I= github.com/cloudflare/circl v1.3.3 h1:fE/Qz0QdIGqeWfnwq0RE0R7MI51s0M2E4Ga9kq5AEMs= github.com/cloudflare/circl v1.3.3/go.mod h1:5XYMA4rFBvNIrhs50XuiBJ15vF2pZn4nnUKZrLbUZFA= github.com/containerd/console v1.0.3/go.mod h1:7LqA/THxQ86k76b8c/EMSiaJ3h1eZkMkXar0TQ1gf3U= -github.com/containerd/containerd v1.7.6 h1:oNAVsnhPoy4BTPQivLgTzI9Oleml9l/+eYIDYXRCYo8= -github.com/containerd/containerd v1.7.6/go.mod h1:SY6lrkkuJT40BVNO37tlYTSnKJnP5AXBc0fhx0q+TJ4= +github.com/containerd/containerd v1.7.7 h1:QOC2K4A42RQpcrZyptP6z9EJZnlHfHJUfZrAAHe15q4= +github.com/containerd/containerd v1.7.7/go.mod h1:3c4XZv6VeT9qgf9GMTxNTMFxGJrGpI2vz1yk4ye+YY8= +github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I= +github.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo= github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= github.com/cpuguy83/dockercfg v0.3.1 h1:/FpZ+JaygUR/lZP2NlFI2DVfrOEMAIKP5wWEJdoYe9E= github.com/cpuguy83/dockercfg v0.3.1/go.mod h1:sugsbF4//dDlL/i+S+rtpIWp+5h0BHJHfjj5/jFyUJc= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= -github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY= +github.com/creack/pty v1.1.18/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= github.com/cyphar/filepath-securejoin v0.2.3/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= @@ -61,22 +65,29 @@ github.com/docker/go-units v0.4.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDD github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4= github.com/docker/go-units v0.5.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDDbaIK4Dk= github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= +github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= +github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w= github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk= -github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs= -github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw= github.com/frankban/quicktest v1.11.3/go.mod h1:wRf/ReqHper53s+kmmSZizM8NamnL3IM0I9ntUbOk+k= -github.com/frankban/quicktest v1.14.4 h1:g2rn0vABPOOXmZUj+vbmUp0lPoXEMuhTpIluN0XL9UY= -github.com/go-git/gcfg v1.5.0 h1:Q5ViNfGF8zFgyJWPqYwA7qGFoMTEiBmdlkcfRmpIMa4= +github.com/frankban/quicktest v1.14.3 h1:FJKSZTDHjyhriyC81FLQ0LY93eSai0ZyR/ZIkd3ZUKE= +github.com/frankban/quicktest v1.14.3/go.mod h1:mgiwOwqx65TmIk1wJ6Q7wvnVMocbUorkibMOrVTHZps= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI= +github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic= github.com/go-git/go-billy/v5 v5.4.1 h1:Uwp5tDRkPr+l/TnbHOQzp+tmJfLceOlbVucgpTz8ix4= -github.com/go-git/go-git/v5 v5.6.1 h1:q4ZRqQl4pR/ZJHc1L5CFjGA1a10u76aV1iC+nh+bHsk= +github.com/go-git/go-billy/v5 v5.4.1/go.mod h1:vjbugF6Fz7JIflbVpl1hJsGjSHNltrSw45YK/ukIvQg= +github.com/go-git/go-git/v5 v5.8.1 h1:Zo79E4p7TRk0xoRgMq0RShiTHGKcKI4+DI6BfJc/Q+A= +github.com/go-git/go-git/v5 v5.8.1/go.mod h1:FHFuoD6yGz5OSKEBK+aWN9Oah0q54Jxl0abmj6GnqAo= github.com/go-ole/go-ole v1.2.6 h1:/Fpf6oFPoeFik9ty7siob0G6Ke8QvQEuVcuChpwXzpY= github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= github.com/go-test/deep v1.0.3 h1:ZrJSEWsXzPOxaZnFteGEfooLba+ju3FYIbOrS+rQd68= +github.com/go-test/deep v1.0.3/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/godbus/dbus/v5 v5.0.6/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= github.com/golang/protobuf v1.1.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= @@ -86,8 +97,9 @@ github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMyw github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38= github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.3.1 h1:KjJaJ9iWZ3jOFZIf1Lqf4laDRCasjl0BCmnEGxkdLb4= @@ -102,72 +114,79 @@ github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9n github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 h1:1/D3zfFHttUKaCaGKZ/dR2roBXv0vKbSCnssIldfQdI= github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320/go.mod h1:EiZBMaudVLy8fmjf9Npq1dq9RalhveqZG5w/yz3mHWs= +github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= github.com/hashicorp/go-hclog v1.5.0 h1:bI2ocEMgcVlz55Oj1xZNBsVi900c7II+fWDyV9o+13c= github.com/hashicorp/go-hclog v1.5.0/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M= github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= -github.com/hashicorp/go-plugin v1.4.10 h1:xUbmA4jC6Dq163/fWcp8P3JuHilrHHMLNRxzGQJ9hNk= -github.com/hashicorp/go-plugin v1.4.10/go.mod h1:6/1TEzT0eQznvI/gV2CM29DLSkAK/e58mUWKVsPaph0= +github.com/hashicorp/go-plugin v1.5.1 h1:oGm7cWBaYIp3lJpx1RUEfLWophprE2EV/KUeqBYo+6k= +github.com/hashicorp/go-plugin v1.5.1/go.mod h1:w1sAEES3g3PuV/RzUrgow20W2uErMly84hhD3um1WL4= +github.com/hashicorp/go-retryablehttp v0.7.5 h1:bJj+Pj19UZMIweq/iie+1u5YCdGrnxCT9yvm0e+Nd5M= +github.com/hashicorp/go-retryablehttp v0.7.5/go.mod h1:Jy/gPYAdjqffZ/yFGCFV2doI5wjtH1ewM9u8iYVjtX8= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/Co8= github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-version v1.6.0 h1:feTTfFNnjP967rlCxM/I9g701jU+RN74YKx2mOkIeek= github.com/hashicorp/go-version v1.6.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= -github.com/hashicorp/hc-install v0.5.2 h1:SfwMFnEXVVirpwkDuSF5kymUOhrUxrTq3udEseZdOD0= -github.com/hashicorp/hc-install v0.5.2/go.mod h1:9QISwe6newMWIfEiXpzuu1k9HAGtQYgnSH8H9T8wmoI= -github.com/hashicorp/hcl/v2 v2.17.0 h1:z1XvSUyXd1HP10U4lrLg5e0JMVz6CPaJvAgxM0KNZVY= -github.com/hashicorp/hcl/v2 v2.17.0/go.mod h1:gJyW2PTShkJqQBKpAmPO3yxMxIuoXkOF2TpqXzrQyx4= +github.com/hashicorp/hc-install v0.6.0 h1:fDHnU7JNFNSQebVKYhHZ0va1bC6SrPQ8fpebsvNr2w4= +github.com/hashicorp/hc-install v0.6.0/go.mod h1:10I912u3nntx9Umo1VAeYPUUuehk0aRQJYpMwbX5wQA= +github.com/hashicorp/hcl/v2 v2.18.0 h1:wYnG7Lt31t2zYkcquwgKo6MWXzRUDIeIVU5naZwHLl8= +github.com/hashicorp/hcl/v2 v2.18.0/go.mod h1:ThLC89FV4p9MPW804KVbe/cEXoQ8NZEh+JtMeeGErHE= github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y= github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= -github.com/hashicorp/terraform-exec v0.18.1 h1:LAbfDvNQU1l0NOQlTuudjczVhHj061fNX5H8XZxHlH4= -github.com/hashicorp/terraform-exec v0.18.1/go.mod h1:58wg4IeuAJ6LVsLUeD2DWZZoc/bYi6dzhLHzxM41980= +github.com/hashicorp/terraform-exec v0.19.0 h1:FpqZ6n50Tk95mItTSS9BjeOVUb4eg81SpgVtZNNtFSM= +github.com/hashicorp/terraform-exec v0.19.0/go.mod h1:tbxUpe3JKruE9Cuf65mycSIT8KiNPZ0FkuTE3H4urQg= github.com/hashicorp/terraform-json v0.17.1 h1:eMfvh/uWggKmY7Pmb3T85u86E2EQg6EQHgyRwf3RkyA= github.com/hashicorp/terraform-json v0.17.1/go.mod h1:Huy6zt6euxaY9knPAFKjUITn8QxUFIe9VuSzb4zn/0o= -github.com/hashicorp/terraform-plugin-docs v0.15.0 h1:W5xYB5kCUBqO7lyjE2UMmUBh95c0aAf4jwO0Xuuw2Ec= -github.com/hashicorp/terraform-plugin-docs v0.15.0/go.mod h1:K5Taof1Y7sL4dw6Ie0qMFyQnHN0W+RSVMD0iIyFDFJc= -github.com/hashicorp/terraform-plugin-framework v1.3.2 h1:aQ6GSD0CTnvoALEWvKAkcH/d8jqSE0Qq56NYEhCexUs= -github.com/hashicorp/terraform-plugin-framework v1.3.2/go.mod h1:oimsRAPJOYkZ4kY6xIGfR0PHjpHLDLaknzuptl6AvnY= -github.com/hashicorp/terraform-plugin-framework-validators v0.10.0 h1:4L0tmy/8esP6OcvocVymw52lY0HyQ5OxB7VNl7k4bS0= -github.com/hashicorp/terraform-plugin-framework-validators v0.10.0/go.mod h1:qdQJCdimB9JeX2YwOpItEu+IrfoJjWQ5PhLpAOMDQAE= -github.com/hashicorp/terraform-plugin-go v0.18.0 h1:IwTkOS9cOW1ehLd/rG0y+u/TGLK9y6fGoBjXVUquzpE= -github.com/hashicorp/terraform-plugin-go v0.18.0/go.mod h1:l7VK+2u5Kf2y+A+742GX0ouLut3gttudmvMgN0PA74Y= +github.com/hashicorp/terraform-plugin-docs v0.16.0 h1:UmxFr3AScl6Wged84jndJIfFccGyBZn52KtMNsS12dI= +github.com/hashicorp/terraform-plugin-docs v0.16.0/go.mod h1:M3ZrlKBJAbPMtNOPwHicGi1c+hZUh7/g0ifT/z7TVfA= +github.com/hashicorp/terraform-plugin-framework v1.4.2 h1:P7a7VP1GZbjc4rv921Xy5OckzhoiO3ig6SGxwelD2sI= +github.com/hashicorp/terraform-plugin-framework v1.4.2/go.mod h1:GWl3InPFZi2wVQmdVnINPKys09s9mLmTZr95/ngLnbY= +github.com/hashicorp/terraform-plugin-framework-validators v0.12.0 h1:HOjBuMbOEzl7snOdOoUfE2Jgeto6JOjLVQ39Ls2nksc= +github.com/hashicorp/terraform-plugin-framework-validators v0.12.0/go.mod h1:jfHGE/gzjxYz6XoUwi/aYiiKrJDeutQNUtGQXkaHklg= +github.com/hashicorp/terraform-plugin-go v0.19.0 h1:BuZx/6Cp+lkmiG0cOBk6Zps0Cb2tmqQpDM3iAtnhDQU= +github.com/hashicorp/terraform-plugin-go v0.19.0/go.mod h1:EhRSkEPNoylLQntYsk5KrDHTZJh9HQoumZXbOGOXmec= github.com/hashicorp/terraform-plugin-log v0.9.0 h1:i7hOA+vdAItN1/7UrfBqBwvYPQ9TFvymaRGZED3FCV0= github.com/hashicorp/terraform-plugin-log v0.9.0/go.mod h1:rKL8egZQ/eXSyDqzLUuwUYLVdlYeamldAHSxjUFADow= -github.com/hashicorp/terraform-plugin-sdk/v2 v2.27.0 h1:I8efBnjuDrgPjNF1MEypHy48VgcTIUY4X6rOFunrR3Y= -github.com/hashicorp/terraform-plugin-sdk/v2 v2.27.0/go.mod h1:cUEP4ly/nxlHy5HzD6YRrHydtlheGvGRJDhiWqqVik4= -github.com/hashicorp/terraform-plugin-testing v1.4.0 h1:DVIXxw7VHZvnwWVik4HzhpC2yytaJ5FpiHxz5debKmE= -github.com/hashicorp/terraform-plugin-testing v1.4.0/go.mod h1:b7Bha24iGrbZQjT+ZE8m9crck1YjdVOZ8mfGCQ19OxA= -github.com/hashicorp/terraform-registry-address v0.2.1 h1:QuTf6oJ1+WSflJw6WYOHhLgwUiQ0FrROpHPYFtwTYWM= -github.com/hashicorp/terraform-registry-address v0.2.1/go.mod h1:BSE9fIFzp0qWsJUUyGquo4ldV9k2n+psif6NYkBRS3Y= +github.com/hashicorp/terraform-plugin-sdk/v2 v2.29.0 h1:wcOKYwPI9IorAJEBLzgclh3xVolO7ZorYd6U1vnok14= +github.com/hashicorp/terraform-plugin-sdk/v2 v2.29.0/go.mod h1:qH/34G25Ugdj5FcM95cSoXzUgIbgfhVLXCcEcYaMwq8= +github.com/hashicorp/terraform-plugin-testing v1.5.1 h1:T4aQh9JAhmWo4+t1A7x+rnxAJHCDIYW9kXyo4sVO92c= +github.com/hashicorp/terraform-plugin-testing v1.5.1/go.mod h1:dg8clO6K59rZ8w9EshBmDp1CxTIPu3yA4iaDpX1h5u0= +github.com/hashicorp/terraform-registry-address v0.2.2 h1:lPQBg403El8PPicg/qONZJDC6YlgCVbWDtNmmZKtBno= +github.com/hashicorp/terraform-registry-address v0.2.2/go.mod h1:LtwNbCihUoUZ3RYriyS2wF/lGPB6gF9ICLRtuDk7hSo= github.com/hashicorp/terraform-svchost v0.1.1 h1:EZZimZ1GxdqFRinZ1tpJwVxxt49xc/S52uzrw4x0jKQ= github.com/hashicorp/terraform-svchost v0.1.1/go.mod h1:mNsjQfZyf/Jhz35v6/0LWcv26+X7JPS+buii2c9/ctc= github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d h1:kJCB4vdITiW1eC1vq2e6IsrXKrZit1bv/TDYFGMp4BQ= github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM= github.com/huandu/xstrings v1.3.1/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE= +github.com/huandu/xstrings v1.3.2 h1:L18LIDzqlW6xN2rEkpdV8+oL/IXWJ1APd+vsdYy4Wdw= github.com/huandu/xstrings v1.3.2/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE= -github.com/huandu/xstrings v1.3.3/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE= -github.com/huandu/xstrings v1.4.0 h1:D17IlohoQq4UcpqD7fDk80P7l+lwAmlFaBHgOipl2FU= -github.com/huandu/xstrings v1.4.0/go.mod h1:y5/lhBue+AyNmUVz9RLU9xbLR0o4KIIExikq4ovT0aE= github.com/imdario/mergo v0.3.11/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA= -github.com/imdario/mergo v0.3.13 h1:lFzP57bqS/wsqKssCGmtLAb8A0wKjLGrve2q3PPVcBk= -github.com/imdario/mergo v0.3.13/go.mod h1:4lJ1jqUDcsbIECGy0RUJAXNIhg+6ocWgb1ALK2O4oXg= +github.com/imdario/mergo v0.3.15 h1:M8XP7IuFNsqUx6VPK2P9OSmsYsI/YFaGil0uD21V3dM= +github.com/imdario/mergo v0.3.15/go.mod h1:WBLT9ZmE3lPoWsEzCh9LPo3TiwVN+ZKEjmz+hD27ysY= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A= -github.com/jhump/protoreflect v1.6.0 h1:h5jfMVslIg6l29nsMs0D8Wj17RDVdNYti0vDN/PZZoE= +github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo= +github.com/jhump/protoreflect v1.15.1 h1:HUMERORf3I3ZdX05WaQ6MIpd/NJ434hTp5YiKgfCL6c= +github.com/jhump/protoreflect v1.15.1/go.mod h1:jD/2GMKKE6OqX8qTjhADU1e6DShO+gavG9e0Q693nKo= github.com/kevinburke/ssh_config v1.2.0 h1:x584FjTGwHzMwvHx18PXxbBVzfnxogHaAReU4gf13a4= +github.com/kevinburke/ssh_config v1.2.0/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM= github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/klauspost/compress v1.16.0 h1:iULayQNOReoYUe+1qtKOqw9CwJv3aNQu8ivo7lw1HU4= github.com/klauspost/compress v1.16.0/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= -github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0= +github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= +github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 h1:6E+4a0GO5zZEnZ81pIr0yLvtUWk2if982qA3F3QD6H4= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0/go.mod h1:zJYVVT2jmtg6P3p1VtQj7WsuWi/y4VnjVBn7F8KPB3I= github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY= @@ -180,9 +199,8 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4= github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= +github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= -github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= -github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mitchellh/cli v1.1.5 h1:OxRIeJXpAMztws/XHlN2vu6imG5Dpq+j61AzAX5fLng= github.com/mitchellh/cli v1.1.5/go.mod h1:v8+iFts2sPIKUV1ltktPXMCC8fumSKFItNcD2cLtRR4= github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw= @@ -197,8 +215,8 @@ github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RR github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ= github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= -github.com/moby/patternmatcher v0.5.0 h1:YCZgJOeULcxLw1Q+sVR636pmS7sPEn1Qo2iAN6M7DBo= -github.com/moby/patternmatcher v0.5.0/go.mod h1:hDPoyOpDY7OrrMDLaYoY3hf52gNCR/YOUYxkhApJIxc= +github.com/moby/patternmatcher v0.6.0 h1:GmP9lR19aU5GqSSFko+5pRqHi+Ohk1O69aFiKkVGiPk= +github.com/moby/patternmatcher v0.6.0/go.mod h1:hDPoyOpDY7OrrMDLaYoY3hf52gNCR/YOUYxkhApJIxc= github.com/moby/sys/mountinfo v0.5.0/go.mod h1:3bMD3Rg+zkqx8MRYPi7Pyb0Ie97QEBmdxbhnCLlSvSU= github.com/moby/sys/sequential v0.5.0 h1:OPvI35Lzn9K04PBbCLW0g4LcFAJgHsvXsRyewg5lXtc= github.com/moby/sys/sequential v0.5.0/go.mod h1:tH2cOOs5V9MlPiXcQzRC+eEyab644PWKGRYaaV5ZZlo= @@ -211,13 +229,14 @@ github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw= github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA= github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U= github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM= -github.com/opencontainers/image-spec v1.1.0-rc4 h1:oOxKUJWnFC4YGHCCMNql1x4YaDfYBTS5Y4x/Cgeo1E0= -github.com/opencontainers/image-spec v1.1.0-rc4/go.mod h1:X4pATf0uXsnn3g5aiGIsVnJBR4mxhKzfwmvK/B2NTm8= +github.com/opencontainers/image-spec v1.1.0-rc5 h1:Ygwkfw9bpDvs+c9E34SdgGOj41dX/cbdlwvlWt0pnFI= +github.com/opencontainers/image-spec v1.1.0-rc5/go.mod h1:X4pATf0uXsnn3g5aiGIsVnJBR4mxhKzfwmvK/B2NTm8= github.com/opencontainers/runc v1.1.5 h1:L44KXEpKmfWDcS02aeGm8QNTFXTo2D+8MYGDIJ/GDEs= github.com/opencontainers/runc v1.1.5/go.mod h1:1J5XiS+vdZ3wCyZybsuxXZWGrgSr8fFJHLXuG2PsnNg= github.com/opencontainers/runtime-spec v1.0.3-0.20210326190908-1c3f411f0417/go.mod h1:jwyrGlmzljRJv/Fgzds9SsS/C5hL+LL3ko9hs6T5lQ0= github.com/opencontainers/selinux v1.10.0/go.mod h1:2i0OySw99QjzBBQByd1Gr9gSjvuho1lHsJxIJ3gGbJI= github.com/pjbgf/sha1cd v0.3.0 h1:4D5XXmUUBUl/xQ6IjCkEAbqXskkq/4O7LmGn0AqMDs4= +github.com/pjbgf/sha1cd v0.3.0/go.mod h1:nZ1rrWOcGJ5uZgEEVL1VUM9iRQiZvWdbZjkKyFzPPsI= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= @@ -227,15 +246,17 @@ github.com/posener/complete v1.2.3 h1:NP0eAhjcjImqslEwo/1hq7gpajME0fTLTezBKDqfXq github.com/posener/complete v1.2.3/go.mod h1:WZIdtGGp+qx0sLrYKtIRAruyNpv6hFCicSgv7Sy7s/s= github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c h1:ncq/mPwQF4JjgDlrVEn3C11VoGHZN7m8qihwgMEtzYw= github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c/go.mod h1:OmDBASR4679mdNQnz2pUhc2G8CO2JrUAVFDRBDP/hJE= -github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8= +github.com/rogpeppe/go-internal v1.8.1 h1:geMPLpDpQOgVyCg5z5GoRwLHepNdb71NXb67XFkP+Eg= +github.com/rogpeppe/go-internal v1.8.1/go.mod h1:JeRgkft04UBgHMgCIwADu4Pn6Mtm5d4nPKWu0nJ5d+o= github.com/russross/blackfriday v1.6.0 h1:KqfZb0pUVN2lYqZUYRddxF4OR8ZMURnJIG5Y3VRLtww= github.com/russross/blackfriday v1.6.0/go.mod h1:ti0ldHuxg49ri4ksnFxlkCfN+hvslNlmVHqNRXXJNAY= github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/seccomp/libseccomp-golang v0.9.2-0.20220502022130-f33da4d89646/go.mod h1:JA8cRccbGaA1s33RQf7Y1+q9gHmZX1yB/z9WDN1C6fg= github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ= -github.com/shirou/gopsutil/v3 v3.23.7 h1:C+fHO8hfIppoJ1WdsVm1RoI0RwXoNdfTK7yWXV0wVj4= -github.com/shirou/gopsutil/v3 v3.23.7/go.mod h1:c4gnmoRC0hQuaLqvxnx1//VXQ0Ms/X9UnJF8pddY5z4= +github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= +github.com/shirou/gopsutil/v3 v3.23.9 h1:ZI5bWVeu2ep4/DIxB4U9okeYJ7zp/QLTO4auRb/ty/E= +github.com/shirou/gopsutil/v3 v3.23.9/go.mod h1:x/NWSb71eMcjFIO0vhyGW5nZ7oSIgVjrCnADckb85GA= github.com/shoenig/go-m1cpu v0.1.6 h1:nxdKQNcEB6vzgA2E2bvzKIYRuNj7XNJ4S/aRSwKzFtM= github.com/shoenig/go-m1cpu v0.1.6/go.mod h1:1JJMcUBvfNwpq05QDQVAnx3gUHr9IYF7GNg9SUEw2VQ= github.com/shoenig/test v0.6.4 h1:kVTaSd7WLz5WZ2IaoM0RSzRsUD+m8wRR+5qvntpn4LU= @@ -245,14 +266,15 @@ github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5g github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= -github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0= -github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= -github.com/skeema/knownhosts v1.1.0 h1:Wvr9V0MxhjRbl3f9nMnKnFfiWTJmtECJ9Njkea3ysW0= +github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= +github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/skeema/knownhosts v1.2.0 h1:h9r9cf0+u7wSE+M183ZtMGgOJKiL96brpaz5ekfJCpM= +github.com/skeema/knownhosts v1.2.0/go.mod h1:g4fPeYpque7P0xefxtGzV81ihjC8sX2IqpAoNkjxbMo= github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= -github.com/spf13/cast v1.5.1 h1:R+kOtfhWQE6TVQzY+4D7wJLBgkdVasCEFxSUBYBYIlA= -github.com/spf13/cast v1.5.1/go.mod h1:b9PdjNptOpzXr7Rq1q9gJML/2cdGQAo69NKzQ10KN48= -github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I= -github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0= +github.com/spf13/cast v1.5.0 h1:rj3WzYc11XZaIZMPKmwP96zkFEnnAmV8s6XbB2aY32w= +github.com/spf13/cast v1.5.0/go.mod h1:SpXXQ5YoyJw6s3/6cMTQuxvgRl3PCJiyaX9p6b155UU= +github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= +github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= @@ -269,12 +291,12 @@ github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/syndtr/gocapability v0.0.0-20200815063812-42c35b437635/go.mod h1:hkRG7XYTFWNJGYcbNJQlaLq0fg1yr4J4t/NcTQtrfww= -github.com/testcontainers/testcontainers-go v0.24.1 h1:gJdZuQIVWnMJTo+CmQMEP7/CAagNk/0jbcUPn3OWvD8= -github.com/testcontainers/testcontainers-go v0.24.1/go.mod h1:MGBiAkCm86yXQoCiipmQCqZLVdk1uFqtMqaU1Or0MRk= -github.com/tklauser/go-sysconf v0.3.11 h1:89WgdJhk5SNwJfu+GKyYveZ4IaJ7xAkecBo+KdJV0CM= -github.com/tklauser/go-sysconf v0.3.11/go.mod h1:GqXfhXY3kiPa0nAXPDIQIWzJbMCB7AmcWpGR8lSZfqI= -github.com/tklauser/numcpus v0.6.0 h1:kebhY2Qt+3U6RNK7UqpYNA+tJ23IBEGKkB7JQBfDYms= -github.com/tklauser/numcpus v0.6.0/go.mod h1:FEZLMke0lhOUG6w2JadTzp0a+Nl8PF/GFkQ5UVIcaL4= +github.com/testcontainers/testcontainers-go v0.26.0 h1:uqcYdoOHBy1ca7gKODfBd9uTHVK3a7UL848z09MVZ0c= +github.com/testcontainers/testcontainers-go v0.26.0/go.mod h1:ICriE9bLX5CLxL9OFQ2N+2N+f+803LNJ1utJb1+Inx0= +github.com/tklauser/go-sysconf v0.3.12 h1:0QaGUFOdQaIVdPgfITYzaTegZvdCjmYO52cSFAEVmqU= +github.com/tklauser/go-sysconf v0.3.12/go.mod h1:Ho14jnntGE1fpdOqQEEaiKRpvIavV0hSfmBq8nJbHYI= +github.com/tklauser/numcpus v0.6.1 h1:ng9scYS7az0Bk4OZLvrNXNSAO2Pxr1XXRAPyjhIx+Fk= +github.com/tklauser/numcpus v0.6.1/go.mod h1:1XfjsgE2zo8GVw7POkMbHENHzVg3GzmoZ9fESEdAacY= github.com/urfave/cli v1.22.1/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0= github.com/vishvananda/netlink v1.1.0/go.mod h1:cTgwzPIzzgDAYoQrMm0EdrjRUBkTqKYppBueQtXaqoE= github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df/go.mod h1:JP3t17pCcGlemwknint6hfoeCVQrEMVwxRLRjXpq+BU= @@ -286,29 +308,32 @@ github.com/vmihailenco/msgpack/v5 v5.3.5/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g= github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds= github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM= +github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw= github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/yusufpapurcu/wmi v1.2.3 h1:E1ctvB7uKFMOJw3fdOW32DwGE9I7t++CRUEMKvFoFiw= github.com/yusufpapurcu/wmi v1.2.3/go.mod h1:SBZ9tNy3G9/m5Oi98Zks0QjeHVDvuK0qfxQmPyzfmi0= -github.com/zclconf/go-cty v1.13.2 h1:4GvrUxe/QUDYuJKAav4EYqdM47/kZa672LwmXFmEKT0= -github.com/zclconf/go-cty v1.13.2/go.mod h1:YKQzy/7pZ7iq2jNFzy5go57xdxdWoLLpaEp4u238AE0= +github.com/zclconf/go-cty v1.14.0 h1:/Xrd39K7DXbHzlisFP9c4pHao4yyf+/Ug9LEz+Y/yhc= +github.com/zclconf/go-cty v1.14.0/go.mod h1:VvMs5i0vgZdhYawQNq5kePSpLAoz8u1xvZgrPIxfnZE= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20200414173820-0848c9571904/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -golang.org/x/crypto v0.3.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= -golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA= -golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio= -golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb h1:mIKbk8weKhSeLH2GmUTrvx8CjkyJmnU1wFmg59CUjFA= -golang.org/x/exp v0.0.0-20230811145659-89c5cff77bcb/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc= +golang.org/x/crypto v0.3.1-0.20221117191849-2c476679df9a/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= +golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU= +golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc= +golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo= golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.11.0 h1:bUO06HqtnRcc/7l71XBe4WcqTZ+3AH1J59zWDDwLKgU= -golang.org/x/mod v0.11.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.13.0 h1:I/DsJXRlw/8l/0c24sM9yb0T4z9liZTduXvdAWYiysY= +golang.org/x/mod v0.13.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -318,14 +343,18 @@ golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= -golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50= -golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= +golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= +golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.4.0 h1:zxkM55ReGkDlKSM+Fu41A+zmbZuaPVbGMzvvdUPznYQ= +golang.org/x/sync v0.4.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190606203320-7fc4e5ec1444/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -343,7 +372,6 @@ golang.org/x/sys v0.0.0-20210616094352-59db8d763f22/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210906170528-6f6e22806c34/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20211007075335-d3039528d8ac/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211116061358-0a5406a5449c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -352,28 +380,38 @@ golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE= +golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4= -golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4= +golang.org/x/time v0.3.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.7.0 h1:W4OVu8VVOaIO0yzWMNdepAulS7YfoS3Zabrm8DOXXU4= -golang.org/x/tools v0.7.0/go.mod h1:4pg6aUX35JBAogB10C9AtvVL+qowtN4pT3CGSQex14s= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.14.0 h1:jvNa2pY0M4r62jkRQ6RwEZZyPcymeL9XZMLBbV7U2nc= +golang.org/x/tools v0.14.0/go.mod h1:uYBEerGOWcJyEORxN+Ek8+TT266gXkNlHdJBwexUsBg= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -383,8 +421,8 @@ google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6 google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19 h1:0nDDozoAU19Qb2HwhXadU8OcsiO/09cnTqhUtq2MEOM= google.golang.org/genproto/googleapis/rpc v0.0.0-20230525234030-28d5490b6b19/go.mod h1:66JfowdXAEgad5O9NnYcsNPLCPZJD++2L9X0PCMODrA= -google.golang.org/grpc v1.57.0 h1:kfzNeI/klCGD2YPMUlaGNT3pxvYfga7smW3Vth8Zsiw= -google.golang.org/grpc v1.57.0/go.mod h1:Sd+9RMTACXwmub0zcNY2c4arhtrbBYD1AUHI/dt16Mo= +google.golang.org/grpc v1.57.1 h1:upNTNqv0ES+2ZOOqACwVtS3Il8M12/+Hz41RCPzAjQg= +google.golang.org/grpc v1.57.1/go.mod h1:Sd+9RMTACXwmub0zcNY2c4arhtrbBYD1AUHI/dt16Mo= google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= google.golang.org/protobuf v1.27.1/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= @@ -393,11 +431,13 @@ google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqw gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= +gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gotest.tools/v3 v3.5.0 h1:Ljk6PdHdOhAb5aDMWXjDLMMhph+BpztA4v1QdqEW2eY= +gotest.tools/v3 v3.5.0/go.mod h1:isy3WKz7GK6uNw/sbHzfKBLvlvXwUyV06n6brMxxopU= diff --git a/internal/broker/conversions.go b/internal/broker/conversions.go index b1fe9a0d..17956bc1 100644 --- a/internal/broker/conversions.go +++ b/internal/broker/conversions.go @@ -136,9 +136,6 @@ func (c *ObjectConverter) FromTerraform(v tftypes.Value) (any, error) { return nil, err } for _, attr := range c.attributes { - if attr.TerraformName == "id" { - continue - } v, ok := tfAttributes[attr.TerraformName] if ok && v.IsKnown() && !v.IsNull() { v, err := attr.Converter.FromTerraform(v) diff --git a/internal/broker/datasource.go b/internal/broker/datasource.go index 39d0bd33..f37c5965 100644 --- a/internal/broker/datasource.go +++ b/internal/broker/datasource.go @@ -24,8 +24,6 @@ import ( "github.com/hashicorp/terraform-plugin-framework/datasource" "github.com/hashicorp/terraform-plugin-framework/datasource/schema" - "github.com/hashicorp/terraform-plugin-framework/diag" - "github.com/hashicorp/terraform-plugin-log/tflog" "terraform-provider-solacebroker/internal/semp" ) @@ -64,22 +62,22 @@ func (ds *brokerDataSource) Configure(_ context.Context, request datasource.Conf if request.ProviderData == nil { return } - config, ok := request.ProviderData.(*providerData) + client, ok := request.ProviderData.(*semp.Client) if !ok { - d := diag.NewErrorDiagnostic("Unexpected datasource configuration", fmt.Sprintf("Unexpected type %T for provider data; expected %T.", request.ProviderData, config)) - response.Diagnostics.Append(d) + response.Diagnostics.AddError( + "Unexpected datasource configuration", + fmt.Sprintf("Unexpected type %T for provider data; expected %T.", request.ProviderData, client), + ) return } - ds.providerData = config + ds.client = client } func (ds *brokerDataSource) Read(ctx context.Context, request datasource.ReadRequest, response *datasource.ReadResponse) { - client, d := client(ds.providerData) - if d != nil { - response.Diagnostics.Append(d) - if response.Diagnostics.HasError() { - return - } + client := ds.client + if err := checkBrokerRequirements(ctx, client); err != nil { + addErrorToDiagnostics(&response.Diagnostics, "Broker check failed", err) + return } sempPath, err := resolveSempPath(ds.pathTemplate, ds.identifyingAttributes, request.Config.Raw) if err != nil { @@ -89,15 +87,12 @@ func (ds *brokerDataSource) Read(ctx context.Context, request datasource.ReadReq sempData, err := client.RequestWithoutBody(ctx, http.MethodGet, sempPath) if err != nil { if errors.Is(err, semp.ErrResourceNotFound) { - tflog.Info(ctx, fmt.Sprintf("Detected missing resource %v, removing from state", sempPath)) - response.State.RemoveResource(ctx) - } else if err == semp.ErrAPIUnreachable { - addErrorToDiagnostics(&response.Diagnostics, fmt.Sprintf("SEMP call failed. HOST not reachable. %v", sempPath), err) + addErrorToDiagnostics(&response.Diagnostics, fmt.Sprintf("Detected missing data source %v", sempPath), errors.Unwrap(err)) } else { addErrorToDiagnostics(&response.Diagnostics, "SEMP call failed", err) } + return } - sempData["id"] = toId(sempPath) responseData, err := ds.converter.ToTerraform(sempData) if err != nil { addErrorToDiagnostics(&response.Diagnostics, "SEMP response conversion failed", err) diff --git a/internal/broker/entity.go b/internal/broker/entity.go index 9d8e930f..a6e920ec 100644 --- a/internal/broker/entity.go +++ b/internal/broker/entity.go @@ -18,9 +18,11 @@ package broker import ( "fmt" + "reflect" + "terraform-provider-solacebroker/internal/semp" + dschema "github.com/hashicorp/terraform-plugin-framework/datasource/schema" rschema "github.com/hashicorp/terraform-plugin-framework/resource/schema" - "reflect" ) var resourceToDataSourceTypes = map[reflect.Type]reflect.Type{ @@ -43,7 +45,7 @@ type brokerEntityBase struct { identifyingAttributes []*AttributeInfo attributes []*AttributeInfo converter *ObjectConverter - providerData *providerData + client *semp.Client } func copyMatchingFields(prefix string, in reflect.Value, out reflect.Value) { diff --git a/internal/broker/generated/AboutApi.go b/internal/broker/generated/AboutApi.go index db296b63..30902a4e 100644 --- a/internal/broker/generated/AboutApi.go +++ b/internal/broker/generated/AboutApi.go @@ -32,15 +32,6 @@ func init() { PathTemplate: "/about/api", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "platform", diff --git a/internal/broker/generated/AboutUser.go b/internal/broker/generated/AboutUser.go index 4c6683c3..608b6b5c 100644 --- a/internal/broker/generated/AboutUser.go +++ b/internal/broker/generated/AboutUser.go @@ -33,15 +33,6 @@ func init() { PathTemplate: "/about/user", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "globalAccessLevel", diff --git a/internal/broker/generated/AboutUserMsgVpn.go b/internal/broker/generated/AboutUserMsgVpn.go index 8a0a6116..f62ebe7a 100644 --- a/internal/broker/generated/AboutUserMsgVpn.go +++ b/internal/broker/generated/AboutUserMsgVpn.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "about_user_msg_vpn", - MarkdownDescription: "This provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "This provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.DataSourceObject, PathTemplate: "/about/user/msgVpns/{msgVpnName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessLevel", diff --git a/internal/broker/generated/Broker.go b/internal/broker/generated/Broker.go index 818d1a75..314ac2dc 100644 --- a/internal/broker/generated/Broker.go +++ b/internal/broker/generated/Broker.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "broker", - MarkdownDescription: "This object contains global configuration for the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ntls_server_cert_content||x||x\ntls_server_cert_password||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation. Requests which include the following attributes require greater access scope/level:\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauth_client_cert_revocation_check_mode|global/read-only\nconfig_sync_authentication_client_cert_max_chain_depth|global/read-only\nconfig_sync_authentication_client_cert_validate_date_enabled|global/read-only\nconfig_sync_client_profile_tcp_initial_congestion_window|global/read-only\nconfig_sync_client_profile_tcp_keepalive_count|global/read-only\nconfig_sync_client_profile_tcp_keepalive_idle|global/read-only\nconfig_sync_client_profile_tcp_keepalive_interval|global/read-only\nconfig_sync_client_profile_tcp_max_window|global/read-only\nconfig_sync_client_profile_tcp_mss|global/read-only\nconfig_sync_enabled|global/read-only\nconfig_sync_synchronize_username_enabled|global/read-only\nconfig_sync_tls_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_day_list|global/read-only\nguaranteed_msging_defragmentation_schedule_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_time_list|global/read-only\nguaranteed_msging_defragmentation_threshold_enabled|global/read-only\nguaranteed_msging_defragmentation_threshold_fragmentation_percentage|global/read-only\nguaranteed_msging_defragmentation_threshold_min_interval|global/read-only\nguaranteed_msging_defragmentation_threshold_usage_percentage|global/read-only\nguaranteed_msging_enabled|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.clear_percent|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.set_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_msg_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_value|global/read-only\nguaranteed_msging_max_cache_usage|global/read-only\nguaranteed_msging_max_msg_spool_usage|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_msg_ack_timeout|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_spool_file_ack_timeout|global/read-only\nguaranteed_msging_transaction_replication_compatibility_mode|global/read-only\noauth_profile_default|global/read-only\nservice_amqp_enabled|global/read-only\nservice_amqp_tls_listen_port|global/read-only\nservice_event_connection_count_threshold.clear_percent|global/read-only\nservice_event_connection_count_threshold.clear_value|global/read-only\nservice_event_connection_count_threshold.set_percent|global/read-only\nservice_event_connection_count_threshold.set_value|global/read-only\nservice_health_check_enabled|global/read-only\nservice_health_check_listen_port|global/read-only\nservice_health_check_tls_enabled|global/read-only\nservice_health_check_tls_listen_port|global/read-only\nservice_mate_link_enabled|global/read-only\nservice_mate_link_listen_port|global/read-only\nservice_mqtt_enabled|global/read-only\nservice_msg_backbone_enabled|global/read-only\nservice_redundancy_enabled|global/read-only\nservice_redundancy_first_listen_port|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_value|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_value|global/read-only\nservice_rest_incoming_enabled|global/read-only\nservice_rest_outgoing_enabled|global/read-only\nservice_semp_cors_allow_any_host_enabled|global/read-only\nservice_semp_legacy_timeout_enabled|global/read-only\nservice_semp_plain_text_enabled|global/read-only\nservice_semp_plain_text_listen_port|global/read-only\nservice_semp_session_idle_timeout|global/read-only\nservice_semp_session_max_lifetime|global/read-only\nservice_semp_tls_enabled|global/read-only\nservice_semp_tls_listen_port|global/read-only\nservice_smf_compression_listen_port|global/read-only\nservice_smf_enabled|global/read-only\nservice_smf_event_connection_count_threshold.clear_percent|global/read-only\nservice_smf_event_connection_count_threshold.clear_value|global/read-only\nservice_smf_event_connection_count_threshold.set_percent|global/read-only\nservice_smf_event_connection_count_threshold.set_value|global/read-only\nservice_smf_plain_text_listen_port|global/read-only\nservice_smf_routing_control_listen_port|global/read-only\nservice_smf_tls_listen_port|global/read-only\nservice_tls_event_connection_count_threshold.clear_percent|global/read-only\nservice_tls_event_connection_count_threshold.clear_value|global/read-only\nservice_tls_event_connection_count_threshold.set_percent|global/read-only\nservice_tls_event_connection_count_threshold.set_value|global/read-only\nservice_web_transport_enabled|global/read-only\nservice_web_transport_plain_text_listen_port|global/read-only\nservice_web_transport_tls_listen_port|global/read-only\nservice_web_transport_web_url_suffix|global/read-only\ntls_block_version11_enabled|global/read-only\ntls_cipher_suite_management_list|global/read-only\ntls_cipher_suite_msg_backbone_list|global/read-only\ntls_cipher_suite_secure_shell_list|global/read-only\ntls_crime_exploit_protection_enabled|global/read-only\ntls_server_cert_content|global/read-only\ntls_standard_domain_certificate_authorities_enabled|vpn/read-only\ntls_ticket_lifetime|global/read-only\nweb_manager_allow_unencrypted_wizards_enabled|vpn/read-only\nweb_manager_customization|vpn/read-only\nweb_manager_redirect_http_enabled|vpn/read-only\nweb_manager_redirect_http_override_tls_port|vpn/read-only\n\n\n\nThis has been available since SEMP API version 2.13.", + MarkdownDescription: "This object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Opaque\n:---|:---:|:---:\ntls_server_cert_content|x|x\ntls_server_cert_password|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauth_client_cert_revocation_check_mode|global/read-only\nconfig_sync_authentication_client_cert_max_chain_depth|global/read-only\nconfig_sync_authentication_client_cert_validate_date_enabled|global/read-only\nconfig_sync_client_profile_tcp_initial_congestion_window|global/read-only\nconfig_sync_client_profile_tcp_keepalive_count|global/read-only\nconfig_sync_client_profile_tcp_keepalive_idle|global/read-only\nconfig_sync_client_profile_tcp_keepalive_interval|global/read-only\nconfig_sync_client_profile_tcp_max_window|global/read-only\nconfig_sync_client_profile_tcp_mss|global/read-only\nconfig_sync_enabled|global/read-only\nconfig_sync_synchronize_username_enabled|global/read-only\nconfig_sync_tls_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_day_list|global/read-only\nguaranteed_msging_defragmentation_schedule_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_time_list|global/read-only\nguaranteed_msging_defragmentation_threshold_enabled|global/read-only\nguaranteed_msging_defragmentation_threshold_fragmentation_percentage|global/read-only\nguaranteed_msging_defragmentation_threshold_min_interval|global/read-only\nguaranteed_msging_defragmentation_threshold_usage_percentage|global/read-only\nguaranteed_msging_enabled|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.clear_percent|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.set_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_msg_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_value|global/read-only\nguaranteed_msging_max_cache_usage|global/read-only\nguaranteed_msging_max_msg_spool_usage|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_msg_ack_timeout|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_spool_file_ack_timeout|global/read-only\nguaranteed_msging_transaction_replication_compatibility_mode|global/read-only\noauth_profile_default|global/read-only\nservice_amqp_enabled|global/read-only\nservice_amqp_tls_listen_port|global/read-only\nservice_event_connection_count_threshold.clear_percent|global/read-only\nservice_event_connection_count_threshold.clear_value|global/read-only\nservice_event_connection_count_threshold.set_percent|global/read-only\nservice_event_connection_count_threshold.set_value|global/read-only\nservice_health_check_enabled|global/read-only\nservice_health_check_listen_port|global/read-only\nservice_health_check_tls_enabled|global/read-only\nservice_health_check_tls_listen_port|global/read-only\nservice_mate_link_enabled|global/read-only\nservice_mate_link_listen_port|global/read-only\nservice_mqtt_enabled|global/read-only\nservice_msg_backbone_enabled|global/read-only\nservice_redundancy_enabled|global/read-only\nservice_redundancy_first_listen_port|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_value|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_value|global/read-only\nservice_rest_incoming_enabled|global/read-only\nservice_rest_outgoing_enabled|global/read-only\nservice_semp_cors_allow_any_host_enabled|global/read-only\nservice_semp_legacy_timeout_enabled|global/read-only\nservice_semp_plain_text_enabled|global/read-only\nservice_semp_plain_text_listen_port|global/read-only\nservice_semp_session_idle_timeout|global/read-only\nservice_semp_session_max_lifetime|global/read-only\nservice_semp_tls_enabled|global/read-only\nservice_semp_tls_listen_port|global/read-only\nservice_smf_compression_listen_port|global/read-only\nservice_smf_enabled|global/read-only\nservice_smf_event_connection_count_threshold.clear_percent|global/read-only\nservice_smf_event_connection_count_threshold.clear_value|global/read-only\nservice_smf_event_connection_count_threshold.set_percent|global/read-only\nservice_smf_event_connection_count_threshold.set_value|global/read-only\nservice_smf_plain_text_listen_port|global/read-only\nservice_smf_routing_control_listen_port|global/read-only\nservice_smf_tls_listen_port|global/read-only\nservice_tls_event_connection_count_threshold.clear_percent|global/read-only\nservice_tls_event_connection_count_threshold.clear_value|global/read-only\nservice_tls_event_connection_count_threshold.set_percent|global/read-only\nservice_tls_event_connection_count_threshold.set_value|global/read-only\nservice_web_transport_enabled|global/read-only\nservice_web_transport_plain_text_listen_port|global/read-only\nservice_web_transport_tls_listen_port|global/read-only\nservice_web_transport_web_url_suffix|global/read-only\ntls_block_version11_enabled|global/read-only\ntls_cipher_suite_management_list|global/read-only\ntls_cipher_suite_msg_backbone_list|global/read-only\ntls_cipher_suite_secure_shell_list|global/read-only\ntls_crime_exploit_protection_enabled|global/read-only\ntls_server_cert_content|global/read-only\ntls_ticket_lifetime|global/read-only\n\n\n\nThis has been available since SEMP API version 2.13.", ObjectType: broker.SingletonObject, PathTemplate: "/", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authClientCertRevocationCheckMode", diff --git a/internal/broker/generated/ClientCertAuthority.go b/internal/broker/generated/ClientCertAuthority.go index 53c159ed..c5668e5e 100644 --- a/internal/broker/generated/ClientCertAuthority.go +++ b/internal/broker/generated/ClientCertAuthority.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "client_cert_authority", - MarkdownDescription: "Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncert_authority_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", + MarkdownDescription: "Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncert_authority_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", ObjectType: broker.StandardObject, PathTemplate: "/clientCertAuthorities/{certAuthorityName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "certAuthorityName", diff --git a/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go b/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go index c60db350..7c85b079 100644 --- a/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go +++ b/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "client_cert_authority_ocsp_tls_trusted_common_name", - MarkdownDescription: "When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncert_authority_name|x|||\nocsp_tls_trusted_common_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", + MarkdownDescription: "When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncert_authority_name|x\nocsp_tls_trusted_common_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", PostPathTemplate: "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "certAuthorityName", diff --git a/internal/broker/generated/DmrCluster.go b/internal/broker/generated/DmrCluster.go index f7512b65..d78000d0 100644 --- a/internal/broker/generated/DmrCluster.go +++ b/internal/broker/generated/DmrCluster.go @@ -35,15 +35,6 @@ func init() { PathTemplate: "/dmrClusters/{dmrClusterName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "authenticationBasicEnabled", diff --git a/internal/broker/generated/DmrClusterCertMatchingRule.go b/internal/broker/generated/DmrClusterCertMatchingRule.go index ba5e28cb..d8d63d4f 100644 --- a/internal/broker/generated/DmrClusterCertMatchingRule.go +++ b/internal/broker/generated/DmrClusterCertMatchingRule.go @@ -27,20 +27,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_cert_matching_rule", - MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmr_cluster_name|x|||\nrule_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.StandardObject, PathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "dmrClusterName", diff --git a/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go b/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go index 97deb6ac..64940654 100644 --- a/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go +++ b/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_cert_matching_rule_attribute_filter", - MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmr_cluster_name|x|||\nfilter_name|x|||\nrule_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nfilter_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.StandardObject, PathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "attributeName", diff --git a/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go b/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go index 534cdfa0..c9cc58a4 100644 --- a/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go +++ b/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_cert_matching_rule_condition", - MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmr_cluster_name|x|||\nrule_name|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nrule_name|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}", PostPathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "attribute", diff --git a/internal/broker/generated/DmrClusterLink.go b/internal/broker/generated/DmrClusterLink.go index ce5c232a..1a45150d 100644 --- a/internal/broker/generated/DmrClusterLink.go +++ b/internal/broker/generated/DmrClusterLink.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_link", - MarkdownDescription: "A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthentication_basic_password||x||x\ndmr_cluster_name|x|||\nremote_node_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\ndmr_cluster_name|x||\nremote_node_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authenticationBasicPassword", @@ -192,7 +183,7 @@ func init() { BaseType: broker.Int64, SempName: "clientProfileQueueGuaranteed1MinMsgBurst", TerraformName: "client_profile_queue_guaranteed1_min_msg_burst", - MarkdownDescription: "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `client_profile_queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", + MarkdownDescription: "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-1) priority queue, regardless of the `client_profile_queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, diff --git a/internal/broker/generated/DmrClusterLinkAttribute.go b/internal/broker/generated/DmrClusterLinkAttribute.go index 00da7300..0d6a22fb 100644 --- a/internal/broker/generated/DmrClusterLinkAttribute.go +++ b/internal/broker/generated/DmrClusterLinkAttribute.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_link_attribute", - MarkdownDescription: "A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattribute_name|x|||\nattribute_value|x|||\ndmr_cluster_name|x|||\nremote_node_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattribute_name|x\nattribute_value|x\ndmr_cluster_name|x\nremote_node_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}", PostPathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "attributeName", diff --git a/internal/broker/generated/DmrClusterLinkRemoteAddress.go b/internal/broker/generated/DmrClusterLinkRemoteAddress.go index c4549130..fdef44e3 100644 --- a/internal/broker/generated/DmrClusterLinkRemoteAddress.go +++ b/internal/broker/generated/DmrClusterLinkRemoteAddress.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_link_remote_address", - MarkdownDescription: "Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ndmr_cluster_name|x|||\nremote_address|x|||\nremote_node_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nremote_address|x\nremote_node_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}", PostPathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "dmrClusterName", diff --git a/internal/broker/generated/DomainCertAuthority.go b/internal/broker/generated/DomainCertAuthority.go index 6f65d071..524b21d8 100644 --- a/internal/broker/generated/DomainCertAuthority.go +++ b/internal/broker/generated/DomainCertAuthority.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "domain_cert_authority", - MarkdownDescription: "Certificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncert_authority_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", + MarkdownDescription: "Certificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncert_authority_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", ObjectType: broker.StandardObject, PathTemplate: "/domainCertAuthorities/{certAuthorityName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "certAuthorityName", diff --git a/internal/broker/generated/MsgVpn.go b/internal/broker/generated/MsgVpn.go index c627ba4a..cc6a6cd1 100644 --- a/internal/broker/generated/MsgVpn.go +++ b/internal/broker/generated/MsgVpn.go @@ -36,20 +36,11 @@ func init() { PathTemplate: "/msgVpns/{msgVpnName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "alias", TerraformName: "alias", - MarkdownDescription: "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\nAliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since SEMP API version 2.14.", + MarkdownDescription: "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\nAliases may form a non-circular chain, cascading one to the next.\n\nChanges to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since SEMP API version 2.14.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -1810,6 +1801,18 @@ func init() { }, Default: 1000, }, + { + BaseType: broker.Int64, + SempName: "maxKafkaBrokerConnectionCount", + TerraformName: "max_kafka_broker_connection_count", + MarkdownDescription: "The maximum number of simultaneous Kafka broker connections of the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since SEMP API version 2.39.", + Type: types.Int64Type, + TerraformType: tftypes.Number, + Converter: broker.IntegerConverter{}, + Int64Validators: []validator.Int64{ + int64validator.Between(0, 10000), + }, + }, { BaseType: broker.Int64, SempName: "maxMsgSpoolUsage", @@ -2404,7 +2407,7 @@ func init() { BaseType: broker.String, SempName: "serviceRestIncomingAuthorizationHeaderHandling", TerraformName: "service_rest_incoming_authorization_header_handling", - MarkdownDescription: "The handling of Authorization headers for incoming REST connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are:\n\n
\n\"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.\n\"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n\"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n
\n Available since SEMP API version 2.19.", + MarkdownDescription: "The handling of Authorization headers for incoming REST connections. Authorization header handling settings apply only when the Message VPN is in gateway mode. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"drop\"`. The allowed values and their meaning are:\n\n
\n\"drop\" - Do not attach the Authorization header to the message as a user property. This configuration is most secure.\n\"forward\" - Forward the Authorization header, attaching it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n\"legacy\" - If the Authorization header was used for authentication to the broker, do not attach it to the message. If the Authorization header was not used for authentication to the broker, attach it to the message as a user property in the same way as other headers. For best security, use the drop setting.\n
\n Available since SEMP API version 2.19.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, diff --git a/internal/broker/generated/MsgVpnAclProfile.go b/internal/broker/generated/MsgVpnAclProfile.go index 928bc8a3..3b9254e4 100644 --- a/internal/broker/generated/MsgVpnAclProfile.go +++ b/internal/broker/generated/MsgVpnAclProfile.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile", - MarkdownDescription: "An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nacl_profile_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "aclProfileName", diff --git a/internal/broker/generated/MsgVpnAclProfileClientConnectException.go b/internal/broker/generated/MsgVpnAclProfileClientConnectException.go index 2c41c30e..85ba9073 100644 --- a/internal/broker/generated/MsgVpnAclProfileClientConnectException.go +++ b/internal/broker/generated/MsgVpnAclProfileClientConnectException.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_client_connect_exception", - MarkdownDescription: "A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nacl_profile_name|x|||\nclient_connect_exception_address|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nclient_connect_exception_address|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "aclProfileName", diff --git a/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go b/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go index efbb88e8..c7e5acc8 100644 --- a/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go +++ b/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_publish_topic_exception", - MarkdownDescription: "A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nacl_profile_name|x|||\nmsg_vpn_name|x|||\npublish_topic_exception|x|||\npublish_topic_exception_syntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\npublish_topic_exception|x\npublish_topic_exception_syntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "aclProfileName", diff --git a/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go b/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go index c3226935..450428c2 100644 --- a/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go +++ b/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_subscribe_share_name_exception", - MarkdownDescription: "A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nacl_profile_name|x|||\nmsg_vpn_name|x|||\nsubscribe_share_name_exception|x|||\nsubscribe_share_name_exception_syntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\nsubscribe_share_name_exception|x\nsubscribe_share_name_exception_syntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "aclProfileName", diff --git a/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go b/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go index 6adddf33..8ff33a8d 100644 --- a/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go +++ b/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_subscribe_topic_exception", - MarkdownDescription: "A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nacl_profile_name|x|||\nmsg_vpn_name|x|||\nsubscribe_topic_exception|x|||\nsubscribe_topic_exception_syntax|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\nsubscribe_topic_exception|x\nsubscribe_topic_exception_syntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "aclProfileName", diff --git a/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go b/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go index c8cf9580..d6094b0e 100644 --- a/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go +++ b/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authentication_oauth_profile", - MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclient_secret||x||x\nmsg_vpn_name|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", + MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclient_secret||x|x\nmsg_vpn_name|x||\noauth_profile_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authorizationGroupsClaimName", diff --git a/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go b/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go index 7d9ee7a7..cc3c2028 100644 --- a/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go +++ b/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authentication_oauth_profile_client_required_claim", - MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclient_required_claim_name|x|||\nmsg_vpn_name|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", + MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclient_required_claim_name|x\nmsg_vpn_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", PostPathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "clientRequiredClaimName", diff --git a/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go b/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go index c245bd71..4e409627 100644 --- a/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go +++ b/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authentication_oauth_profile_resource_server_required_claim", - MarkdownDescription: "Additional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\noauth_profile_name|x|||\nresource_server_required_claim_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", + MarkdownDescription: "Additional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\noauth_profile_name|x\nresource_server_required_claim_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", PostPathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnAuthorizationGroup.go b/internal/broker/generated/MsgVpnAuthorizationGroup.go index 4950a354..1d2e33ac 100644 --- a/internal/broker/generated/MsgVpnAuthorizationGroup.go +++ b/internal/broker/generated/MsgVpnAuthorizationGroup.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authorization_group", - MarkdownDescription: "To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorization_group_name|x|||\nmsg_vpn_name|x|||\norder_after_authorization_group_name||x||\norder_before_authorization_group_name||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorization_group_name|x|\nmsg_vpn_name|x|\norder_after_authorization_group_name||x\norder_before_authorization_group_name||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "aclProfileName", diff --git a/internal/broker/generated/MsgVpnBridge.go b/internal/broker/generated/MsgVpnBridge.go index ce0bf462..9f85b6a7 100644 --- a/internal/broker/generated/MsgVpnBridge.go +++ b/internal/broker/generated/MsgVpnBridge.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_bridge", - MarkdownDescription: "Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridge_name|x|||\nbridge_virtual_router|x|||\nmsg_vpn_name|x|||\nremote_authentication_basic_password||x||x\nremote_authentication_client_cert_content||x||x\nremote_authentication_client_cert_password||x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridge_name|x||\nbridge_virtual_router|x||\nmsg_vpn_name|x||\nremote_authentication_basic_password||x|x\nremote_authentication_client_cert_content||x|x\nremote_authentication_client_cert_password||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "bridgeName", diff --git a/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go b/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go index bbc11402..459809ba 100644 --- a/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go +++ b/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_bridge_remote_msg_vpn", - MarkdownDescription: "The Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridge_name|x|||\nbridge_virtual_router|x|||\nmsg_vpn_name|x|||\npassword||x||x\nremote_msg_vpn_interface|x|||\nremote_msg_vpn_location|x|||\nremote_msg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "The Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridge_name|x||\nbridge_virtual_router|x||\nmsg_vpn_name|x||\npassword||x|x\nremote_msg_vpn_interface|x||\nremote_msg_vpn_location|x||\nremote_msg_vpn_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "bridgeName", diff --git a/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go b/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go index 4e0b1e8b..8101fc8d 100644 --- a/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go +++ b/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_bridge_remote_subscription", - MarkdownDescription: "A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nbridge_name|x|||\nbridge_virtual_router|x|||\nmsg_vpn_name|x|||\nremote_subscription_topic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridge_name|x\nbridge_virtual_router|x\nmsg_vpn_name|x\nremote_subscription_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", PostPathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "bridgeName", diff --git a/internal/broker/generated/MsgVpnCertMatchingRule.go b/internal/broker/generated/MsgVpnCertMatchingRule.go index 5b9f4856..a6d22ca6 100644 --- a/internal/broker/generated/MsgVpnCertMatchingRule.go +++ b/internal/broker/generated/MsgVpnCertMatchingRule.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_cert_matching_rule", - MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nrule_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "enabled", diff --git a/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go b/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go index bcb14a8d..8df6cfbd 100644 --- a/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go +++ b/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_cert_matching_rule_attribute_filter", - MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nfilter_name|x|||\nmsg_vpn_name|x|||\nrule_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilter_name|x\nmsg_vpn_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "attributeName", diff --git a/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go b/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go index 1b1d3b0b..801399c2 100644 --- a/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go +++ b/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_cert_matching_rule_condition", - MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nrule_name|x|||\nsource|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nrule_name|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", PostPathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "attribute", diff --git a/internal/broker/generated/MsgVpnClientProfile.go b/internal/broker/generated/MsgVpnClientProfile.go index cf3ed0db..67aeba0f 100644 --- a/internal/broker/generated/MsgVpnClientProfile.go +++ b/internal/broker/generated/MsgVpnClientProfile.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_client_profile", - MarkdownDescription: "Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallow_cut_through_forwarding_enabled|||x|\napi_queue_management_copy_from_on_create_name|||x|\napi_topic_endpoint_management_copy_from_on_create_name|||x|\nclient_profile_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallow_cut_through_forwarding_enabled||x\napi_queue_management_copy_from_on_create_name||x\napi_topic_endpoint_management_copy_from_on_create_name||x\nclient_profile_name|x|\nmsg_vpn_name|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "allowBridgeConnectionsEnabled", @@ -1334,7 +1325,7 @@ func init() { BaseType: broker.Int64, SempName: "queueGuaranteed1MinMsgBurst", TerraformName: "queue_guaranteed1_min_msg_burst", - MarkdownDescription: "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-3) priority queue, regardless of the `queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", + MarkdownDescription: "The number of messages that are always allowed entry into the \"Guaranteed 1\" (G-1) priority queue, regardless of the `queue_guaranteed1_max_depth` value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `255`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, diff --git a/internal/broker/generated/MsgVpnClientUsername.go b/internal/broker/generated/MsgVpnClientUsername.go index 02de8e37..f2710396 100644 --- a/internal/broker/generated/MsgVpnClientUsername.go +++ b/internal/broker/generated/MsgVpnClientUsername.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_client_username", - MarkdownDescription: "A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclient_username|x|||\nmsg_vpn_name|x|||\npassword||x||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclient_username|x||\nmsg_vpn_name|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "aclProfileName", diff --git a/internal/broker/generated/MsgVpnClientUsernameAttribute.go b/internal/broker/generated/MsgVpnClientUsernameAttribute.go index 5f12607a..146486bd 100644 --- a/internal/broker/generated/MsgVpnClientUsernameAttribute.go +++ b/internal/broker/generated/MsgVpnClientUsernameAttribute.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_client_username_attribute", - MarkdownDescription: "A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nattribute_name|x|||\nattribute_value|x|||\nclient_username|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattribute_name|x\nattribute_value|x\nclient_username|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", PostPathTemplate: "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "attributeName", diff --git a/internal/broker/generated/MsgVpnDistributedCache.go b/internal/broker/generated/MsgVpnDistributedCache.go index 32479519..564bdd0b 100644 --- a/internal/broker/generated/MsgVpnDistributedCache.go +++ b/internal/broker/generated/MsgVpnDistributedCache.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache", - MarkdownDescription: "A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncache_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "cacheName", diff --git a/internal/broker/generated/MsgVpnDistributedCacheCluster.go b/internal/broker/generated/MsgVpnDistributedCacheCluster.go index 6367ae76..a6ceb69d 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheCluster.go +++ b/internal/broker/generated/MsgVpnDistributedCacheCluster.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster", - MarkdownDescription: "A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncache_name|x|||\ncluster_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "cacheName", diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go index 7f177b5c..38286c0d 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_global_caching_home_cluster", - MarkdownDescription: "A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncache_name|x|||\ncluster_name|x|||\nhome_cluster_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nhome_cluster_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", PostPathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "cacheName", diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go index 511719eb..629c4040 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix", - MarkdownDescription: "A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncache_name|x|||\ncluster_name|x|||\nhome_cluster_name|x|||\nmsg_vpn_name|x|||\ntopic_prefix|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nhome_cluster_name|x\nmsg_vpn_name|x\ntopic_prefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", PostPathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "cacheName", diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go b/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go index 1d62063b..a62752c5 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_instance", - MarkdownDescription: "A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncache_name|x|||\ncluster_name|x|||\ninstance_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\ninstance_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "autoStartEnabled", diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go b/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go index dc881617..486212f3 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_topic", - MarkdownDescription: "The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncache_name|x|||\ncluster_name|x|||\nmsg_vpn_name|x|||\ntopic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nmsg_vpn_name|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", PostPathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "cacheName", diff --git a/internal/broker/generated/MsgVpnDmrBridge.go b/internal/broker/generated/MsgVpnDmrBridge.go index 3a108ca3..cb8331c5 100644 --- a/internal/broker/generated/MsgVpnDmrBridge.go +++ b/internal/broker/generated/MsgVpnDmrBridge.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_dmr_bridge", - MarkdownDescription: "A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nremote_node_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nremote_node_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnJndiConnectionFactory.go b/internal/broker/generated/MsgVpnJndiConnectionFactory.go index c2f5c591..594de686 100644 --- a/internal/broker/generated/MsgVpnJndiConnectionFactory.go +++ b/internal/broker/generated/MsgVpnJndiConnectionFactory.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_jndi_connection_factory", - MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nconnection_factory_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnection_factory_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "allowDuplicateClientIdEnabled", diff --git a/internal/broker/generated/MsgVpnJndiQueue.go b/internal/broker/generated/MsgVpnJndiQueue.go index 7d846835..c8043e06 100644 --- a/internal/broker/generated/MsgVpnJndiQueue.go +++ b/internal/broker/generated/MsgVpnJndiQueue.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_jndi_queue", - MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nqueue_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/jndiQueues/{queueName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnJndiTopic.go b/internal/broker/generated/MsgVpnJndiTopic.go index 32e62943..84eae8f2 100644 --- a/internal/broker/generated/MsgVpnJndiTopic.go +++ b/internal/broker/generated/MsgVpnJndiTopic.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_jndi_topic", - MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\ntopic_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntopic_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/jndiTopics/{topicName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnKafkaReceiver.go b/internal/broker/generated/MsgVpnKafkaReceiver.go index 909481cc..6a6ba0fe 100644 --- a/internal/broker/generated/MsgVpnKafkaReceiver.go +++ b/internal/broker/generated/MsgVpnKafkaReceiver.go @@ -30,25 +30,16 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_receiver", - MarkdownDescription: "A Kafka Receiver receives messages from a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthentication_basic_password||x||x\nauthentication_client_cert_content||x||x\nauthentication_client_cert_password||x||\nauthentication_oauth_client_secret||x||x\nauthentication_scram_password||x||x\nkafka_receiver_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\nauthentication_client_cert_content||x|x\nauthentication_client_cert_password||x|\nauthentication_oauth_client_secret||x|x\nauthentication_scram_password||x|x\nkafka_receiver_name|x||\nmsg_vpn_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - MarkdownDescription: "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password for the Username. To be used when authentication_scheme is \"basic\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Sensitive: true, Requires: []string{"authentication_basic_username"}, Type: types.StringType, @@ -66,7 +57,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicUsername", TerraformName: "authentication_basic_username", - MarkdownDescription: "The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authentication_scheme is \"basic\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -79,7 +70,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertContent", TerraformName: "authentication_client_cert_content", - MarkdownDescription: "The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + MarkdownDescription: "The PEM formatted content for the client certificate used by the Kafka Receiver to login to the remote Kafka broker. To be used when authentication_scheme is \"client-certificate\". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -93,7 +84,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertPassword", TerraformName: "authentication_client_cert_password", - MarkdownDescription: "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + MarkdownDescription: "The password for the client certificate. To be used when authentication_scheme is \"client-certificate\". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", Sensitive: true, Requires: []string{"authentication_client_cert_content"}, Type: types.StringType, @@ -111,7 +102,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientId", TerraformName: "authentication_oauth_client_id", - MarkdownDescription: "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth client ID. To be used when authentication_scheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -124,7 +115,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientScope", TerraformName: "authentication_oauth_client_scope", - MarkdownDescription: "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth scope. To be used when authentication_scheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -137,7 +128,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientSecret", TerraformName: "authentication_oauth_client_secret", - MarkdownDescription: "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth client secret. To be used when authentication_scheme is \"oauth-client\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -151,7 +142,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientTokenEndpoint", TerraformName: "authentication_oauth_client_token_endpoint", - MarkdownDescription: "The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth token endpoint URL that the Kafka Receiver will use to request a token for login to the Kafka broker. Must begin with \"https\". To be used when authentication_scheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -165,7 +156,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScheme", TerraformName: "authentication_scheme", - MarkdownDescription: "The authentication scheme for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication.\n\"basic\" - Basic Authentication.\n\"scram\" - Salted Challenge Response Authentication.\n\"client-certificate\" - Client Certificate Authentication.\n\"oauth-client\" - Oauth Authentication.\n
\n", + MarkdownDescription: "The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -178,7 +169,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramHash", TerraformName: "authentication_scram_hash", - MarkdownDescription: "The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", + MarkdownDescription: "The hash used for SCRAM authentication. To be used when authentication_scheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -191,7 +182,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramPassword", TerraformName: "authentication_scram_password", - MarkdownDescription: "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password for the Username. To be used when authentication_scheme is \"scram\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Sensitive: true, Requires: []string{"authentication_scram_username"}, Type: types.StringType, @@ -209,7 +200,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramUsername", TerraformName: "authentication_scram_username", - MarkdownDescription: "The username the Kafka Receiver uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The username the Kafka Receiver uses to login to the remote Kafka broker. To be used when authentication_scheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -222,7 +213,7 @@ func init() { BaseType: broker.Int64, SempName: "batchDelay", TerraformName: "batch_delay", - MarkdownDescription: "Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`.", + MarkdownDescription: "Delay (in ms) to wait to accumulate a batch of messages to receive. Batching is done on a per-partition basis.\n\nThis corresponds to the Kafka consumer API `fetch.max.wait.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, @@ -235,7 +226,7 @@ func init() { BaseType: broker.Int64, SempName: "batchMaxSize", TerraformName: "batch_max_size", - MarkdownDescription: "Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", + MarkdownDescription: "Maximum size of a message batch, in bytes (B). Batching is done on a per-partition basis.\n\nThis corresponds to the Kafka consumer API `fetch.min.bytes` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, @@ -248,7 +239,7 @@ func init() { BaseType: broker.String, SempName: "bootstrapAddressList", TerraformName: "bootstrap_address_list", - MarkdownDescription: "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.\n\nThis corresponds to the Kafka consumer API `bootstrap.servers` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -272,7 +263,7 @@ func init() { BaseType: broker.String, SempName: "groupId", TerraformName: "group_id", - MarkdownDescription: "The id of the Kafka consumer group for the Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The id of the Kafka consumer group for the Receiver.\n\nThis corresponds to the Kafka consumer API `group.id` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -285,7 +276,7 @@ func init() { BaseType: broker.Int64, SempName: "groupKeepaliveInterval", TerraformName: "group_keepalive_interval", - MarkdownDescription: "The time between sending keepalives to the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", + MarkdownDescription: "The time (in ms) between sending keepalives to the group.\n\nThis corresponds to the Kafka consumer API `heartbeat.interval.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3000`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, @@ -298,7 +289,7 @@ func init() { BaseType: broker.Int64, SempName: "groupKeepaliveTimeout", TerraformName: "group_keepalive_timeout", - MarkdownDescription: "The time until unresponsive group members are removed, triggering a partition rebalance across other members of the group. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`.", + MarkdownDescription: "The time (in ms) until unresponsive group members are removed, triggering a partition rebalance across other members of the group.\n\nThis corresponds to the Kafka consumer API `session.timeout.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `45000`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, @@ -311,7 +302,7 @@ func init() { BaseType: broker.String, SempName: "groupMembershipType", TerraformName: "group_membership_type", - MarkdownDescription: "The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within group_keepalive_timeout) without prompting a group rebalance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"dynamic\"`. The allowed values and their meaning are:\n\n
\n\"dynamic\" - Dynamic Membership.\n\"static\" - Static Membership.\n
\n", + MarkdownDescription: "The membership type of the Kafka consumer group for the Receiver. Static members can leave and rejoin the group (within group_keepalive_timeout) without prompting a group rebalance.\n\nThis corresponds to the Kafka consumer API `group.instance.id` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"dynamic\"`. The allowed values and their meaning are:\n\n
\n\"dynamic\" - Dynamic Membership.\n\"static\" - Static Membership.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -324,7 +315,7 @@ func init() { BaseType: broker.String, SempName: "groupPartitionSchemeList", TerraformName: "group_partition_scheme_list", - MarkdownDescription: "The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager (\"range\", \"roundrobin\") and Cooperative (\"cooperative-sticky\") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"range,roundrobin\"`.", + MarkdownDescription: "The ordered, comma-separated list of schemes used for partition assignment of the consumer group for this Receiver. Both Eager (\"range\", \"roundrobin\") and Cooperative (\"cooperative-sticky\") schemes are supported. The elected group leader will choose the first common strategy provided by all members of the group. Eager and Cooperative schemes must not be mixed. For more information on these schemes, see Kafka documentation.\n\nThis corresponds to the Kafka consumer API `partition.assignment.strategy` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"range,roundrobin\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -397,7 +388,7 @@ func init() { BaseType: broker.Bool, SempName: "transportTlsEnabled", TerraformName: "transport_tls_enabled", - MarkdownDescription: "Enable or disable encryption (TLS) for the Kafka Receiver. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable encryption (TLS) for the Kafka Receiver. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, diff --git a/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go b/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go index 44e82396..6f481b4f 100644 --- a/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go +++ b/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_receiver_topic_binding", - MarkdownDescription: "A Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nkafka_receiver_name|x|||\nmsg_vpn_name|x|||\ntopic_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafka_receiver_name|x\nmsg_vpn_name|x\ntopic_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}/topicBindings/{topicName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "enabled", @@ -56,7 +47,7 @@ func init() { BaseType: broker.String, SempName: "initialOffset", TerraformName: "initial_offset", - MarkdownDescription: "The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"end\"`. The allowed values and their meaning are:\n\n
\n\"beginning\" - Start with the earliest offset available.\n\"end\" - Start with new offsets only.\n
\n", + MarkdownDescription: "The initial offset to consume from the Kafka Topic if no member of the group has consumed and committed any offset already, or if the last committed offset has been deleted. Offsets are unique per partition.\n\nThis corresponds to the Kafka consumer API `auto.offset.reset` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"end\"`. The allowed values and their meaning are:\n\n
\n\"beginning\" - Start with the earliest offset available.\n\"end\" - Start with new offsets only.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -86,7 +77,7 @@ func init() { BaseType: broker.String, SempName: "localKey", TerraformName: "local_key", - MarkdownDescription: "The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, no key is included for each message as it is published into Solace. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The Substitution Expression used to generate the key for each message received from Kafka. This expression can include fields extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, no key is included for each message as it is published into Solace.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -99,7 +90,7 @@ func init() { BaseType: broker.String, SempName: "localTopic", TerraformName: "local_topic", - MarkdownDescription: "The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, the Topic Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The Substitution Expression used to generate the Solace Topic for each message received from Kafka. This expression can include data extracted from the metadata of each individual Kafka message as it is received from the Kafka Topic.\n\nIf empty, the Topic Binding will not be operational.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, diff --git a/internal/broker/generated/MsgVpnKafkaSender.go b/internal/broker/generated/MsgVpnKafkaSender.go index fe1053ad..2040ee37 100644 --- a/internal/broker/generated/MsgVpnKafkaSender.go +++ b/internal/broker/generated/MsgVpnKafkaSender.go @@ -30,25 +30,16 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_sender", - MarkdownDescription: "A Kafka Sender sends messages to a Kafka Cluster.\n\nWARNING: This feature is in BETA with limited scalability and no production support. Configuration may change or be eliminated by future upgrades.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthentication_basic_password||x||x\nauthentication_client_cert_content||x||x\nauthentication_client_cert_password||x||\nauthentication_oauth_client_secret||x||x\nauthentication_scram_password||x||x\nkafka_sender_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\nauthentication_client_cert_content||x|x\nauthentication_client_cert_password||x|\nauthentication_oauth_client_secret||x|x\nauthentication_scram_password||x|x\nkafka_sender_name|x||\nmsg_vpn_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - MarkdownDescription: "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password for the Username. To be used when authentication_scheme is \"basic\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Sensitive: true, Requires: []string{"authentication_basic_username"}, Type: types.StringType, @@ -66,7 +57,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicUsername", TerraformName: "authentication_basic_username", - MarkdownDescription: "The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authentication_scheme is \"basic\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -79,7 +70,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertContent", TerraformName: "authentication_client_cert_content", - MarkdownDescription: "The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + MarkdownDescription: "The PEM formatted content for the client certificate used by the Kafka Sender to login to the remote Kafka broker. To be used when authentication_scheme is \"client-certificate\". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -93,7 +84,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertPassword", TerraformName: "authentication_client_cert_password", - MarkdownDescription: "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", + MarkdownDescription: "The password for the client certificate. To be used when authentication_scheme is \"client-certificate\". Alternatively this will be used for other values of authentication_scheme when the Kafka broker has an `ssl.client.auth` setting of \"requested\" or \"required\" and KIP-684 (mTLS) is supported by the Kafka broker. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. The default value is `\"\"`.", Sensitive: true, Requires: []string{"authentication_client_cert_content"}, Type: types.StringType, @@ -111,7 +102,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientId", TerraformName: "authentication_oauth_client_id", - MarkdownDescription: "The OAuth client ID. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth client ID. To be used when authentication_scheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -124,7 +115,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientScope", TerraformName: "authentication_oauth_client_scope", - MarkdownDescription: "The OAuth scope. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth scope. To be used when authentication_scheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -137,7 +128,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientSecret", TerraformName: "authentication_oauth_client_secret", - MarkdownDescription: "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth client secret. To be used when authentication_scheme is \"oauth-client\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -151,7 +142,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientTokenEndpoint", TerraformName: "authentication_oauth_client_token_endpoint", - MarkdownDescription: "The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with \"https\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with \"https\". To be used when authentication_scheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -165,7 +156,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScheme", TerraformName: "authentication_scheme", - MarkdownDescription: "The authentication scheme for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication.\n\"basic\" - Basic Authentication.\n\"scram\" - Salted Challenge Response Authentication.\n\"client-certificate\" - Client Certificate Authentication.\n\"oauth-client\" - Oauth Authentication.\n
\n", + MarkdownDescription: "The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -178,7 +169,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramHash", TerraformName: "authentication_scram_hash", - MarkdownDescription: "The hash used for SCRAM authentication. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", + MarkdownDescription: "The hash used for SCRAM authentication. To be used when authentication_scheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -191,7 +182,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramPassword", TerraformName: "authentication_scram_password", - MarkdownDescription: "The password for the Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password for the Username. To be used when authentication_scheme is \"scram\". This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4 (refer to the `Notes` section in the SEMP API `Config reference`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Sensitive: true, Requires: []string{"authentication_scram_username"}, Type: types.StringType, @@ -209,7 +200,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramUsername", TerraformName: "authentication_scram_username", - MarkdownDescription: "The username the Kafka Sender uses to login to the remote Kafka broker. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authentication_scheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -222,7 +213,7 @@ func init() { BaseType: broker.Int64, SempName: "batchDelay", TerraformName: "batch_delay", - MarkdownDescription: "Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", + MarkdownDescription: "Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `linger.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, @@ -248,7 +239,7 @@ func init() { BaseType: broker.Int64, SempName: "batchMaxSize", TerraformName: "batch_max_size", - MarkdownDescription: "Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", + MarkdownDescription: "Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `batch.size` configuration setting, and should not exceed either the Kafka broker `message.max.bytes` configuration setting, or the per-Topic override of `max.message.bytes`.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, @@ -261,7 +252,7 @@ func init() { BaseType: broker.String, SempName: "bootstrapAddressList", TerraformName: "bootstrap_address_list", - MarkdownDescription: "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.\n\nThis corresponds to the Kafka producer API `bootstrap.servers` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -285,7 +276,7 @@ func init() { BaseType: broker.Bool, SempName: "idempotenceEnabled", TerraformName: "idempotence_enabled", - MarkdownDescription: "Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable idempotence for the Kafka Sender. Idempotence guarantees in order at-least-once message delivery to the remote Kafka Topic, at the expense of performance. When idempotence is enabled the Queue Bindings of the Kafka Sender must have ack_mode of \"all\" to be operational.\n\nThis corresponds to the Kafka producer API `enable.idempotence` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, @@ -338,7 +329,7 @@ func init() { BaseType: broker.Int64, SempName: "transportCompressionLevel", TerraformName: "transport_compression_level", - MarkdownDescription: "Compression level. The valid range is dependent on the compression type. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", + MarkdownDescription: "Compression level. The valid range is dependent on the compression type.\n\nThis corresponds to the Kafka producer API `compression.level` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, @@ -351,7 +342,7 @@ func init() { BaseType: broker.String, SempName: "transportCompressionType", TerraformName: "transport_compression_type", - MarkdownDescription: "Compression type. Only relevant if compression is enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"gzip\"`. The allowed values and their meaning are:\n\n
\n\"gzip\" - GZIP Compression.\n\"snappy\" - Snappy Compression.\n\"lz4\" - LZ4 Compression.\n\"zstd\" - Zstandard Compression.\n
\n", + MarkdownDescription: "Compression type. Only relevant if compression is enabled.\n\nThis corresponds to the Kafka producer API `compression.type` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"gzip\"`. The allowed values and their meaning are:\n\n
\n\"gzip\" - GZIP Compression.\n\"snappy\" - Snappy Compression.\n\"lz4\" - LZ4 Compression.\n\"zstd\" - Zstandard Compression.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -364,7 +355,7 @@ func init() { BaseType: broker.Bool, SempName: "transportTlsEnabled", TerraformName: "transport_tls_enabled", - MarkdownDescription: "Enable or disable encryption (TLS) for the Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable encryption (TLS) for the Kafka Sender. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, diff --git a/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go b/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go index 345ce542..66841fb9 100644 --- a/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go +++ b/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go @@ -29,25 +29,16 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_sender_queue_binding", - MarkdownDescription: "A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nkafka_sender_name|x|||\nmsg_vpn_name|x|||\nqueue_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafka_sender_name|x\nmsg_vpn_name|x\nqueue_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}/queueBindings/{queueName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "ackMode", TerraformName: "ack_mode", - MarkdownDescription: "The number of acks required from the remote Kafka broker. When \"none\" messages are delivered at-most-once. When \"one\" or \"all\" messages are delivered at-least-once but may be reordered. This is overridden to \"all\" for an idempotent Kafka Sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are:\n\n
\n\"none\" - No Acks.\n\"one\" - Leader Ack Only.\n\"all\" - All Replica Acks.\n
\n", + MarkdownDescription: "The number of acks required from the remote Kafka broker. When \"none\" messages are delivered at-most-once. When \"one\" or \"all\" messages are delivered at-least-once but may be reordered. This must be configured as \"all\" for an idempotent Kafka Sender, otherwise the Queue Binding will be operationally down.\n\nThis corresponds to the Kafka producer API `acks` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"all\"`. The allowed values and their meaning are:\n\n
\n\"none\" - No Acks.\n\"one\" - Leader Ack Only.\n\"all\" - All Replica Acks.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -140,7 +131,7 @@ func init() { BaseType: broker.String, SempName: "partitionScheme", TerraformName: "partition_scheme", - MarkdownDescription: "The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"consistent\"`. The allowed values and their meaning are:\n\n
\n\"consistent\" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number.\n\"explicit\" - Select an explicit partition independent of key value.\n\"random\" - Select a random partition independent of key value.\n
\n", + MarkdownDescription: "The partitioning scheme used to select a partition of the topic on the Kafka cluster to send messages to.\n\nThis corresponds to the Kafka producer API `partitioner.class` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"consistent\"`. The allowed values and their meaning are:\n\n
\n\"consistent\" - Select a consistent partition for each key value. A hash of the key will be used to select the partition number.\n\"explicit\" - Select an explicit partition independent of key value.\n\"random\" - Select a random partition independent of key value.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -169,7 +160,7 @@ func init() { BaseType: broker.String, SempName: "remoteKey", TerraformName: "remote_key", - MarkdownDescription: "The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue.\n\nIf empty, no key is included for each message as it is published into Kafka. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The Substitution Expression used to generate the key for each message sent to Kafka. This expression can include fields extracted from the metadata of each individual Solace message as it is taken from the Solace Queue.\n\nIf empty, no key is included for each message as it is published into Kafka.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -182,7 +173,7 @@ func init() { BaseType: broker.String, SempName: "remoteTopic", TerraformName: "remote_topic", - MarkdownDescription: "The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to.\n\nIf empty, the Queue Binding will not be operational. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The Kafka Topic on the Kafka Cluster to send each message taken from the Solace Queue to.\n\nIf empty, the Queue Binding will not be operational.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, diff --git a/internal/broker/generated/MsgVpnMqttRetainCache.go b/internal/broker/generated/MsgVpnMqttRetainCache.go index 1a9e446e..f08ad2e2 100644 --- a/internal/broker/generated/MsgVpnMqttRetainCache.go +++ b/internal/broker/generated/MsgVpnMqttRetainCache.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_mqtt_retain_cache", - MarkdownDescription: "Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ncache_name|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "cacheName", diff --git a/internal/broker/generated/MsgVpnMqttSession.go b/internal/broker/generated/MsgVpnMqttSession.go index 6d9b2a74..83dc2c4d 100644 --- a/internal/broker/generated/MsgVpnMqttSession.go +++ b/internal/broker/generated/MsgVpnMqttSession.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_mqtt_session", - MarkdownDescription: "An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqtt_session_client_id|x|||\nmqtt_session_virtual_router|x|||\nmsg_vpn_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqtt_session_client_id|x\nmqtt_session_virtual_router|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "enabled", diff --git a/internal/broker/generated/MsgVpnMqttSessionSubscription.go b/internal/broker/generated/MsgVpnMqttSessionSubscription.go index 03038659..99040645 100644 --- a/internal/broker/generated/MsgVpnMqttSessionSubscription.go +++ b/internal/broker/generated/MsgVpnMqttSessionSubscription.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_mqtt_session_subscription", - MarkdownDescription: "An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmqtt_session_client_id|x|||\nmqtt_session_virtual_router|x|||\nmsg_vpn_name|x|||\nsubscription_topic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqtt_session_client_id|x\nmqtt_session_virtual_router|x\nmsg_vpn_name|x\nsubscription_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "mqttSessionClientId", diff --git a/internal/broker/generated/MsgVpnProxy.go b/internal/broker/generated/MsgVpnProxy.go index 484d7e96..16e7bb92 100644 --- a/internal/broker/generated/MsgVpnProxy.go +++ b/internal/broker/generated/MsgVpnProxy.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_proxy", - MarkdownDescription: "Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthentication_basic_password||x||x\nmsg_vpn_name|x|||\nproxy_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\nmsg_vpn_name|x||\nproxy_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/proxies/{proxyName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authenticationBasicPassword", diff --git a/internal/broker/generated/MsgVpnQueue.go b/internal/broker/generated/MsgVpnQueue.go index 6977de9d..3794c43b 100644 --- a/internal/broker/generated/MsgVpnQueue.go +++ b/internal/broker/generated/MsgVpnQueue.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_queue", - MarkdownDescription: "A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nqueue_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/queues/{queueName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessType", diff --git a/internal/broker/generated/MsgVpnQueueSubscription.go b/internal/broker/generated/MsgVpnQueueSubscription.go index a83663b1..ff42f85e 100644 --- a/internal/broker/generated/MsgVpnQueueSubscription.go +++ b/internal/broker/generated/MsgVpnQueueSubscription.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_queue_subscription", - MarkdownDescription: "One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nqueue_name|x|||\nsubscription_topic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_name|x\nsubscription_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", PostPathTemplate: "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnQueueTemplate.go b/internal/broker/generated/MsgVpnQueueTemplate.go index 33cbbd9c..fe8f309d 100644 --- a/internal/broker/generated/MsgVpnQueueTemplate.go +++ b/internal/broker/generated/MsgVpnQueueTemplate.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_queue_template", - MarkdownDescription: "A Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nqueue_template_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_template_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessType", diff --git a/internal/broker/generated/MsgVpnReplayLog.go b/internal/broker/generated/MsgVpnReplayLog.go index c15c2219..ce1d4db0 100644 --- a/internal/broker/generated/MsgVpnReplayLog.go +++ b/internal/broker/generated/MsgVpnReplayLog.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_replay_log", - MarkdownDescription: "When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nreplay_log_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.10.", + MarkdownDescription: "When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreplay_log_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.10.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "egressEnabled", diff --git a/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go b/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go index 3831b547..2ed8b11d 100644 --- a/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go +++ b/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_replay_log_topic_filter_subscription", - MarkdownDescription: "One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nreplay_log_name|x|||\ntopic_filter_subscription|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreplay_log_name|x\ntopic_filter_subscription|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", PostPathTemplate: "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnReplicatedTopic.go b/internal/broker/generated/MsgVpnReplicatedTopic.go index a4c75a60..ef7119a5 100644 --- a/internal/broker/generated/MsgVpnReplicatedTopic.go +++ b/internal/broker/generated/MsgVpnReplicatedTopic.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_replicated_topic", - MarkdownDescription: "To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nreplicated_topic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreplicated_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnRestDeliveryPoint.go b/internal/broker/generated/MsgVpnRestDeliveryPoint.go index 834dbcee..f2b51a4d 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPoint.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPoint.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point", - MarkdownDescription: "A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nrest_delivery_point_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "clientProfileName", diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go index de1d7b8e..d168c1d2 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_queue_binding", - MarkdownDescription: "A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nqueue_binding_name|x|||\nrest_delivery_point_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_binding_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "gatewayReplaceTargetAuthorityEnabled", diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go index d4a51848..3f610993 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_queue_binding_protected_request_header", - MarkdownDescription: "A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheader_name|x|||\nheader_value||x||x\nmsg_vpn_name|x|||\nqueue_binding_name|x|||\nrest_delivery_point_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.30.", + MarkdownDescription: "A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nheader_name|x||\nheader_value||x|x\nmsg_vpn_name|x||\nqueue_binding_name|x||\nrest_delivery_point_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.30.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/protectedRequestHeaders/{headerName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "headerName", diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go index 0bd2298a..2a2b904a 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_queue_binding_request_header", - MarkdownDescription: "A request header to be added to the HTTP request.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nheader_name|x|||\nmsg_vpn_name|x|||\nqueue_binding_name|x|||\nrest_delivery_point_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.23.", + MarkdownDescription: "A request header to be added to the HTTP request.\n\n\nAttribute|Identifying\n:---|:---:\nheader_name|x\nmsg_vpn_name|x\nqueue_binding_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.23.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "headerName", diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go index 3765b7bf..a552b45b 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go @@ -31,20 +31,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_rest_consumer", - MarkdownDescription: "REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthentication_aws_secret_access_key||x||x\nauthentication_client_cert_content||x||x\nauthentication_client_cert_password||x||\nauthentication_http_basic_password||x||x\nauthentication_http_header_value||x||x\nauthentication_oauth_client_secret||x||x\nauthentication_oauth_jwt_secret_key||x||x\nmsg_vpn_name|x|||\nrest_consumer_name|x|||\nrest_delivery_point_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_aws_secret_access_key||x|x\nauthentication_client_cert_content||x|x\nauthentication_client_cert_password||x|\nauthentication_http_basic_password||x|x\nauthentication_http_header_value||x|x\nauthentication_oauth_client_secret||x|x\nauthentication_oauth_jwt_secret_key||x|x\nmsg_vpn_name|x||\nrest_consumer_name|x||\nrest_delivery_point_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authenticationAwsAccessKeyId", diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go index 7bf9e2fe..a9ffe48f 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim", - MarkdownDescription: "A Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\noauth_jwt_claim_name|x|||\nrest_consumer_name|x|||\nrest_delivery_point_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.21.", + MarkdownDescription: "A Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\noauth_jwt_claim_name|x\nrest_consumer_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.21.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", PostPathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnSequencedTopic.go b/internal/broker/generated/MsgVpnSequencedTopic.go index f53c8a8a..9d702fec 100644 --- a/internal/broker/generated/MsgVpnSequencedTopic.go +++ b/internal/broker/generated/MsgVpnSequencedTopic.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_sequenced_topic", - MarkdownDescription: "A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nsequenced_topic|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nsequenced_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}", PostPathTemplate: "/msgVpns/{msgVpnName}/sequencedTopics", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnTelemetryProfile.go b/internal/broker/generated/MsgVpnTelemetryProfile.go index 81ebcbca..f50fc695 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfile.go +++ b/internal/broker/generated/MsgVpnTelemetryProfile.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile", - MarkdownDescription: "Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\ntelemetry_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntelemetry_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go b/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go index b794cc18..5b87ec68 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go +++ b/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile_receiver_acl_connect_exception", - MarkdownDescription: "A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nreceiver_acl_connect_exception_address|x|||\ntelemetry_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreceiver_acl_connect_exception_address|x\ntelemetry_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/receiverAclConnectExceptions/{receiverAclConnectExceptionAddress}", PostPathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/receiverAclConnectExceptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go index 7a97f212..dcae6eb3 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go +++ b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile_trace_filter", - MarkdownDescription: "A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\ntelemetry_profile_name|x|||\ntrace_filter_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntelemetry_profile_name|x\ntrace_filter_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "enabled", diff --git a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go index 23395793..8ce458dc 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go +++ b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile_trace_filter_subscription", - MarkdownDescription: "Trace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\nsubscription|x|||\nsubscription_syntax|x|||\ntelemetry_profile_name|x|||\ntrace_filter_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "Trace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nsubscription|x\nsubscription_syntax|x\ntelemetry_profile_name|x\ntrace_filter_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}/subscriptions/{subscription},{subscriptionSyntax}", PostPathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}/subscriptions", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "msgVpnName", diff --git a/internal/broker/generated/MsgVpnTopicEndpoint.go b/internal/broker/generated/MsgVpnTopicEndpoint.go index bcd613b8..17396fd8 100644 --- a/internal/broker/generated/MsgVpnTopicEndpoint.go +++ b/internal/broker/generated/MsgVpnTopicEndpoint.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_topic_endpoint", - MarkdownDescription: "A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\ntopic_endpoint_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntopic_endpoint_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessType", diff --git a/internal/broker/generated/MsgVpnTopicEndpointTemplate.go b/internal/broker/generated/MsgVpnTopicEndpointTemplate.go index 22661cee..d8dac800 100644 --- a/internal/broker/generated/MsgVpnTopicEndpointTemplate.go +++ b/internal/broker/generated/MsgVpnTopicEndpointTemplate.go @@ -30,20 +30,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_topic_endpoint_template", - MarkdownDescription: "A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\ntopic_endpoint_template_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntopic_endpoint_template_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessType", diff --git a/internal/broker/generated/OauthProfile.go b/internal/broker/generated/OauthProfile.go index 08d1fbf1..e8800e58 100644 --- a/internal/broker/generated/OauthProfile.go +++ b/internal/broker/generated/OauthProfile.go @@ -29,20 +29,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile", - MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclient_secret||x||x\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclient_secret||x|x\noauth_profile_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessLevelGroupsClaimName", diff --git a/internal/broker/generated/OauthProfileAccessLevelGroup.go b/internal/broker/generated/OauthProfileAccessLevelGroup.go index 87b768db..71398f16 100644 --- a/internal/broker/generated/OauthProfileAccessLevelGroup.go +++ b/internal/broker/generated/OauthProfileAccessLevelGroup.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_access_level_group", - MarkdownDescription: "The name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroup_name|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "The name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying\n:---|:---:\ngroup_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "description", diff --git a/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go b/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go index f5b9701e..7c1aa974 100644 --- a/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go +++ b/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_access_level_group_msg_vpn_access_level_exception", - MarkdownDescription: "Message VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\ngroup_name|x|||\nmsg_vpn_name|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Message VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying\n:---|:---:\ngroup_name|x\nmsg_vpn_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessLevel", diff --git a/internal/broker/generated/OauthProfileClientAllowedHost.go b/internal/broker/generated/OauthProfileClientAllowedHost.go index 686ce7c9..7ec6610d 100644 --- a/internal/broker/generated/OauthProfileClientAllowedHost.go +++ b/internal/broker/generated/OauthProfileClientAllowedHost.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_client_allowed_host", - MarkdownDescription: "A valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nallowed_host|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "A valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying\n:---|:---:\nallowed_host|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}", PostPathTemplate: "/oauthProfiles/{oauthProfileName}/clientAllowedHosts", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "allowedHost", diff --git a/internal/broker/generated/OauthProfileClientAuthorizationParameter.go b/internal/broker/generated/OauthProfileClientAuthorizationParameter.go index e7c0b659..212d15df 100644 --- a/internal/broker/generated/OauthProfileClientAuthorizationParameter.go +++ b/internal/broker/generated/OauthProfileClientAuthorizationParameter.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_client_authorization_parameter", - MarkdownDescription: "Additional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthorization_parameter_name|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Additional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nauthorization_parameter_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "authorizationParameterName", diff --git a/internal/broker/generated/OauthProfileClientRequiredClaim.go b/internal/broker/generated/OauthProfileClientRequiredClaim.go index 32b2e372..4995532f 100644 --- a/internal/broker/generated/OauthProfileClientRequiredClaim.go +++ b/internal/broker/generated/OauthProfileClientRequiredClaim.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_client_required_claim", - MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nclient_required_claim_name|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclient_required_claim_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", PostPathTemplate: "/oauthProfiles/{oauthProfileName}/clientRequiredClaims", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "clientRequiredClaimName", diff --git a/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go b/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go index d0da1bfe..fcd77769 100644 --- a/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go +++ b/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_default_msg_vpn_access_level_exception", - MarkdownDescription: "Default message VPN access-level exceptions.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nmsg_vpn_name|x|||\noauth_profile_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Default message VPN access-level exceptions.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "accessLevel", diff --git a/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go b/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go index 4a4376fe..721d2f26 100644 --- a/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go +++ b/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go @@ -28,21 +28,12 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_resource_server_required_claim", - MarkdownDescription: "Additional claims to be verified in the access token.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\noauth_profile_name|x|||\nresource_server_required_claim_name|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Additional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\noauth_profile_name|x\nresource_server_required_claim_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", PostPathTemplate: "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.String, SempName: "oauthProfileName", diff --git a/internal/broker/generated/VersionDetails.go b/internal/broker/generated/VersionDetails.go index 7b3ab969..67791232 100644 --- a/internal/broker/generated/VersionDetails.go +++ b/internal/broker/generated/VersionDetails.go @@ -19,8 +19,9 @@ package generated import "terraform-provider-solacebroker/internal/broker" const BasePath = "/SEMP/v2/config" -const SempVersion = "2.36" +const SempVersion = "2.39" +const Platform = "VMR" func init() { - broker.RegisterSempVersionDetails(BasePath, SempVersion) + broker.RegisterSempVersionDetails(BasePath, SempVersion, Platform) } diff --git a/internal/broker/generated/VirtualHostname.go b/internal/broker/generated/VirtualHostname.go index c1b99318..1f94a0e7 100644 --- a/internal/broker/generated/VirtualHostname.go +++ b/internal/broker/generated/VirtualHostname.go @@ -28,20 +28,11 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "virtual_hostname", - MarkdownDescription: "A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nvirtual_hostname|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.17.", + MarkdownDescription: "A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying\n:---|:---:\nvirtual_hostname|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.17.", ObjectType: broker.StandardObject, PathTemplate: "/virtualHostnames/{virtualHostname}", Version: 0, Attributes: []*broker.AttributeInfo{ - { - BaseType: broker.String, - SempName: "id", - TerraformName: "id", - Type: types.StringType, - TerraformType: tftypes.String, - Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, - Default: "", - }, { BaseType: broker.Bool, SempName: "enabled", diff --git a/internal/broker/provider.go b/internal/broker/provider.go index 0a50f1a9..a48e481f 100644 --- a/internal/broker/provider.go +++ b/internal/broker/provider.go @@ -18,12 +18,8 @@ package broker import ( "context" - "fmt" - "net/http" - "net/http/cookiejar" "strings" - "github.com/hashicorp/go-version" "github.com/hashicorp/terraform-plugin-framework/datasource" "github.com/hashicorp/terraform-plugin-framework/provider" "github.com/hashicorp/terraform-plugin-framework/provider/schema" @@ -32,13 +28,9 @@ import ( "github.com/hashicorp/terraform-plugin-log/tflog" ) -const minRequiredBrokerSempApiVersion = "2.33" // Shipped with broker version 10.3 - var _ provider.Provider = &BrokerProvider{} var ProviderVersion string -var Cookiejar, _ = cookiejar.New(nil) - type BrokerProvider struct { Version string } @@ -52,7 +44,7 @@ func (p *BrokerProvider) Schema(_ context.Context, _ provider.SchemaRequest, res response.Schema = schema.Schema{ Attributes: map[string]schema.Attribute{ "url": schema.StringAttribute{ - MarkdownDescription: "The base URL of the event broker, for example `https://mybroker.example.org:1943/`. The trailing / can be omitted.", + MarkdownDescription: "The base URL of the event broker, for example `https://mybroker.example.org:/`. The trailing / can be omitted.", Required: true, }, "username": schema.StringAttribute{ @@ -93,6 +85,10 @@ func (p *BrokerProvider) Schema(_ context.Context, _ provider.SchemaRequest, res MarkdownDescription: "Disable validation of server SSL certificates, accept/ignore self-signed. The default value is false.", Optional: true, }, + "skip_api_check": schema.BoolAttribute{ + MarkdownDescription: "Disable validation of the broker SEMP API for supported platform and minimum version. The default value is false.", + Optional: true, + }, }, MarkdownDescription: "", } @@ -106,11 +102,9 @@ func (p *BrokerProvider) Configure(ctx context.Context, req provider.ConfigureRe if resp.Diagnostics.HasError() { return } - ctx = tflog.SetField(ctx, "solacebroker_url", strings.Trim(config.Url.String(), "\"")) ctx = tflog.SetField(ctx, "solacebroker_provider_version", p.Version) - tflog.Debug(ctx, "Configuring solacebroker provider client") - + tflog.Debug(ctx, "Creating SEMP client") client, d := client(&config) if d != nil { resp.Diagnostics.Append(d) @@ -118,29 +112,10 @@ func (p *BrokerProvider) Configure(ctx context.Context, req provider.ConfigureRe return } } - - path := "/about/api" - result, err := client.RequestWithoutBody(ctx, http.MethodGet, path) - if err != nil { - addErrorToDiagnostics(&resp.Diagnostics, "SEMP call failed", err) - return - } - brokerSempVersion, err := version.NewVersion(result["sempVersion"].(string)) - if err != nil { - addErrorToDiagnostics(&resp.Diagnostics, "unable to parse SEMP version returned from \"/about/api\"", err) - return - } - minSempVersion, _ := version.NewVersion(minRequiredBrokerSempApiVersion) - if brokerSempVersion.LessThan(minSempVersion) { - err := fmt.Errorf("BrokerSempVersion %s is less than required %s", brokerSempVersion, minSempVersion) - addErrorToDiagnostics(&resp.Diagnostics, "Broker does not meet minimum SEMP API version", err) - return - } - tflog.Info(ctx, "Solacebroker provider client config success") - - resp.ResourceData = &config - resp.DataSourceData = &config + resp.ResourceData = client + resp.DataSourceData = client + forceBrokerRequirementsCheck() } func (p *BrokerProvider) Resources(_ context.Context) []func() resource.Resource { @@ -162,6 +137,7 @@ type providerData struct { RequestTimeoutDuration types.String `tfsdk:"request_timeout_duration"` RequestMinInterval types.String `tfsdk:"request_min_interval"` InsecureSkipVerify types.Bool `tfsdk:"insecure_skip_verify"` + SkipApiCheck types.Bool `tfsdk:"skip_api_check"` } func New(version string) func() provider.Provider { diff --git a/internal/broker/resource.go b/internal/broker/resource.go index d61011f0..74f434f8 100644 --- a/internal/broker/resource.go +++ b/internal/broker/resource.go @@ -25,9 +25,10 @@ import ( "net/url" "path/filepath" "strings" + "sync" + "github.com/hashicorp/go-version" "github.com/hashicorp/terraform-plugin-framework/diag" - "github.com/hashicorp/terraform-plugin-framework/path" "github.com/hashicorp/terraform-plugin-framework/resource" "github.com/hashicorp/terraform-plugin-framework/resource/schema" "github.com/hashicorp/terraform-plugin-go/tftypes" @@ -36,13 +37,33 @@ import ( "terraform-provider-solacebroker/internal/semp" ) +type brokerResource brokerEntity[schema.Schema] + const ( - defaults = "defaults" - defaultObjectName = "default" + defaults = "defaults" + defaultObjectName = "default" + minRequiredBrokerSempApiVersion = "2.33" // Shipped with broker version 10.3 +) + +var ( + ErrDeleteSingletonOrDefaultsNotAllowed = errors.New("deleting singleton or default objects are not allowed from the broker") + BrokerPlatformName = map[string]string{ + "VMR": "Software Event Broker", + "Appliance": "Appliance", + } ) var ( - ErrDeleteSingletonOrDefaultsNotAllowed = errors.New("Deleting singleton or default objects are not allowed from the broker") + _ resource.ResourceWithConfigure = &brokerResource{} + _ resource.ResourceWithConfigValidators = &brokerResource{} + _ resource.ResourceWithImportState = &brokerResource{} + _ resource.ResourceWithUpgradeState = &brokerResource{} +) + +var ( + skipApiCheck = false + apiAlreadyChecked = false + lock sync.Mutex ) func newBrokerResource(inputs EntityInputs) brokerEntity[schema.Schema] { @@ -60,14 +81,39 @@ func newBrokerResourceClosure(templateEntity brokerEntity[schema.Schema]) func() } } -var ( - _ resource.ResourceWithConfigure = &brokerResource{} - _ resource.ResourceWithConfigValidators = &brokerResource{} - _ resource.ResourceWithImportState = &brokerResource{} - _ resource.ResourceWithUpgradeState = &brokerResource{} -) +func forceBrokerRequirementsCheck() { + apiAlreadyChecked = false +} -type brokerResource brokerEntity[schema.Schema] +func checkBrokerRequirements(ctx context.Context, client *semp.Client) error { + if !skipApiCheck && !apiAlreadyChecked { + lock.Lock() + defer lock.Unlock() + if apiAlreadyChecked { + return nil + } + path := "/about/api" + result, err := client.RequestWithoutBody(ctx, http.MethodGet, path) + if err != nil { + return err + } + // To support broker developer versions ignore "+" in the returned version + brokerSempVersion, err := version.NewVersion(strings.Replace(result["sempVersion"].(string), "+", "", -1)) + if err != nil { + return err + } + minSempVersion, _ := version.NewVersion(minRequiredBrokerSempApiVersion) + if brokerSempVersion.LessThan(minSempVersion) { + return fmt.Errorf("broker SEMP API version %s does not meet provider required minimum SEMP API version: %s", brokerSempVersion, minSempVersion) + } + brokerPlatform := result["platform"].(string) + if brokerPlatform != SempDetail.Platform { + return fmt.Errorf("broker platform \"%s\" does not match provider supported platform: %s", BrokerPlatformName[brokerPlatform], BrokerPlatformName[SempDetail.Platform]) + } + apiAlreadyChecked = true + } + return nil +} // Compares the value with the attribute default value. Must take care of type conversions. func isValueEqualsAttrDefault(attr *AttributeInfo, response tftypes.Value, brokerDefault tftypes.Value) (bool, error) { @@ -100,7 +146,6 @@ func isValueEqualsAttrDefault(attr *AttributeInfo, response tftypes.Value, broke } func toId(path string) string { - // the generated id will only be used for testing return filepath.Base(path) } @@ -216,22 +261,22 @@ func (r *brokerResource) Configure(_ context.Context, request resource.Configure if request.ProviderData == nil { return } - config, ok := request.ProviderData.(*providerData) + client, ok := request.ProviderData.(*semp.Client) if !ok { - d := diag.NewErrorDiagnostic("Unexpected resource configuration", fmt.Sprintf("Unexpected type %T for provider data; expected %T.", request.ProviderData, config)) - response.Diagnostics.Append(d) + response.Diagnostics.AddError( + "Unexpected datasource configuration", + fmt.Sprintf("Unexpected type %T for provider data; expected %T.", request.ProviderData, client), + ) return } - r.providerData = config + r.client = client } func (r *brokerResource) Create(ctx context.Context, request resource.CreateRequest, response *resource.CreateResponse) { - client, d := client(r.providerData) - if d != nil { - response.Diagnostics.Append(d) - if response.Diagnostics.HasError() { - return - } + client := r.client + if err := checkBrokerRequirements(ctx, client); err != nil { + addErrorToDiagnostics(&response.Diagnostics, "Broker check failed", err) + return } sempData, err := r.converter.FromTerraform(request.Plan.Raw) @@ -241,17 +286,12 @@ func (r *brokerResource) Create(ctx context.Context, request resource.CreateRequ } var sempPath string - var id string method := http.MethodPut if r.postPathTemplate != "" { method = http.MethodPost sempPath, err = resolveSempPath(r.postPathTemplate, r.identifyingAttributes, request.Plan.Raw) - var idPath string - idPath, err = resolveSempPath(r.pathTemplate, r.identifyingAttributes, request.Plan.Raw) - id = toId(idPath) } else { sempPath, err = resolveSempPath(r.pathTemplate, r.identifyingAttributes, request.Plan.Raw) - id = toId(sempPath) } if err != nil { addErrorToDiagnostics(&response.Diagnostics, "Error generating SEMP path", err) @@ -287,16 +327,13 @@ func (r *brokerResource) Create(ctx context.Context, request resource.CreateRequ response.Private.SetKey(ctx, defaults, privatData) // Set the response response.State.Raw = request.Plan.Raw - response.State.SetAttribute(ctx, path.Root("id"), id) } func (r *brokerResource) Read(ctx context.Context, request resource.ReadRequest, response *resource.ReadResponse) { - client, d := client(r.providerData) - if d != nil { - response.Diagnostics.Append(d) - if response.Diagnostics.HasError() { - return - } + client := r.client + if err := checkBrokerRequirements(ctx, client); err != nil { + addErrorToDiagnostics(&response.Diagnostics, "Broker check failed", err) + return } sempPath, err := resolveSempPath(r.pathTemplate, r.identifyingAttributes, request.State.Raw) if err != nil { @@ -308,14 +345,11 @@ func (r *brokerResource) Read(ctx context.Context, request resource.ReadRequest, if errors.Is(err, semp.ErrResourceNotFound) { tflog.Info(ctx, fmt.Sprintf("Detected missing resource %v, removing from state", sempPath)) response.State.RemoveResource(ctx) - } else if err == semp.ErrAPIUnreachable { - addErrorToDiagnostics(&response.Diagnostics, fmt.Sprintf("SEMP call failed. HOST not reachable. %v", sempPath), err) } else { addErrorToDiagnostics(&response.Diagnostics, "SEMP call failed", err) } return } - sempData["id"] = toId(sempPath) responseData, err := r.converter.ToTerraform(sempData) if err != nil { addErrorToDiagnostics(&response.Diagnostics, "SEMP response conversion failed", err) @@ -350,12 +384,10 @@ func (r *brokerResource) Read(ctx context.Context, request resource.ReadRequest, } func (r *brokerResource) Update(ctx context.Context, request resource.UpdateRequest, response *resource.UpdateResponse) { - client, d := client(r.providerData) - if d != nil { - response.Diagnostics.Append(d) - if response.Diagnostics.HasError() { - return - } + client := r.client + if err := checkBrokerRequirements(ctx, client); err != nil { + addErrorToDiagnostics(&response.Diagnostics, "Broker check failed", err) + return } sempData, err := r.converter.FromTerraform(request.Plan.Raw) if err != nil { @@ -363,7 +395,6 @@ func (r *brokerResource) Update(ctx context.Context, request resource.UpdateRequ return } sempPath, err := resolveSempPath(r.pathTemplate, r.identifyingAttributes, request.Plan.Raw) - id := toId(sempPath) if err != nil { addErrorToDiagnostics(&response.Diagnostics, "Error generating SEMP path", err) return @@ -398,10 +429,14 @@ func (r *brokerResource) Update(ctx context.Context, request resource.UpdateRequ response.Private.SetKey(ctx, defaults, privatData) // Set the response response.State.Raw = request.Plan.Raw - response.State.SetAttribute(ctx, path.Root("id"), id) } func (r *brokerResource) Delete(ctx context.Context, request resource.DeleteRequest, response *resource.DeleteResponse) { + client := r.client + if err := checkBrokerRequirements(ctx, client); err != nil { + addErrorToDiagnostics(&response.Diagnostics, "Broker check failed", err) + return + } // don't actually do anything if the object is a singleton if r.objectType == SingletonObject { addWarningToDiagnostics(&response.Diagnostics, fmt.Sprintf("Associated state will be removed but singleton object %s cannot be deleted", r.terraformName), ErrDeleteSingletonOrDefaultsNotAllowed) @@ -413,31 +448,21 @@ func (r *brokerResource) Delete(ctx context.Context, request resource.DeleteRequ return } // don't actually do anything if the object is a default object - if toId(path) == defaultObjectName { + if toId(path) == defaultObjectName { switch r.terraformName { - case - "msg_vpn", - "msg_vpn_client_profile", - "msg_vpn_acl_profile", - "msg_vpn_client_username": - addWarningToDiagnostics(&response.Diagnostics, fmt.Sprintf("Associated state will be removed but default object %s, \"%s\" cannot be deleted", r.terraformName, toId(path)), ErrDeleteSingletonOrDefaultsNotAllowed) - return - } - } - // request delete - client, d := client(r.providerData) - if d != nil { - response.Diagnostics.Append(d) - if response.Diagnostics.HasError() { + case + "msg_vpn", + "msg_vpn_client_profile", + "msg_vpn_acl_profile", + "msg_vpn_client_username": + addWarningToDiagnostics(&response.Diagnostics, fmt.Sprintf("Associated state will be removed but default object %s, \"%s\" cannot be deleted", r.terraformName, toId(path)), ErrDeleteSingletonOrDefaultsNotAllowed) return } } + // request delete _, err = client.RequestWithoutBody(ctx, http.MethodDelete, path) if err != nil { - if err == semp.ErrAPIUnreachable { - addErrorToDiagnostics(&response.Diagnostics, fmt.Sprintf("SEMP call failed. HOST not reachable. %v", path), err) - return - } else if !errors.Is(err, semp.ErrResourceNotFound) { + if !errors.Is(err, semp.ErrResourceNotFound) { addErrorToDiagnostics(&response.Diagnostics, "SEMP call failed", err) return } diff --git a/internal/broker/schema.go b/internal/broker/schema.go index f5d896b5..ad1f1545 100644 --- a/internal/broker/schema.go +++ b/internal/broker/schema.go @@ -1,218 +1,201 @@ -// terraform-provider-solacebroker -// -// Copyright 2023 Solace Corporation. All rights reserved. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package broker - -import ( - "github.com/hashicorp/terraform-plugin-framework/datasource" - "github.com/hashicorp/terraform-plugin-framework/resource" - "github.com/hashicorp/terraform-plugin-framework/resource/schema" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/boolplanmodifier" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/int64planmodifier" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/objectplanmodifier" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" - "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" - "github.com/hashicorp/terraform-plugin-go/tftypes" - "sort" - "strings" -) - -var DataSources []func() datasource.DataSource - -var Entities []EntityInputs - -func RegisterDataSource(inputs EntityInputs) { - DataSources = append(DataSources, newBrokerDataSourceGenerator(inputs)) -} - -var Resources []func() resource.Resource - -func RegisterResource(inputs EntityInputs) { - Resources = append(Resources, newBrokerResourceGenerator(inputs)) - Entities = append(Entities, inputs) -} - -var SempDetail SempVersionDetail - -func RegisterSempVersionDetails(sempAPIBasePath string, sempVersion string) { - SempDetail = SempVersionDetail{ - BasePath: sempAPIBasePath, - SempVersion: sempVersion, - } -} - -func addObjectConverters(attributes []*AttributeInfo) { - for _, attr := range attributes { - // if it is an object, we need to add a converter for it (simple attributes will already have converters) - if attr.Attributes != nil { - addObjectConverters(attr.Attributes) - attr.Converter = NewObjectConverter(attr.TerraformName, attr.Attributes) - } - } -} - -func modifiers[T any](requiresReplace bool, f func() T) []T { - if requiresReplace { - return []T{f()} - } - return nil -} - -func terraformAttributeMap(attributes []*AttributeInfo, isResource bool, requiresReplace bool) map[string]schema.Attribute { - tfAttributes := map[string]schema.Attribute{} - for _, attr := range attributes { - if attr.TerraformName == "id" { - // Handle the id attribute for each object, required by the acceptance test framework - if isResource { - tfAttributes["id"] = schema.StringAttribute{ - Description: "Identifier attribute, for internal use only.", - Computed: true, - } - } else { - tfAttributes["id"] = schema.StringAttribute{ - Description: "Identifier attribute, for internal use only.", - Computed: true, - PlanModifiers: []planmodifier.String{ - stringplanmodifier.UseStateForUnknown(), - }, - } - } - continue - } - if attr.Sensitive && !isResource { - // write-only attributes can't be retrieved so we don't expose them in the datasource - continue - } - if !attr.Identifying && attr.ReadOnly && isResource { - // read-only attributes should only be in the datasource - continue - } - attrRequiresReplace := isResource && (requiresReplace || attr.RequiresReplace) - if len(attr.Attributes) != 0 { - childTypes := map[string]tftypes.Type{} - for _, cAttr := range attr.Attributes { - childTypes[cAttr.TerraformName] = cAttr.TerraformType - } - attr.TerraformType = tftypes.Object{ - AttributeTypes: childTypes, - } - } - var deprecationMessage string - if attr.Deprecated { - deprecationMessage = "This attribute is deprecated." - } - switch attr.BaseType { - case String: - tfAttributes[attr.TerraformName] = schema.StringAttribute{ - Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, - Required: attr.Required && isResource || attr.Identifying, - Optional: !attr.Required && isResource, - Computed: !attr.Identifying && !isResource, - Sensitive: attr.Sensitive, - DeprecationMessage: deprecationMessage, - Validators: attr.StringValidators, - PlanModifiers: modifiers[planmodifier.String](attrRequiresReplace, stringplanmodifier.RequiresReplace), - } - case Int64: - tfAttributes[attr.TerraformName] = schema.Int64Attribute{ - Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, - Required: attr.Required && isResource || attr.Identifying, - Optional: !attr.Required && isResource, - Computed: !attr.Identifying && !isResource, - Sensitive: attr.Sensitive, - DeprecationMessage: deprecationMessage, - Validators: attr.Int64Validators, - PlanModifiers: modifiers[planmodifier.Int64](attrRequiresReplace, int64planmodifier.RequiresReplace), - } - case Bool: - tfAttributes[attr.TerraformName] = schema.BoolAttribute{ - Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, - Required: attr.Required && isResource || attr.Identifying, - Optional: !attr.Required && isResource, - Computed: !attr.Identifying && !isResource, - Sensitive: attr.Sensitive, - DeprecationMessage: deprecationMessage, - Validators: attr.BoolValidators, - PlanModifiers: modifiers[planmodifier.Bool](attrRequiresReplace, boolplanmodifier.RequiresReplace), - } - case Struct: - tfAttributes[attr.TerraformName] = schema.SingleNestedAttribute{ - Attributes: terraformAttributeMap(attr.Attributes, isResource, requiresReplace || attr.RequiresReplace), - Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, - Required: attr.Required && isResource || attr.Identifying, - Optional: !attr.Required && isResource, - Computed: !attr.Identifying && !isResource, - Sensitive: attr.Sensitive, - DeprecationMessage: deprecationMessage, - PlanModifiers: modifiers[planmodifier.Object](attrRequiresReplace, objectplanmodifier.RequiresReplace), - } - } - } - return tfAttributes -} - -type EntityInputs struct { - TerraformName string - Description string - MarkdownDescription string - DeprecationMessage string - ObjectType objectType - PathTemplate string - PostPathTemplate string - Version int64 - Attributes []*AttributeInfo -} - -func newBrokerEntity(inputs EntityInputs, isResource bool) brokerEntity[schema.Schema] { - addObjectConverters(inputs.Attributes) - tfAttributes := terraformAttributeMap(inputs.Attributes, isResource, inputs.ObjectType == ReplaceOnlyObject) - var identifyingAttributes []*AttributeInfo - for _, attr := range inputs.Attributes { - if attr.Identifying { - identifyingAttributes = append(identifyingAttributes, attr) - } - } - sort.Slice(identifyingAttributes, func(i, j int) bool { - iAttr := identifyingAttributes[i] - jAttr := identifyingAttributes[j] - iIndex := strings.Index(inputs.PathTemplate, "{"+iAttr.SempName+"}") - jIndex := strings.Index(inputs.PathTemplate, "{"+jAttr.SempName+"}") - return iIndex < jIndex - }) - s := schema.Schema{ - Attributes: tfAttributes, - Description: inputs.Description, - MarkdownDescription: inputs.MarkdownDescription, - DeprecationMessage: inputs.DeprecationMessage, - Version: inputs.Version, - } - return brokerEntity[schema.Schema]{ - schema: s, - brokerEntityBase: brokerEntityBase{ - pathTemplate: inputs.PathTemplate, - postPathTemplate: inputs.PostPathTemplate, - terraformName: inputs.TerraformName, - objectType: inputs.ObjectType, - identifyingAttributes: identifyingAttributes, - attributes: inputs.Attributes, - converter: NewObjectConverter(inputs.TerraformName, inputs.Attributes), - }, - } -} +// terraform-provider-solacebroker +// +// Copyright 2023 Solace Corporation. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package broker + +import ( + "github.com/hashicorp/terraform-plugin-framework/datasource" + "github.com/hashicorp/terraform-plugin-framework/resource" + "github.com/hashicorp/terraform-plugin-framework/resource/schema" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/boolplanmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/int64planmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/objectplanmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" + "github.com/hashicorp/terraform-plugin-go/tftypes" + "sort" + "strings" +) + +var DataSources []func() datasource.DataSource + +var Entities []EntityInputs + +func RegisterDataSource(inputs EntityInputs) { + DataSources = append(DataSources, newBrokerDataSourceGenerator(inputs)) +} + +var Resources []func() resource.Resource + +func RegisterResource(inputs EntityInputs) { + Resources = append(Resources, newBrokerResourceGenerator(inputs)) + Entities = append(Entities, inputs) +} + +var SempDetail SempVersionDetail + +func RegisterSempVersionDetails(sempAPIBasePath string, sempVersion string, platform string) { + SempDetail = SempVersionDetail{ + BasePath: sempAPIBasePath, + SempVersion: sempVersion, + Platform: platform, + } +} + +func addObjectConverters(attributes []*AttributeInfo) { + for _, attr := range attributes { + // if it is an object, we need to add a converter for it (simple attributes will already have converters) + if attr.Attributes != nil { + addObjectConverters(attr.Attributes) + attr.Converter = NewObjectConverter(attr.TerraformName, attr.Attributes) + } + } +} + +func modifiers[T any](requiresReplace bool, f func() T) []T { + if requiresReplace { + return []T{f()} + } + return nil +} + +func terraformAttributeMap(attributes []*AttributeInfo, isResource bool, requiresReplace bool) map[string]schema.Attribute { + tfAttributes := map[string]schema.Attribute{} + for _, attr := range attributes { + if attr.Sensitive && !isResource { + // write-only attributes can't be retrieved so we don't expose them in the datasource + continue + } + if !attr.Identifying && attr.ReadOnly && isResource { + // read-only attributes should only be in the datasource + continue + } + attrRequiresReplace := isResource && (requiresReplace || attr.RequiresReplace) + if len(attr.Attributes) != 0 { + childTypes := map[string]tftypes.Type{} + for _, cAttr := range attr.Attributes { + childTypes[cAttr.TerraformName] = cAttr.TerraformType + } + attr.TerraformType = tftypes.Object{ + AttributeTypes: childTypes, + } + } + var deprecationMessage string + if attr.Deprecated { + deprecationMessage = "This attribute is deprecated." + } + switch attr.BaseType { + case String: + tfAttributes[attr.TerraformName] = schema.StringAttribute{ + Description: attr.Description, + MarkdownDescription: attr.MarkdownDescription, + Required: attr.Required && isResource || attr.Identifying, + Optional: !attr.Required && isResource, + Computed: !attr.Identifying && !isResource, + Sensitive: attr.Sensitive, + DeprecationMessage: deprecationMessage, + Validators: attr.StringValidators, + PlanModifiers: modifiers[planmodifier.String](attrRequiresReplace, stringplanmodifier.RequiresReplace), + } + case Int64: + tfAttributes[attr.TerraformName] = schema.Int64Attribute{ + Description: attr.Description, + MarkdownDescription: attr.MarkdownDescription, + Required: attr.Required && isResource || attr.Identifying, + Optional: !attr.Required && isResource, + Computed: !attr.Identifying && !isResource, + Sensitive: attr.Sensitive, + DeprecationMessage: deprecationMessage, + Validators: attr.Int64Validators, + PlanModifiers: modifiers[planmodifier.Int64](attrRequiresReplace, int64planmodifier.RequiresReplace), + } + case Bool: + tfAttributes[attr.TerraformName] = schema.BoolAttribute{ + Description: attr.Description, + MarkdownDescription: attr.MarkdownDescription, + Required: attr.Required && isResource || attr.Identifying, + Optional: !attr.Required && isResource, + Computed: !attr.Identifying && !isResource, + Sensitive: attr.Sensitive, + DeprecationMessage: deprecationMessage, + Validators: attr.BoolValidators, + PlanModifiers: modifiers[planmodifier.Bool](attrRequiresReplace, boolplanmodifier.RequiresReplace), + } + case Struct: + tfAttributes[attr.TerraformName] = schema.SingleNestedAttribute{ + Attributes: terraformAttributeMap(attr.Attributes, isResource, requiresReplace || attr.RequiresReplace), + Description: attr.Description, + MarkdownDescription: attr.MarkdownDescription, + Required: attr.Required && isResource || attr.Identifying, + Optional: !attr.Required && isResource, + Computed: !attr.Identifying && !isResource, + Sensitive: attr.Sensitive, + DeprecationMessage: deprecationMessage, + PlanModifiers: modifiers[planmodifier.Object](attrRequiresReplace, objectplanmodifier.RequiresReplace), + } + } + } + return tfAttributes +} + +type EntityInputs struct { + TerraformName string + Description string + MarkdownDescription string + DeprecationMessage string + ObjectType objectType + PathTemplate string + PostPathTemplate string + Version int64 + Attributes []*AttributeInfo +} + +func newBrokerEntity(inputs EntityInputs, isResource bool) brokerEntity[schema.Schema] { + addObjectConverters(inputs.Attributes) + tfAttributes := terraformAttributeMap(inputs.Attributes, isResource, inputs.ObjectType == ReplaceOnlyObject) + var identifyingAttributes []*AttributeInfo + for _, attr := range inputs.Attributes { + if attr.Identifying { + identifyingAttributes = append(identifyingAttributes, attr) + } + } + sort.Slice(identifyingAttributes, func(i, j int) bool { + iAttr := identifyingAttributes[i] + jAttr := identifyingAttributes[j] + iIndex := strings.Index(inputs.PathTemplate, "{"+iAttr.SempName+"}") + jIndex := strings.Index(inputs.PathTemplate, "{"+jAttr.SempName+"}") + return iIndex < jIndex + }) + s := schema.Schema{ + Attributes: tfAttributes, + Description: inputs.Description, + MarkdownDescription: inputs.MarkdownDescription, + DeprecationMessage: inputs.DeprecationMessage, + Version: inputs.Version, + } + return brokerEntity[schema.Schema]{ + schema: s, + brokerEntityBase: brokerEntityBase{ + pathTemplate: inputs.PathTemplate, + postPathTemplate: inputs.PostPathTemplate, + terraformName: inputs.TerraformName, + objectType: inputs.ObjectType, + identifyingAttributes: identifyingAttributes, + attributes: inputs.Attributes, + converter: NewObjectConverter(inputs.TerraformName, inputs.Attributes), + }, + } +} diff --git a/internal/broker/sempversion.go b/internal/broker/sempversion.go index 42b2b1e5..ceb416f3 100644 --- a/internal/broker/sempversion.go +++ b/internal/broker/sempversion.go @@ -17,6 +17,7 @@ package broker type SempVersionDetail struct { - BasePath string - SempVersion string + BasePath string + SempVersion string + Platform string } diff --git a/internal/broker/testacc/datasource_test.go b/internal/broker/testacc/datasource_test.go index aa38b286..64258698 100644 --- a/internal/broker/testacc/datasource_test.go +++ b/internal/broker/testacc/datasource_test.go @@ -17,29 +17,55 @@ package acctest import ( + "context" "testing" + "terraform-provider-solacebroker/internal/broker" + + fwredatasource "github.com/hashicorp/terraform-plugin-framework/datasource" "github.com/hashicorp/terraform-plugin-testing/helper/resource" ) func TestAccDataSource(t *testing.T) { - resource.Test(t, resource.TestCase{ - PreCheck: func() { testAccPreCheck(t) }, - ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, - Steps: []resource.TestStep{ - // Read testing - { - Config: ProviderConfig + ` + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + ProtoV6ProviderFactories: testAccProtoV6ProviderFactories, + Steps: []resource.TestStep{ + // Read testing + { + Config: ProviderConfig + ` data "solacebroker_msg_vpn" "default" { msg_vpn_name = "default" } `, - Check: resource.ComposeAggregateTestCheckFunc( - resource.TestCheckResourceAttr("data.solacebroker_msg_vpn.default", "authentication_basic_enabled", "true"), - ), - }, - }, - }) + Check: resource.ComposeAggregateTestCheckFunc( + resource.TestCheckResourceAttr("data.solacebroker_msg_vpn.default", "authentication_basic_enabled", "true"), + ), + }, + }, + }) } +func TestAllDataSourceSchemas(t *testing.T) { + t.Parallel() + + for _, dataSource := range broker.DataSources { + ctx := context.Background() + schemaRequest := fwredatasource.SchemaRequest{} + schemaResponse := &fwredatasource.SchemaResponse{} + + // Instantiate the resource.Resource and call its Schema method + dataSource().Schema(ctx, schemaRequest, schemaResponse) + if schemaResponse.Diagnostics.HasError() { + t.Fatalf("Schema method diagnostics: %+v", schemaResponse.Diagnostics) + } + + // Validate the schema + diagnostics := schemaResponse.Schema.ValidateImplementation(ctx) + + if diagnostics.HasError() { + t.Fatalf("Schema validation diagnostics: %+v", diagnostics) + } + } +} diff --git a/internal/broker/testacc/provider_test.go b/internal/broker/testacc/provider_test.go index 825c6395..2ba04665 100644 --- a/internal/broker/testacc/provider_test.go +++ b/internal/broker/testacc/provider_test.go @@ -29,76 +29,81 @@ import ( "github.com/testcontainers/testcontainers-go" "github.com/testcontainers/testcontainers-go/wait" - _ "terraform-provider-solacebroker/internal/broker/generated" - + "terraform-provider-solacebroker/internal/broker/generated" ) var ProviderConfig string var ( - // testAccProtoV6ProviderFactories are used to instantiate a provider during - // acceptance testing. The factory function will be invoked for every Terraform - // CLI command executed to create a provider server to which the CLI can - // reattach. - testAccProtoV6ProviderFactories = map[string]func() (tfprotov6.ProviderServer, error){ - "solacebroker": providerserver.NewProtocol6WithError(broker.New("test")()), - } + // testAccProtoV6ProviderFactories are used to instantiate a provider during + // acceptance testing. The factory function will be invoked for every Terraform + // CLI command executed to create a provider server to which the CLI can + // reattach. + testAccProtoV6ProviderFactories = map[string]func() (tfprotov6.ProviderServer, error){ + "solacebroker": providerserver.NewProtocol6WithError(broker.New("test")()), + } ) func init() { - // start docker test broker - ctx := context.Background() - req := testcontainers.ContainerRequest{ - Image: "solace/solace-pubsub-standard:latest", - ExposedPorts: []string{"8080/tcp"}, - Env: map[string]string{ - "username_admin_globalaccesslevel": "admin", - "username_admin_password": "admin", - "system_scaling_maxconnectioncount": "100", - }, - Mounts: testcontainers.ContainerMounts{ - { - Source: testcontainers.GenericVolumeMountSource{ - Name: "test-volume", - }, - Target: "/var/lib/solace", - }, - }, - ShmSize: 1000000000, - WaitingFor: wait.ForHTTP("/").WithPort("8080/tcp"), - } - solaceC, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{ - ContainerRequest: req, - Started: true, - }) - if err != nil { - panic(err) - } - endpoint, err := solaceC.Endpoint(ctx, "") - if err != nil { - panic(err) - } - ProviderConfig = ` + // start docker test broker + ctx := context.Background() + req := testcontainers.ContainerRequest{ + Image: "solace/solace-pubsub-standard:latest", + ExposedPorts: []string{"8080/tcp"}, + Env: map[string]string{ + "username_admin_globalaccesslevel": "admin", + "username_admin_password": "admin", + "system_scaling_maxconnectioncount": "100", + }, + Mounts: testcontainers.ContainerMounts{ + { + Source: testcontainers.GenericVolumeMountSource{ + Name: "test-volume", + }, + Target: "/var/lib/solace", + }, + }, + ShmSize: 1000000000, + WaitingFor: wait.ForHTTP("/").WithPort("8080/tcp"), + } + solaceC, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{ + ContainerRequest: req, + Started: true, + }) + if err != nil { + panic(err) + } + endpoint, err := solaceC.Endpoint(ctx, "") + if err != nil { + panic(err) + } + ProviderConfig = ` provider "solacebroker" { username = "admin" password = "admin" url = "http://` + endpoint + `" } ` - const user = "admin" - const password = "admin" + const user = "admin" + const password = "admin" + + if err = os.Setenv("SOLACEBROKER_URL", "http://"+endpoint); err != nil { + panic(err) + } - if err = os.Setenv("SOLACEBROKER_URL", "http://" + endpoint); err != nil { - panic(err) - } + if err = os.Setenv("SOLACEBROKER_USERNAME", user); err != nil { + panic(err) + } - if err = os.Setenv("SOLACEBROKER_USERNAME", password); err != nil { - panic(err) - } + if err = os.Setenv("SOLACEBROKER_PASSWORD", password); err != nil { + panic(err) + } - if err = os.Setenv("SOLACEBROKER_PASSWORD", password); err != nil { - panic(err) - } + if generated.Platform == "Appliance" { + if err = os.Setenv("SOLACEBROKER_SKIP_API_CHECK", "true"); err != nil { + panic(err) + } + } } func testAccPreCheck(t *testing.T) { diff --git a/internal/broker/testacc/resource_test.go b/internal/broker/testacc/resource_test.go index 45d1d3fa..ff80dcfd 100644 --- a/internal/broker/testacc/resource_test.go +++ b/internal/broker/testacc/resource_test.go @@ -17,8 +17,12 @@ package acctest import ( + "context" "testing" + "terraform-provider-solacebroker/internal/broker" + + fwresource "github.com/hashicorp/terraform-plugin-framework/resource" "github.com/hashicorp/terraform-plugin-testing/helper/resource" ) @@ -34,6 +38,9 @@ resource "solacebroker_msg_vpn" "test" { msg_vpn_name = "test" enabled = true max_msg_spool_usage = 5 + max_egress_flow_count = 997 + max_endpoint_count = 998 + max_ingress_flow_count = 999 } `, Check: resource.ComposeAggregateTestCheckFunc( @@ -48,6 +55,9 @@ resource "solacebroker_msg_vpn" "test" { msg_vpn_name = "test" enabled = true max_msg_spool_usage = 10 + max_egress_flow_count = 997 + max_endpoint_count = 998 + max_ingress_flow_count = 999 } `, Check: resource.ComposeAggregateTestCheckFunc( @@ -57,12 +67,15 @@ resource "solacebroker_msg_vpn" "test" { }, // ImportState testing { - ResourceName: "solacebroker_msg_vpn.test", - ImportState: true, - ImportStateVerify: true, + ResourceName: "solacebroker_msg_vpn.test", + ImportState: true, + ImportStateId: "test", + ImportStateVerifyIdentifierAttribute: "msg_vpn_name", + ImportStateVerify: true, ImportStateVerifyIgnore: []string{ // These attributes need to be ignored from the test as they have broker-defaults and cannot be imported so that state will be null "max_connection_count", + "max_kafka_broker_connection_count", "max_subscription_count", "max_transacted_session_count", "max_transaction_count", @@ -79,3 +92,27 @@ resource "solacebroker_msg_vpn" "test" { }, }) } + +func TestAllResourceSchemas(t *testing.T) { + t.Parallel() + + for _, resource := range broker.Resources { + ctx := context.Background() + schemaRequest := fwresource.SchemaRequest{} + schemaResponse := &fwresource.SchemaResponse{} + + // Instantiate the resource.Resource and call its Schema method + resource().Schema(ctx, schemaRequest, schemaResponse) + + if schemaResponse.Diagnostics.HasError() { + t.Fatalf("Schema method diagnostics: %+v", schemaResponse.Diagnostics) + } + + // Validate the schema + diagnostics := schemaResponse.Schema.ValidateImplementation(ctx) + + if diagnostics.HasError() { + t.Fatalf("Schema validation diagnostics: %+v", diagnostics) + } + } +} diff --git a/internal/broker/utilities.go b/internal/broker/utilities.go index 023751f1..513e5214 100644 --- a/internal/broker/utilities.go +++ b/internal/broker/utilities.go @@ -172,15 +172,19 @@ func client(providerData *providerData) (*semp.Client, diag.Diagnostic) { if err != nil { return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) } - insecure_skip_verify, err := booleanWithDefaultFromEnv(providerData.InsecureSkipVerify, "insecure_skip_verify", false) + insecureSkipVerify, err := booleanWithDefaultFromEnv(providerData.InsecureSkipVerify, "insecure_skip_verify", false) if err != nil { return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) } url = getFullSempAPIURL(url) + skipApiCheck, err = booleanWithDefaultFromEnv(providerData.SkipApiCheck, "skip_api_check", false) // This variable is used in resource + if err != nil { + return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) + } client := semp.NewClient( url, - insecure_skip_verify, - Cookiejar, + insecureSkipVerify, + true, // this is a client for the provider semp.BasicAuth(username, password), semp.BearerToken(bearerToken), semp.Retries(uint(retries), retryMinInterval, retryMaxInterval), diff --git a/internal/semp/client.go b/internal/semp/client.go index a888d527..0ad949b9 100644 --- a/internal/semp/client.go +++ b/internal/semp/client.go @@ -23,6 +23,7 @@ import ( "encoding/json" "errors" "fmt" + "github.com/hashicorp/go-retryablehttp" "io" "net/http" "net/http/cookiejar" @@ -35,13 +36,14 @@ import ( var ( ErrResourceNotFound = errors.New("Resource not found") ErrBadRequest = errors.New("Bad request") - ErrAPIUnreachable = errors.New("SEMP API unreachable") ) var cookieJar, _ = cookiejar.New(nil) +var firstRequest = true + type Client struct { - *http.Client + *retryablehttp.Client url string username string password string @@ -50,6 +52,7 @@ type Client struct { retryMinInterval time.Duration retryMaxInterval time.Duration requestMinInterval time.Duration + requestTimeout time.Duration rateLimiter <-chan time.Time } @@ -80,19 +83,23 @@ func Retries(numRetries uint, retryMinInterval, retryMaxInterval time.Duration) func RequestLimits(requestTimeoutDuration, requestMinInterval time.Duration) Option { return func(client *Client) { - client.Client.Timeout = requestTimeoutDuration + client.requestTimeout = requestTimeoutDuration client.requestMinInterval = requestMinInterval } } -func NewClient(url string, insecure_skip_verify bool, cookiejar http.CookieJar, options ...Option) *Client { - customTransport := http.DefaultTransport.(*http.Transport) - customTransport.TLSClientConfig = &tls.Config{InsecureSkipVerify: insecure_skip_verify} +func NewClient(url string, insecure_skip_verify bool, providerClient bool, options ...Option) *Client { + tr := &http.Transport{ + TLSClientConfig: &tls.Config{InsecureSkipVerify: insecure_skip_verify}, + MaxIdleConnsPerHost: 10, + } + retryClient := retryablehttp.NewClient() + retryClient.HTTPClient.Transport = tr + if !providerClient { + retryClient.Logger = nil + } client := &Client{ - Client: &http.Client{ - Transport: customTransport, - Jar: cookiejar, - }, + Client: retryClient, url: url, retries: 3, retryMinInterval: time.Second, @@ -101,6 +108,11 @@ func NewClient(url string, insecure_skip_verify bool, cookiejar http.CookieJar, for _, o := range options { o(client) } + client.Client.RetryMax = int(client.retries) + client.Client.RetryWaitMin = client.retryMinInterval + client.Client.RetryWaitMax = client.retryMaxInterval + client.HTTPClient.Timeout = client.requestTimeout + client.HTTPClient.Jar, _ = cookiejar.New(nil) if client.requestMinInterval > 0 { client.rateLimiter = time.NewTicker(client.requestMinInterval).C } else { @@ -110,7 +122,7 @@ func NewClient(url string, insecure_skip_verify bool, cookiejar http.CookieJar, close(ch) client.rateLimiter = ch } - + firstRequest = true return client } @@ -124,16 +136,21 @@ func (c *Client) RequestWithBody(ctx context.Context, method, url string, body a return nil, err } dumpData(ctx, fmt.Sprintf("%v to %v", request.Method, request.URL), data) - rawBody, err := c.doRequest(request) + rawBody, err := c.doRequest(ctx, request) if err != nil { return nil, err } return parseResponseAsObject(ctx, request, rawBody) } -func (c *Client) doRequest(request *http.Request) ([]byte, error) { - // the value doesn't matter, it is waiting for the value that matters - <-c.rateLimiter +func (c *Client) doRequest(ctx context.Context, request *http.Request) ([]byte, error) { + if !firstRequest { + // the value doesn't matter, it is waiting for the value that matters + <-c.rateLimiter + } else { + // only skip rate limiter for the first request + firstRequest = false + } if request.Method != http.MethodGet { request.Header.Set("Content-Type", "application/json") } @@ -146,49 +163,20 @@ func (c *Client) doRequest(request *http.Request) ([]byte, error) { } else { return nil, fmt.Errorf("either username or bearer token must be provided to access the broker") } - attemptsRemaining := c.retries + 1 - retryWait := c.retryMinInterval var response *http.Response var err error -loop: - for attemptsRemaining != 0 { - response, err = c.Do(request) - if err != nil { - response = nil // make sure response is nil - } else { - switch response.StatusCode { - case http.StatusOK: - break loop - case http.StatusBadRequest: - break loop - case http.StatusTooManyRequests: - // ignore the too many requests body and any errors that happen while reading it - _, _ = io.ReadAll(response.Body) - // just continue - default: - // ignore errors while reading the error response body - body, _ := io.ReadAll(response.Body) - return nil, fmt.Errorf("unexpected status %v (%v) during %v to %v, body:\n%s", response.StatusCode, response.Status, request.Method, request.URL, body) - } - } - time.Sleep(retryWait) - retryWait *= 2 - if retryWait > c.retryMaxInterval { - retryWait = c.retryMaxInterval - } - attemptsRemaining-- - } - if response == nil { + response, err = c.StandardClient().Do(request) + if err != nil || response == nil { return nil, err } - rawBody, _ := io.ReadAll(response.Body) - if response.StatusCode != http.StatusOK && response.StatusCode != http.StatusBadRequest { + defer response.Body.Close() + rawBody, err := io.ReadAll(response.Body) + if err != nil || (response.StatusCode != http.StatusOK && response.StatusCode != http.StatusBadRequest) { return nil, fmt.Errorf("could not perform request: status %v (%v) during %v to %v, response body:\n%s", response.StatusCode, response.Status, request.Method, request.URL, rawBody) } if _, err := io.Copy(io.Discard, response.Body); err != nil { - return nil, fmt.Errorf("could not perform request: status %v (%v) during %v to %v, response body:\n%s", response.StatusCode, response.Status, request.Method, request.URL, rawBody) + return nil, fmt.Errorf("response processing error: during %v to %v", request.Method, request.URL) } - defer response.Body.Close() return rawBody, nil } @@ -279,7 +267,7 @@ func (c *Client) RequestWithoutBody(ctx context.Context, method, url string) (ma return nil, err } tflog.Debug(ctx, fmt.Sprintf("===== %v to %v =====", request.Method, request.URL)) - rawBody, err := c.doRequest(request) + rawBody, err := c.doRequest(ctx, request) if err != nil { return nil, err } @@ -291,7 +279,7 @@ func (c *Client) RequestWithoutBodyForGenerator(ctx context.Context, basePath st if err != nil { return nil, err } - rawBody, err := c.doRequest(request) + rawBody, err := c.doRequest(ctx, request) if err != nil { return nil, err } diff --git a/main.go b/main.go index 7ba2ba7e..c85ab325 100644 --- a/main.go +++ b/main.go @@ -41,6 +41,10 @@ var ( ) func main() { + if broker.SempDetail.Platform != expectedPlatform { + fmt.Println(fmt.Sprintf("Provider error: wrong platform SEMP API spec \"%s\" used, expected \"%s\"", broker.SempDetail.Platform, expectedPlatform)) + os.Exit(1) + } broker.ProviderVersion = version if len(os.Args) > 1 && (os.Args[1] == "generate" || os.Args[1] == "help" || os.Args[1] == "--help" || os.Args[1] == "-h" || os.Args[1] == "version") { err := cmd.Execute() diff --git a/source-address.go b/source-address.go index 889d866e..052fd7f2 100644 --- a/source-address.go +++ b/source-address.go @@ -19,3 +19,4 @@ package main const providerNamespace = "solaceproducts" const providerSimpleType = "solacebroker" const providerType = providerSimpleType +const expectedPlatform = "VMR" diff --git a/templates/guides/config-generator.md b/templates/guides/config-generator.md index 7dec49be..ad37052a 100644 --- a/templates/guides/config-generator.md +++ b/templates/guides/config-generator.md @@ -16,18 +16,20 @@ You can run the provider binary directly with the `generate` command to generate - `` is the broker provider binary. - `` is the broker address, for example `https://mybroker.example.org:1943/`. -- `` are the similar to the Terraform Import command. This is the resource name and possible values to find a specific resource. +- `` is similar to the Terraform Import command. This is the resource name and possible values to find a specific resource. - `` is the desirable name of the generated filename. - There are also supported options, which mirror the configuration options for the provider object. These can be found [here](#supported-options). +This generator supports configuring software event brokers and will fail if applied against an appliance. This check may be overridden by setting the `SOLACEBROKER_SKIP_API_CHECK=true` environment variable. + ## Important notes -The generated configuration shoud be reviewed for followings: +You should review the generated configuration for the following: -* Provider configuration values (url, username, etc.) may need to be updated. -* Write-only attributes, such as passwords, are omitted from the config as they cannot be read from the broker configuration. They need to be added manually. -* Default resources may be present that may be omitted. -* The generator uses a naming scheme for the resources. This may be updated by manually replacing the generated names. +* You may need to update provider configuration values (URL, username, etc.) +* Write-only attributes, such as passwords, are omitted from the config as they cannot be read from the broker configuration. You need to add them manually. +* Default resources may be present that you can omit. +* The generator uses a naming scheme for the resources. You can update this by manually replacing the generated names. ## Usage @@ -43,9 +45,8 @@ help Help about any command version Provides version information about the current binary ``` -To `generate` the configuration, make sure all ENVIRONMENT VARIABLES, which mirrors the configuration options for the -provider object are set. The list of variables -are listed [here](#supported-options). +To `generate` the configuration, make sure all ENVIRONMENT VARIABLES, which mirror the configuration options for the +provider object are set. You can find the list of variables [here](#supported-options). For example: `SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=admin terraform-provider-solacebroker generate --url=https://localhost:8080 solacebroker_msg_vpn.mq default my-messagevpn.tf` @@ -63,22 +64,23 @@ Message VPN, `default`, assuming a msg_vpn_queue resource called `test` exists f ### Supported Options -The following parameters can be set as ENVIRONMENT VARIABLES. When used as environment variables -each parameter must be preceded with _SOLACEBROKER__. For example for a PubSub+ broker using username and password +The following parameters can be set as ENVIRONMENT VARIABLES. When used as an environment variable, +each parameter must be preceded with _SOLACEBROKER__. An example for a PubSub+ broker using username and password _**admin/password**_ would be: `SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=password` -- `bearer_token`, (String, Sensitive, Mandatory if `password` will not be provided) -- `insecure_skip_verify` (Boolean) Disable validation of server SSL certificates, accept/ignore self-signed. -- `password` (String, Sensitive, Mandatory is `bearer_token` will not be provided) -- `request_min_interval` (String) -- `request_timeout_duration` (String) -- `retries` (Number) -- `retry_max_interval` (String) -- `retry_min_interval` (String) -- `username` (String, Mandatory) The username for the broker request. +- `SOLACEBROKER_BEARER_TOKEN` (String, Sensitive, Mandatory if `password` not provided) +- `SOLACEBROKER_INSECURE_SKIP_VERIFY` (Boolean) Disable validation of server SSL certificates, accept/ignore self-signed. +- `SOLACEBROKER_PASSWORD` (String, Sensitive, Mandatory if `bearer_token` not provided) +- `SOLACEBROKER_REQUEST_MIN_INTERVAL` (String) +- `SOLACEBROKER_REQUEST_TIMEOUT_DURATION` (String) +- `SOLACEBROKER_RETRIES` (Number) +- `SOLACEBROKER_RETRY_MAX_INTERVAL` (String) +- `SOLACEBROKER_RETRY_MIN_INTERVAL` (String) +- `SOLACEBROKER_SKIP_API_CHECK` (String) Disable validation of the broker SEMP API for supported platform and minimum version. +- `SOLACEBROKER_USERNAME` (String, Mandatory) The username for the broker request. ## Troubleshooting @@ -86,8 +88,8 @@ The following issues may arise while using the generator. | Error | SEMP call failed. unexpected status 401 (401 Unauthorized) | |-----------------|----------------------------------------------------------------------------| -| Explanation | Configurations to connect to the PubSub+ Broker not accurate. | -| Possible Action | Check and confirm, configuration details to PubSub+ Broker are accurate. | +| Explanation | Configurations to connect to the PubSub+ broker not accurate. | +| Possible Action | Check and confirm, configuration details to PubSub+ broker are accurate. | | Error | SOLACEBROKER_xxx is mandatory but not available | |-----------------|------------------------------------------------------------------------------------| @@ -108,3 +110,8 @@ The following issues may arise while using the generator. |-----------------|------------------------------------------------------------------------------------------------------------| | Explanation | This indicates the resource by name _xxx_ is not recognized by the generator. | | Possible Action | Ensure the resource name used is available as a Terraform resource for the version of the provider in use. | + +| Error | Error: Broker check failed | +|-----------------|-------------------------------------------------------------------------------------------------------------| +| Explanation | This indicates that broker platform does not match provider supported platform | +| Possible Action | Ensure that an appliance provider is used against a software broker platform and not an appliance platform. | diff --git a/templates/guides/provider.md b/templates/guides/provider.md index 49d6411b..a86fe4e0 100644 --- a/templates/guides/provider.md +++ b/templates/guides/provider.md @@ -6,7 +6,9 @@ page_title: "Solacebroker Provider Guide" The `solacebroker` provider supports Terraform CLI operations including basic CRUD (create, read, update, and delete) and import. -The provider leverages the [SEMP (Solace Element Management Protocol)](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) REST API to configure the PubSub+ event broker. The API reference is available from the [Solace PubSub+ Documentation](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.html). +The provider leverages the [SEMP (Solace Element Management Protocol)](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) REST API to configure the PubSub+ event broker. The API reference is available from the [Solace PubSub+ documentation](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/appliance/config/index.html). + +This provider supports configuring software event brokers and will fail if applied against an appliance. This check may be overridden by specifying the `skip_api_check = true` configuration argument. ## Mapping of SEMP API and Provider Names @@ -34,7 +36,7 @@ A given version of the provider is built to support a specific version of the SE ## Object Relationships -Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "Identifying" attributes that give a hint to required already configured objects. +Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "Identifying" attributes that give a hint to required pre-existing objects. For example: ```terraform @@ -70,9 +72,7 @@ Some attributes don't have a default value. In this case their value will be det ## Importing Resources -When [importing resources to Terraform](https://developer.hashicorp.com/terraform/language/import#syntax) an `id` is required. Note that this `id` is not the same as the internal `id` attribute of resources. - -The `id` to be used shall be constructed as a path from the highest parent object down to the resource. +When [importing resources to Terraform](https://developer.hashicorp.com/terraform/language/import#syntax) an `id` is required. This `id` shall be constructed as a path from the highest parent object down to the resource. For example, when importing a `solacebroker_msg_vpn_queue_subscription`, the parent relationship is `msg_vpn` > `msg_vpn_queue` > `msg_vpn_queue_subscription`. To construct the `id`, concatenate the identifications of parents and the particular resource identification, separated by `/` (slash). Also note that elements containing `/` must be URL-encoded. diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 43c31147..1ef047fb 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -32,9 +32,9 @@ The minimum required PubSub+ Software Event Broker version is 10.4. {{ .SchemaMarkdown | trimspace }} --> All provider configuration values can also be set as environment variables with the same name but uppercase and with the `SOLACEBROKER_` prefix. +-> All provider configuration values can also be set as environment variables with the same name, but uppercase and with the `SOLACEBROKER_` prefix. For example, the password attribute can be set via the `SOLACEBROKER_PASSWORD` environment variable. Values in the configuration take precedence over environment variables. # Release Notes and History -For detailed Release Notes and release history, refer to the Releases section in the [Provider GitHub repository](https://github.com/SolaceProducts/terraform-provider-solacebroker/releases). +For detailed release notes and release history, refer to the Releases section in the [Provider GitHub repository](https://github.com/SolaceProducts/terraform-provider-solacebrokerappliance/releases). diff --git a/third-party-licenses.txt b/third-party-licenses.txt index 4fdca7dc..140fc05f 100644 --- a/third-party-licenses.txt +++ b/third-party-licenses.txt @@ -15,12 +15,12 @@ Solace THIRD-PARTY SOFTWARE USED ========================= -github.com/Fatih/Color-v1.15.0 +github.com/Fatih/color-v1.13.0 ------------------------------ Licensed under MIT Copyright 2013 Copyright 2013 Fatih Arslan -Home page: https://pkg.go.dev/github.com/Fatih/Color@v1.15.0 +Home page: https://pkg.go.dev/github.com/Fatih/color@v1.13.0 github.com/golang/Protobuf-v1.5.3 --------------------------------- @@ -35,6 +35,12 @@ Licensed under Mozilla 2.0 Copyright 2014 HashiCorp, Inc Home page: https://pkg.go.dev/github.com/hashicorp/go-Version@v1.6.0 +github.com/hashicorp/go-cleanhttp-v0.5.2 +---------------------------------------- +Licensed under Mozilla 2.0 +No copyright. +Home page: https://pkg.go.dev/github.com/hashicorp/go-cleanhttp@v0.5.2 + github.com/hashicorp/go-hcLog-v1.5.0 ------------------------------------ Licensed under MIT @@ -42,12 +48,19 @@ Copyright 2017 Copyright 2017 HashiCorp, Inc Home page: https://pkg.go.dev/github.com/hashicorp/go-hcLog@v1.5.0 -github.com/hashicorp/go-plugin-v1.4.10 --------------------------------------- +github.com/hashicorp/go-plugin-v1.5.1 +------------------------------------- Licensed under Mozilla 2.0 Copyright 2016 Copyright 2016 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/go-plugin@v1.4.10 +Home page: https://pkg.go.dev/github.com/hashicorp/go-plugin@v1.5.1 + +github.com/hashicorp/go-retryablehttp-v0.7.5 +-------------------------------------------- +Licensed under Mozilla 2.0 +Copyright 2015 +Copyright 2015 HashiCorp, Inc +Home page: https://pkg.go.dev/github.com/hashicorp/go-retryablehttp@v0.7.5 github.com/hashicorp/go-uuid-v1.0.3 ----------------------------------- @@ -56,26 +69,26 @@ Copyright 2015-2022 Copyright 2015-2022 HashiCorp, Inc Home page: https://pkg.go.dev/github.com/hashicorp/go-uuid@v1.0.3 -github.com/hashicorp/terraform-plugin-framework-v1.3.2 +github.com/hashicorp/terraform-plugin-framework-v1.4.2 ------------------------------------------------------ Licensed under Mozilla 2.0 Copyright 2021 Copyright 2021 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework@v1.3.2 +Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework@v1.4.2 -github.com/hashicorp/terraform-plugin-framework-validators-v0.10.0 +github.com/hashicorp/terraform-plugin-framework-validators-v0.12.0 ------------------------------------------------------------------ Licensed under Mozilla 2.0 Copyright 2022 Copyright 2022 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-validators@v0.10.0 +Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-validators@v0.12.0 -github.com/hashicorp/terraform-plugin-go-v0.18.0 +github.com/hashicorp/terraform-plugin-go-v0.19.0 ------------------------------------------------ Licensed under Mozilla 2.0 Copyright 2020 Copyright 2020 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go@v0.18.0 +Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go@v0.19.0 github.com/hashicorp/terraform-plugin-log-v0.9.0 ------------------------------------------------ @@ -84,12 +97,12 @@ Copyright 2021 Copyright 2021 HashiCorp, Inc Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-log@v0.9.0 -github.com/hashicorp/terraform-registry-address-v0.2.1 +github.com/hashicorp/terraform-registry-address-v0.2.2 ------------------------------------------------------ Licensed under Mozilla 2.0 Copyright 2021 Copyright 2021 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/terraform-registry-address@v0.2.1 +Home page: https://pkg.go.dev/github.com/hashicorp/terraform-registry-address@v0.2.2 github.com/hashicorp/terraform-svchost-v0.1.1 --------------------------------------------- @@ -111,11 +124,11 @@ Copyright 2016 Copyright 2016 Yasuhiro Matsumoto Home page: https://pkg.go.dev/github.com/mattn/go-coLorabLe@v0.1.13 -github.com/mattn/go-isatty-v0.0.19 +github.com/mattn/go-isatty-v0.0.16 ---------------------------------- Licensed under MIT Copyright Yasuhiro MATSUMOTO -Home page: https://pkg.go.dev/github.com/mattn/go-isatty@v0.0.19 +Home page: https://pkg.go.dev/github.com/mattn/go-isatty@v0.0.16 github.com/mitchellh/go-testing-interface-v1.14.1 ------------------------------------------------- @@ -130,11 +143,10 @@ Licensed under Apache 2.0 No copyright. Home page: https://pkg.go.dev/github.com/oklog/Run@v1.0.0 -github.com/spf13/COBRA-v1.7.0 +github.com/spf13/cobra-v1.8.0 ----------------------------- Licensed under Apache 2.0 -No copyright. -Home page: https://pkg.go.dev/github.com/spf13/COBRA@v1.7.0 +Home page: https://pkg.go.dev/github.com/spf13/cobra@v1.8.0 github.com/spf13/pflag-v1.0.5 ----------------------------- @@ -158,33 +170,33 @@ Copyright 2019 Copyright 2019 The github.com/vmihailenco/tagparser Authors Home page: https://pkg.go.dev/github.com/vmihailenco/tagparser/v2@v2.0.0 -golang.org/x/exp-v0.0.0-20230811145659-89c5cff77bcb +golang.org/x/exp-v0.0.0-20231006140011-7918f672742d --------------------------------------------------- Licensed under Golang BSD + Patents Copyright 2009 Copyright 2009 The Go Authors -Home page: https://pkg.go.dev/golang.org/x/exp@v0.0.0-20230811145659-89c5cff77bcb +Home page: https://pkg.go.dev/golang.org/x/exp@v0.0.0-20231006140011-7918f672742d -golang.org/x/net-v0.12.0 +golang.org/x/net-v0.17.0 ------------------------ Licensed under Golang BSD + Patents Copyright 2009 Copyright 2009 The Go Authors -Home page: https://pkg.go.dev/golang.org/x/net@v0.12.0 +Home page: https://pkg.go.dev/golang.org/x/net@v0.17.0 -golang.org/x/sys-v0.11.0 +golang.org/x/sys-v0.13.0 ------------------------ Licensed under Golang BSD + Patents Copyright 2009 Copyright 2009 The Go Authors -Home page: https://pkg.go.dev/golang.org/x/sys@v0.11.0 +Home page: https://pkg.go.dev/golang.org/x/sys@v0.13.0 -golang.org/x/text-v0.11.0 +golang.org/x/text-v0.13.0 ------------------------- Licensed under Golang BSD + Patents Copyright 2009 Copyright 2009 The Go Authors -Home page: https://pkg.go.dev/golang.org/x/text@v0.11.0 +Home page: https://pkg.go.dev/golang.org/x/text@v0.13.0 google.golang.org/genproto/googleapis/rpc-v0.0.0-20230525234030-28d5490b6b19 ---------------------------------------------------------------------------- @@ -192,12 +204,12 @@ Licensed under Apache 2.0 No copyright. Home page: https://pkg.go.dev/google.golang.org/genproto/googleapis/rpc@v0.0.0-20230525234030-28d5490b6b19 -google.golang.org/grpc-v1.57.0 +google.golang.org/grpc-v1.57.1 ------------------------------ Licensed under Apache 2.0 Copyright 2014 Copyright 2014 gRPC authors -Home page: https://pkg.go.dev/google.golang.org/grpc@v1.57.0 +Home page: https://pkg.go.dev/google.golang.org/grpc@v1.57.1 google.golang.org/protobuf-v1.31.0 ---------------------------------- @@ -931,821 +943,805 @@ Exhibit B - "Incompatible With Secondary Licenses" Notice Solace ------ -Version: 10/25/2018 +Version: 04/01/2020 SOLACE CORPORATION LICENCE AGREEMENT FOR SOLACE SOFTWARE -THIS LICENCE AGREEMENT and any documents expressly referred to in this +THIS LICENCE AGREEMENT and any documents expressly referred to in this agreement (the "Agreement") between SOLACE CORPORATION, a company incorporated under the laws of the Province of Ontario ("SOLACE") and licensee, the party identified in the Order (as defined below) or that otherwise accepts this Agreement (the "Licensee") (together the "Parties", and each a "Party"), is made on the Effective Date (as defined below). -BY ACCEPTING THE TERMS OF THIS AGREEMENT, EITHER BY: A) ACCEPTING THE -AGREEMENT ONLINE, B) SIGNING THE ORDER (AS DEFINED BELOW) WHICH REFERENCES -THIS AGREEMENT, OR C) INSTALLING OR USING THE SOFTWARE AFTER BEING MADE AWARE -OF THIS AGREEMENT, THE LICENSEE ACKNOWLEDGES THAT IT HAS READ AND UNDERSTOOD -ALL OF THE PROVISIONS, AND HAS THE AUTHORITY TO AGREE TO, AND IS CONFIRMING -THAT IT IS AGREEING TO, COMPLY WITH AND BE BOUND BY, ALL OF THE TERMS AND -CONDITIONS CONTAINED HEREIN, TOGETHER WITH THE TERMS SET FORTH IN ANY ORDER. -IF, AFTER READING THIS AGREEMENT, THE LICENSEE DOES NOT ACCEPT OR AGREE TO -THE TERMS AND CONDITIONS CONTAINED HEREIN, THE LICENSEE SHALL NOT INSTALL OR -USE THE SOFTWARE. - -IF YOU ARE AN AGENT OR EMPLOYEE OF ANOTHER ENTITY THEN YOU HEREBY REPRESENT -AND WARRANT THAT: (I) THE INDIVIDUAL ACCEPTING THIS AGREEMENT IS DULY -AUTHORIZED TO ACCEPT THIS AGREEMENT ON SUCH ENTITY'S BEHALF AND TO BIND SUCH -ENTITY, AND (II) SUCH ENTITY HAS FULL POWER, CORPORATE OR OTHERWISE, TO ENTER -INTO THIS AGREEMENT AND PERFORM ITS OBLIGATIONS HEREUNDER. +BY ACCEPTING THE TERMS OF THIS AGREEMENT, EITHER BY: A) ACCEPTING THE AGREEMENT +ONLINE, B) SIGNING THE ORDER (AS DEFINED BELOW) WHICH REFERENCES THIS +AGREEMENT, OR C) INSTALLING OR USING THE SOFTWARE AFTER BEING MADE AWARE OF +THIS AGREEMENT, THE LICENSEE ACKNOWLEDGES THAT IT HAS READ AND UNDERSTOOD ALL +OF THE PROVISIONS, AND HAS THE AUTHORITY TO AGREE TO, AND IS CONFIRMING THAT IT +IS AGREEING TO, COMPLY WITH AND BE BOUND BY, ALL OF THE TERMS AND CONDITIONS +CONTAINED HEREIN, TOGETHER WITH THE TERMS SET FORTH IN ANY ORDER. IF, AFTER +READING THIS AGREEMENT, THE LICENSEE DOES NOT ACCEPT OR AGREE TO THE TERMS AND +CONDITIONS CONTAINED HEREIN, THE LICENSEE SHALL NOT INSTALL OR USE THE +SOFTWARE. + +IF YOU ARE AN AGENT OR EMPLOYEE OF ANOTHER ENTITY THEN YOU HEREBY REPRESENT AND +WARRANT THAT: (I) THE INDIVIDUAL ACCEPTING THIS AGREEMENT IS DULY AUTHORIZED TO +ACCEPT THIS AGREEMENT ON SUCH ENTITY'S BEHALF AND TO BIND SUCH ENTITY, AND +(II) SUCH ENTITY HAS FULL POWER, CORPORATE OR OTHERWISE, TO ENTER INTO THIS +AGREEMENT AND PERFORM ITS OBLIGATIONS HEREUNDER. 1 INTERPRETATION -1.1 Definitions. In this Agreement the following terms shall have the -following meanings: +1.1 Definitions. In this Agreement the following terms shall have the following +meanings: -"Core" means (i) a single physical processor core or hyper-thread when Solace -PubSub+ software is deployed on either a bare-metal server or a cloud or -virtualization environment that presents physical cores to the software, and -(ii) a single virtual core when deployed in a cloud or virtualization +"Core" means (i) a single physical processor core or hyper-thread when +Solace PubSub+ software is deployed on either a bare-metal server or a cloud or +virtualization environment that presents physical cores to the software, and +(ii) a single virtual core when deployed in a cloud or virtualization environment that presents virtual cores to the VMR. -"Documentation" means the documentation made accessible by SOLACE via a URL -provided to Licensee. +"Documentation" means the documentation made accessible by SOLACE via a +URL provided to Licensee. -"Order" means (i) an electronic form provided by SOLACE on its website for -ordering Software Subscriptions, Professional Services, and/or Support and -Maintenance Services, or (ii) a written document, including a Licensee -purchase order, executed by SOLACE and Licensee pursuant to which Licensee -purchases of Software Subscriptions, Professional Services, and/or Support -and Maintenance Services from SOLACE. +"Order" means (i) an electronic form provided by SOLACE on its website +for ordering Software Subscriptions, Professional Services, and/or Support and +Maintenance Services, or (ii) a written document, including a Licensee purchase +order, executed by SOLACE and Licensee pursuant to which Licensee purchases of +Software Subscriptions, Professional Services, and/or Support and Maintenance +Services from SOLACE. -"Products" means the Software, Documentation, Support and Maintenance -Services, Professional Services and other products and services that are +"Products" means the Software, Documentation, Support and Maintenance +Services, Professional Services and other products and services that are ordered by Licensee from SOLACE. "Software" means the SOLACE software product(s) described in an Order. -"SOLACE Quotation" means SOLACE's sales quotation document provided by SOLACE -to a prospective customer which sets out the fees for SOLACE's Products. +"SOLACE Quotation" means SOLACE's sales quotation document provided by +SOLACE to a prospective customer which sets out the fees for SOLACE's +Products. -"Subscription" means the right granted by SOLACE to Licensee to install and -use the Software in accordance with the terms of this Agreement and the -applicable Order, for the Subscription Term specified in the applicable -Order. +"Subscription" means the right granted by SOLACE to Licensee to install +and use the Software in accordance with the terms of this Agreement and the +applicable Order, for the Subscription Term specified in the applicable Order. -"Subscription Fee" means the fee payable by Licensee for a Subscription in -accordance with the terms hereof and the applicable Order. +"Subscription Fee" means the fee payable by Licensee for a Subscription +in accordance with the terms hereof and the applicable Order. -"Subscription Term" means the period of time that Licensee is authorized by -SOLACE to install and use the Software (including the Documentation). +"Subscription Term" means the period of time that Licensee is authorized +by SOLACE to install and use the Software (including the Documentation). -"Support and Maintenance Services" means the support services provided by +"Support and Maintenance Services" means the support services provided by SOLACE for the Software in accordance with the Support and Maintenance Terms. -"Support and Maintenance Terms" means SOLACE'S policies, terms and conditions -for the provision of Support and Maintenance Services to its customers, a -copy of which is available on the SOLACE website at +"Support and Maintenance Terms" means SOLACE'S policies, terms and +conditions for the provision of Support and Maintenance Services to its +customers, a copy of which is available on the SOLACE website at https://solace.com/support. -"Statement of Work" or "SOW" shall mean a statement of work in the form -attached hereto as Schedule B pursuant to which the parties agree upon the -Professional Services to be provided by SOLACE to Licensee, the fees to be -charged, milestones, deliverables and such other terms and conditions as the +"Statement of Work" or "SOW" shall mean a statement of work in the +form attached hereto as Schedule B pursuant to which the parties agree upon the +Professional Services to be provided by SOLACE to Licensee, the fees to be +charged, milestones, deliverables and such other terms and conditions as the parties may agree upon. -1.2 Currency. Unless otherwise specified, all dollar amounts in this -Agreement, including the symbol "$", refer to United States currency. +1.2 Currency. Unless otherwise specified, all dollar amounts in this Agreement, +including the symbol "$", refer to United States currency. 2 LICENSE GRANT -2.1 General License to Software. - -(a) Provided Licensee complies with this Agreement, SOLACE hereby grants -to Licensee a non-exclusive, non-sublicensable (except as permitted in -accordance with Section 2.6 below), non-transferable, license, during the -term of this Agreement, to install and use the Software in object code form -during the applicable Subscription Term for the number of Cores specified in -the Order, solely for the Licensee's internal business purposes and in -accordance with the terms of this Agreement. - -(b) If Licensee requires a license from SOLACE to enable Licensee to -bundle or otherwise make available a Product with Licensee's own software, -such bundling will be pursuant to separate terms to be agreed. - -2.2 Documentation. Provided Licensee complies with this Agreement, -Licensee may reproduce the Documentation, for use on an internal basis only, -and solely in support of the Licensee's licensed use of the Software. -Distribution of the Documentation outside of Licensee is prohibited without -the express written permission of SOLACE. Licensee must reproduce all -copyright and other proprietary notices that are on the original copy of the -Documentation. - -2.3 Back-up Copy. In addition to the number of copies of the Software -installed and used pursuant to Section 2.1 and paid for in accordance with -Section 5, Licensee may make one copy of each licensed Product per -Subscription solely for back-up purposes, provided that Licensee reproduces -all copyright and other proprietary notices that are on the original copy of -the Software and such back-up copy is not installed or used other than for -back-up and recovery purposes. Back-up copies that are used as part of a -live or 'hot' back-up will be subject to additional fees. - -2.4 Use Restrictions. Licensee will not: (a) reverse engineer, -disassemble, decompile, or translate the Software (other than Sample -Applications), or otherwise attempt to derive the source code version of the -Software, except if and only to the extent expressly permitted by applicable -law, and provided that Licensee first approaches SOLACE and seeks permission -in writing; (b) except as expressly permitted in this Agreement, use the -Products or any portion thereof to create or develop any developer tools -(including plug-ins and middleware) or any software; (c) except as expressly -permitted in this Agreement, rent, lease, loan or otherwise in any manner -provide, transfer or distribute the Products or any part thereof to any third -party; (d) use the Software in violation of applicable laws; (e) circumvent -any user limits or other license timing or use restrictions that are built -into the Software; (f) except as expressly permitted in this Agreement, -reproduce, distribute, publicly perform, publicly display or create +2.1 General License to Software. + +(a) Provided Licensee complies with this Agreement, SOLACE hereby grants to +Licensee a non-exclusive, non-sublicensable (except as permitted in accordance +with Section 2.6 below), non-transferable, license, during the term of this +Agreement, to install and use the Software in object code form during the +applicable Subscription Term for the number of Cores specified in the Order, +solely for the Licensee's internal business purposes and in accordance with +the terms of this Agreement. + +(b) If Licensee requires a license from SOLACE to enable Licensee to bundle or +otherwise make available a Product with Licensee's own software, such +bundling will be pursuant to separate terms to be agreed. + +2.2 Documentation. Provided Licensee complies with this Agreement, Licensee may +reproduce the Documentation, for use on an internal basis only, and solely in +support of the Licensee's licensed use of the Software. Distribution of the +Documentation outside of Licensee is prohibited without the express written +permission of SOLACE. Licensee must reproduce all copyright and other +proprietary notices that are on the original copy of the Documentation. + +2.3 Back-up Copy. In addition to the number of copies of the Software +installed and used pursuant to Section 2.1 and paid for in accordance with +Section 5, Licensee may make one copy of each licensed Product per Subscription +solely for back-up purposes, provided that Licensee reproduces all copyright +and other proprietary notices that are on the original copy of the Software and +such back-up copy is not installed or used other than for back-up and recovery +purposes. Back-up copies that are used as part of a live or 'hot' +back-up will be subject to additional fees. + +2.4 Use Restrictions Licensee will not: (a) reverse engineer, disassemble, +decompile, or translate the Software (other than Sample Applications), or +otherwise attempt to derive the source code version of the Software, except if +and only to the extent expressly permitted by applicable law, and provided that +Licensee first approaches SOLACE and seeks permission in writing; (b) except as +expressly permitted in this Agreement, rent, lease, loan or otherwise in any +manner provide, transfer or distribute the Products or any part thereof to any +third party; (c) use the Software in violation of applicable laws; +d) circumvent any user limits or other license timing or use restrictions that +are built into the Software; (e) except as expressly permitted in this +Agreement, reproduce, distribute, publicly perform, publicly display or create adaptations or derivative works of or based on the Products. -2.5 Publicly Available Software. Portions of the Software include -software programs that are distributed by SOLACE pursuant to the terms and -conditions of a license granted by the copyright owner of such software -programs and which governs Customer's use of such software programs -("Publicly Available Software"). The Licensee's use of Publicly Available -Software in conjunction with the Software in a manner consistent with the -terms of this Agreement is permitted, however, the Licensee may have broader -rights under the applicable license for Publicly Available Software and -nothing contained herein is intended to impose restrictions or limitations on -the Licensee's use of the Publicly Available Software. The warranty, -indemnity and limitation of liability provisions in this Agreement will apply -to all of the Software, including Publicly Available Software included in the -Software. Copies of such Publicly Available Software license agreements are -available by contacting Licensor at support@solace.com. The source code for -certain portions of the Publicly Available Software included in the Software -(as specified in the copyright notices) is available by contacting SOLACE at -support@solcae.com within a three (3) year period from the original date of -receipt of the applicable Software or Adapter and for a fee that shall not -exceed Licensor' costs associated with the shipping of such software source -code. - -2.6 Sub-licensing. Any sub-licensing of the Software under this -Agreement must be expressly authorized by SOLACE pursuant to an Order or -otherwise in writing. Any attempt by Licensee to sub-license or otherwise -transfer the Products to a third party in breach of this restriction will be -void. Any sub-licensing that may be permitted under this Agreement by SOLACE -will be subject to such sub-licensee agreeing to substantially similar -restrictions and obligations set out in this Agreement. Licensee will be -fully liable for any breach by a sub-licensee of any restriction or -obligation, and SOLACE may bring a Claim against Licensee if SOLACE suffers -any Losses arising from such breach. - -2.7 Evaluation Licenses. - -(a) If the Software provided to Licensee under this Agreement is -designated by SOLACE in an Order or otherwise as an evaluation release -(indicated by terms such as "pre-commercial", "alpha," "beta," "trial," -"draft," "early access," "EA" or "evaluation") (each an "Evaluation Software -Release"), Licensee will have the limited right under this Agreement to -download and install the Software on the number of Cores identified in the -Order or, if not identified, one Core, for the Licensee's internal and -non-commercial evaluation of the Software. - -(b) Licensee acknowledges that the Evaluation Software Release may not -meet performance and compatibility standards of a production version. The -Evaluation Software Release may not operate correctly, may be substantially -modified by SOLACE prior to first commercial shipment, and may be withdrawn -completely and never issued for commercial use. - -(c) If Licensee desires other rights for the Evaluation Software Release, +2.5 Publicly Available Software. Portions of the Software include software +programs that are distributed by SOLACE pursuant to the terms and conditions of +a license granted by the copyright owner of such software programs and which +governs Customer's use of such software programs ("Publicly Available +Software"). The Licensee's use of Publicly Available Software in +conjunction with the Software in a manner consistent with the terms of this +Agreement is permitted, however, the Licensee may have broader rights under the +applicable license for Publicly Available Software and nothing contained herein +is intended to impose restrictions or limitations on the Licensee's use of +the Publicly Available Software. The warranty, indemnity and limitation of +liability provisions in this Agreement will apply to all of the Software, +including Publicly Available Software included in the Software. Copies of such +Publicly Available Software license agreements are available by contacting +Licensor at support@solace.com. The source code for certain portions of the +Publicly Available Software included in the Software (as specified in the +copyright notices) is available by contacting SOLACE at support@solcae.com +within a three (3) year period from the original date of receipt of the +applicable Software or Adapter and for a fee that shall not exceed Licensor' +costs associated with the shipping of such software source code. + +2.6 Sub-licensing. Any sub-licensing of the Software under this Agreement must +be expressly authorized by SOLACE pursuant to an Order or otherwise in writing. +Any attempt by Licensee to sub-license or otherwise transfer the Products to a +third party in breach of this restriction will be void. Any sub-licensing that +may be permitted under this Agreement by SOLACE will be subject to such +sub-licensee agreeing to substantially similar restrictions and obligations set +out in this Agreement. Licensee will be fully liable for any breach by a +sub-licensee of any restriction or obligation, and SOLACE may bring a Claim +against Licensee if SOLACE suffers any Losses arising from such breach. + +2.7 Evaluation Licenses. + +(a) If the Software provided to Licensee under this Agreement is designated by +SOLACE in an Order or otherwise as an evaluation release (indicated by terms +such as "pre-commercial", "alpha," "beta," "trial," +"draft," "early access," "EA" or "evaluation") (each an +"Evaluation Software Release"), Licensee will have the limited right +under this Agreement to download and install the Software on the number of +Cores identified in the Order or, if not identified, one Core, for the +Licensee's internal and non-commercial evaluation of the Software. + +(b) Licensee acknowledges that the Evaluation Software Release may not meet +performance and compatibility standards of a production version. The Evaluation +Software Release may not operate correctly, may be substantially modified by +SOLACE prior to first commercial shipment, and may be withdrawn completely and +never issued for commercial use. + +(c) If Licensee desires other rights for the Evaluation Software Release, Licensee must request from SOLACE a commercial release of the Software. - -(d) The limited use license granted in subsection (a) will automatically -expire on the earlier of: (i) the date when the Software is made available to -Licensee as a commercially available product, and (ii) the date specified in -the Order or, if no such date is identified in the Order, the date that is 30 -days after the date of delivery or provision of the Evaluation Software -Release to Licensee. Following license expiry Licensee will permanently -delete or otherwise purge such Evaluation Software Release from Licensee's -systems and, if requested by SOLACE, certify the same. - -2.8 License of APIs. Provided Licensee complies with this Agreement and -any terms that SOLACE provides, SOLACE grants to Licensee a non-exclusive, -royalty free license, during the term of this Agreement, to download, install -and use, the applicable application programming interfaces that may be made -available by SOLACE with the Software ("APIs") solely to create interfaces -between the Software and the Licensee's software or third party software on + +(d) The limited use license granted in subsection (a) will automatically expire +on the earlier of: (i) the date when the Software is made available to Licensee +as a commercially available product, and (ii) the date specified in the Order +or, if no such date is identified in the Order, the date that is 30 days after +the date of delivery or provision of the Evaluation Software Release to +Licensee. Following license expiry Licensee will permanently delete or +otherwise purge such Evaluation Software Release from Licensee's systems +and, if requested by SOLACE, certify the same. + +2.8 License of APIs. Provided Licensee complies with this Agreement and any +terms that SOLACE provides, SOLACE grants to Licensee a non-exclusive, royalty +free license, during the term of this Agreement, to download, install and use, +the applicable application programming interfaces that may be made available by +SOLACE with the Software ("APIs") solely to create interfaces between the +Software and the Licensee's software or third party software on Licensee's systems. -2.9 License to Sample Applications. +2.9 License to Sample Applications. -(a) SOLACE may, in its sole discretion, provide certain sample Software -in source code or object code form for the purposes of demonstrating certain -features enabled by the Software, including demonstrating to Licensees how to -build applications using APIs, and for use by Licensees with such APIs (each, -a "Sample Application"). +(a) SOLACE may, in its sole discretion, provide certain sample Software in +source code or object code form for the purposes of demonstrating certain +features enabled by the Software, including demonstrating to Licensees how to +build applications using APIs, and for use by Licensees with such APIs (each, a +"Sample Application"). -(b) Whether provided separately or together with other Software, if -SOLACE provides such Sample Application to Licensee, then SOLACE hereby -grants to Licensee a non-sublicensable, non-transferable, non-exclusive, -revocable license, to install such Sample Application for Licensee's -evaluation for the same duration as the Software with which the Sample -Application is associated or such other duration as specified by SOLACE upon -delivery of the Sample Application. +(b) Whether provided separately or together with other Software, if SOLACE +provides such Sample Application to Licensee, then SOLACE hereby grants to +Licensee a non-sublicensable, non-transferable, non-exclusive, revocable +license, to install such Sample Application for Licensee's evaluation for +the same duration as the Software with which the Sample Application is +associated or such other duration as specified by SOLACE upon delivery of the +Sample Application. 3 OPTIONAL SERVICES AND SUPPORT -3.1 Optional Services. Licensee acknowledge that certain optional -services, such as training, integration and development services may be -provided by SOLACE in association with the Products, and access to such -services will be provided only pursuant to a Statement of Work executed by -SOLACE and Licensee and may include separate and additional fees. +3.1 Optional Services. Licensee acknowledge that certain optional services, +such as training, integration and development services may be provided by +SOLACE in association with the Products, and access to such services will be +provided only pursuant to a Statement of Work executed by SOLACE and Licensee +and may include separate and additional fees. -3.2 Support. +3.2 Support. -(a) Provided Licensee complies with this Agreement, SOLACE will provide -Support and Maintenance Services the Software in accordance with SOLACE's -then standard Support and Maintenance Terms. The level of support will be -dependent on whether Licensee has procured either the 'Premium Support Plan' -or 'Standard Support Plan' defined in SOLACE's Support and Maintenance Terms -and as specified in the applicable Order. +(a) Provided Licensee complies with this Agreement, SOLACE will provide Support +and Maintenance Services the Software in accordance with SOLACE's then +standard Support and Maintenance Terms. The level of support will be dependent +on whether Licensee has procured either the 'Premium Support Plan' or +'Standard Support Plan' defined in SOLACE's Support and Maintenance +Terms and as specified in the applicable Order. -(b) SOLACE may enhance such standard Support and Maintenance Services -from time to time in its discretion. +(b) SOLACE may enhance such standard Support and Maintenance Services from time +to time in its discretion. -(c) For greater clarity, SOLACE's then standard Support and Maintenance -Terms do not apply to Evaluation Software Releases, Sample Applications or -any free versions of the Software that may be made available. SOLACE may -make available support related information on a free basis for such Software -on its publicly accessible website or otherwise, and such support related -information will, for greater clarity, be subject to the limitations and -exclusions in this Agreement. +(c) For greater clarity, SOLACE's then standard Support and Maintenance +Terms do not apply to Evaluation Software Releases, Sample Applications or any +free versions of the Software that may be made available. SOLACE may make +available support related information on a free basis for such Software on its +publicly accessible website or otherwise, and such support related information +will, for greater clarity, be subject to the limitations and exclusions in this +Agreement. 4 PROPRIETARY RIGHTS -4.1 Intellectual Property Rights. In this Agreement "Intellectual -Property Rights" means: (a) any and all proprietary rights anywhere in the -world provided under: (i) patent law; (ii) copyright law (including moral -rights); (iii) trademark law; (iv) design patent or industrial design law; or -(v) any other statutory provision or common law principle applicable to this -Agreement, including trade secret law, that may provide a right in either -hardware or information generally or the expression or use of such hardware -or information; (b) any and all applications, registrations, licenses, -sub-licenses, franchises, agreements or any other evidence of a right in any -of the foregoing. Except for the licenses expressly granted herein, othing -in this Agreement or the provision of the Products conveys or otherwise -provides to Licensee title, interest or any Intellectual Property Rights in -or to: (a) the Products, or (b) know-how, ideas, or any other subject matter -protectable under laws applicable to Intellectual Property Rights of any -jurisdiction. As between Licensee and SOLACE, SOLACE and its affiliates and -licensors are the sole and exclusive owners of the Products, including -Intellectual Property Rights therein. - -4.2 Feedback. Licensee is encouraged to provide to SOLACE suggestions, -comments and feedback related to the Products (including reporting bugs) (the -"Feedback"). Licensee hereby grants to SOLACE a license to use, copy, -distribute, modify or otherwise adapt, incorporate into any software and -documentation, including the Products, and sublicense, without attribution or -compensation to Licensee, all Feedback which SOLACE receives or otherwise -obtains from Licensee, in any form, to improve, enhance or modify the -Products or otherwise. Licensee waives or will cause all moral rights to be -waived in any Feedback. - -4.3 Third Party Licenses. The Software may contain or require third -party software that is licensed under third party terms. SOLACE may direct -Licensee to such third party terms, and in some instances the Software cannot -be used or further distributed without Licensee's acceptance of such terms. -Any failure of Licensee to agree to the terms applicable to such third party -software may undermine certain functionality of or prevent Licensee from -using the Software. - -4.4 Open Source Software. - -(a) Licensee will not represent to third parties, or use any third party -software or code in conjunction with: (i) the Software; or (ii) any software, -products, documentation, content or other materials developed using the -Software, in such a way that: (A) creates, purports to create or has the -potential to create, obligations for SOLACE with respect to the Software; or -(B) grants, purports to grant, or has the potential to grant to any third -party any rights to or immunities under any Intellectual Property Rights of -SOLACE, as such rights exist in or relate to the Products. - -(b) Licensee will not use any Software in any manner, including through -incorporation, linking, distribution or otherwise, that will cause any -Products and any Intellectual Property Rights therein to become subject to -any encumbrance or terms and conditions of any third party or open source -license, including any open source license listed on -http://www.opensource.org/licenses/alphabetical (each an "Open Source -License"). - -(c) The restrictions, limitations, exclusions and conditions referred to -under subsection (b) will apply even if SOLACE becomes aware of or fails to -act in a manner to address any violation or failure to comply therewith. No -act by SOLACE that is undertaken under this Agreement in respect to any -Products will be construed as intending to cause any Intellectual Property -Rights that are owned or controlled by SOLACE or any of its affiliates (or -for which SOLACE or any of its affiliates has received license rights) to -become subject to any encumbrance or terms and conditions of any Open Source -License. - -4.5 Use of Name and Logo. Licensee will not display or make any use of -SOLACE's or its affiliates' names, marks or logos without the prior written -approval of SOLACE. +4.1 Intellectual Property Rights. In this Agreement "Intellectual Property +Rights" means: (a) any and all proprietary rights anywhere in the world +provided under: (i) patent law; (ii) copyright law (including moral rights); +(iii) trademark law; (iv) design patent or industrial design law; or (v) any +other statutory provision or common law principle applicable to this Agreement, +including trade secret law, that may provide a right in either hardware or +information generally or the expression or use of such hardware or information; +(b) any and all applications, registrations, licenses, sub-licenses, +franchises, agreements or any other evidence of a right in any of the +foregoing. Except for the licenses expressly granted herein, othing in this +Agreement or the provision of the Products conveys or otherwise provides to +Licensee title, interest or any Intellectual Property Rights in or to: (a) the +Products, or (b) know-how, ideas, or any other subject matter protectable under +laws applicable to Intellectual Property Rights of any jurisdiction. As between +Licensee and SOLACE, SOLACE and its affiliates and licensors are the sole and +exclusive owners of the Products, including Intellectual Property Rights +therein. + +4.2 Feedback. Licensee is encouraged to provide to SOLACE suggestions, +comments and feedback related to the Products (including reporting bugs) (the +"Feedback"). Licensee hereby grants to SOLACE a license to use, copy, +distribute, modify or otherwise adapt, incorporate into any software and +documentation, including the Products, and sublicense, without attribution or +compensation to Licensee, all Feedback which SOLACE receives or otherwise +obtains from Licensee, in any form, to improve, enhance or modify the Products +or otherwise. Licensee waives or will cause all moral rights to be waived in +any Feedback. + +4.3 Third Party Licenses. The Software may contain or require third party +software that is licensed under third party terms. SOLACE may direct Licensee +to such third party terms, and in some instances the Software cannot be used or +further distributed without Licensee's acceptance of such terms. Any +failure of Licensee to agree to the terms applicable to such third party +software may undermine certain functionality of or prevent Licensee from using +the Software. + +4.4 Open Source Software. + +(a) Licensee will not represent to third parties, or use any third party +software or code in conjunction with: (i)the Software; or (ii)any software, +products, documentation, content or other materials developed using the +Software, in such a way that: (A) creates, purports to create or has the +potential to create, obligations for SOLACE with respect to the Software; or +(B) grants, purports to grant, or has the potential to grant to any third party +any rights to or immunities under any Intellectual Property Rights of SOLACE, +as such rights exist in or relate to the Products. + +(b) Licensee will not use any Software in any manner, including through +incorporation, linking, distribution or otherwise, that will cause any Products +and any Intellectual Property Rights therein to become subject to any +encumbrance or terms and conditions of any third party or open source license, +including any open source license listed on +http://www.opensource.org/licenses/alphabetical (each an "Open Source +License"). + +(c) The restrictions, limitations, exclusions and conditions referred to under +subsection (b) will apply even if SOLACE becomes aware of or fails to act in a +manner to address any violation or failure to comply therewith. No act by +SOLACE that is undertaken under this Agreement in respect to any Products will +be construed as intending to cause any Intellectual Property Rights that are +owned or controlled by SOLACE or any of its affiliates (or for which SOLACE or +any of its affiliates has received license rights) to become subject to any +encumbrance or terms and conditions of any Open Source License. + +4.5 Use of Name and Logo Licensee will not display or make any use of +SOLACE's or its affiliates' names, marks or logos without the prior +written approval of SOLACE. 5 FEES AND TAXES -5.1 Fees. Licensee shall pay the applicable Subscription Fees and support -fees specified in the applicable Order. Except as otherwise specified herein -or in an Order, Subscription Fees are based on Subscriptions purchased and -not actual usage. Payment obligations are non-cancellable, Subscription Fees -paid are non-refundable, and the number of Subscriptions purchased cannot be -decreased during the relevant Subscription Term. - -5.2 Invoices and Payment. Subscription Fees will be invoiced in advance -and otherwise in accordance with the relevant Order. All invoices issued by -SOLACE are due and payable within 30 days of the invoice date unless -otherwise agreed in an Order. Licensee will be responsible for any and all -sales, use, excise, import, value-added, services, consumption, and other -taxes assessed on the receipt of the Products, and any related services as a -whole. - -5.3 Overdue Charges. Any payment not received from Customer by the due -date may accrue (except with respect to charges then subject to a reasonable -and good faith dispute), at Licensor' discretion, late charges at the rate of -1.5% of the outstanding balance per month (19.57% per annum), or the maximum -rate permitted by law, whichever is lower, from the date such payment was due -until the date paid. +5.1 Fees. Licensee shall pay the applicable Subscription Fees and support fees +specified in the applicable Order. Except as otherwise specified herein or in +an Order, Subscription Fees are based on Subscriptions purchased and not +actual usage. Subscription Fees paid are refundable if the number of +Subscriptions purchased are decreased during the relevant Subscription Term. + +5.2 Invoices and Payment. Subscription Fees will be invoiced in advance and +otherwise in accordance with the relevant Order. All invoices issued by SOLACE +are due and payable within 30 days of the invoice date unless otherwise agreed +in an Order. Licensee will be responsible for any and all sales, use, excise, +import, value-added, services, consumption, and other taxes assessed on the +receipt of the Products, and any related services as a whole. + +5.3 Overdue Charges. Any payment not received from Customer by the due date may +accrue (except with respect to charges then subject to a reasonable and good +faith dispute), at Licensor' discretion, late charges at the rate of 1.5% of +the outstanding balance per month (19.57% per annum), or the maximum rate +permitted by law, whichever is lower, from the date such payment was due until +the date paid. 6 CONFIDENTIALITY -6.1 Definition of Confidential Information. - -In this Agreement "Confidential Information" of a Party means any information -of a Party (including in respect to SOLACE any of its affiliates, licensors, -customers, employees or subcontractors) (the "Disclosing Party"), whether -oral, written or in electronic form, which has or will come into the -possession or knowledge of the other Party (the "Receiving Party") in -connection with or as a result of entering into this Agreement that can -reasonably be considered to be confidential in the circumstances of -disclosure or which is designated as confidential. The Products, any -performance information, service levels, support terms, and results of -testing of the Software, and the terms of this Agreement are Confidential -Information of SOLACE. Notwithstanding the foregoing, "Confidential -Information" does not include information that is: - -(a) publicly available when it is received by or becomes known to the -Receiving Party or that subsequently becomes publicly available other than -through a direct or indirect act or omission of the Receiving Party (but only -after it becomes publicly available); - -(b) established by evidence to have been already known to the Receiving -Party at the time of its disclosure to the Receiving Party and is not known -by the Receiving Party to be the subject of an obligation of confidence of -any kind; - -(c) independently developed by the Receiving Party without any use of or -reference to the Confidential Information of the Disclosing Party as -established by evidence that would be acceptable to a court of competent +6.1 Definition of Confidential Information. + +In this Agreement "Confidential Information" of a Party means any +information of a Party (including in respect to SOLACE any of its affiliates, +licensors, customers, employees or subcontractors) (the "Disclosing +Party"), whether oral, written or in electronic form, which has or will come +into the possession or knowledge of the other Party (the "Receiving +Party") in connection with or as a result of entering into this Agreement +that can reasonably be considered to be confidential in the circumstances of +disclosure or which is designated as confidential. The Products, any +performance information, service levels, support terms, and results of testing +of the Software, and the terms of this Agreement are Confidential Information +of SOLACE. Notwithstanding the foregoing, "Confidential Information" does +not include information that is: + +(a) publicly available when it is received by or becomes known to the Receiving +Party or that subsequently becomes publicly available other than through a +direct or indirect act or omission of the Receiving Party (but only after it +becomes publicly available); + +(b) established by evidence to have been already known to the Receiving Party +at the time of its disclosure to the Receiving Party and is not known by the +Receiving Party to be the subject of an obligation of confidence of any kind; + +(c) independently developed by the Receiving Party without any use of or +reference to the Confidential Information of the Disclosing Party as +established by evidence that would be acceptable to a court of competent jurisdiction; -(d) received by the Receiving Party in good faith without an obligation -of confidence of any kind from a third party who the Receiving Party had no -reason to believe was not lawfully in possession of such information free of -any obligation of confidence of any kind, but only until the Receiving Party -subsequently comes to have reason to believe that such information was -subject to an obligation of confidence of any kind when originally received; -or +(d) received by the Receiving Party in good faith without an obligation of +confidence of any kind from a third party who the Receiving Party had no reason +to believe was not lawfully in possession of such information free of any +obligation of confidence of any kind, but only until the Receiving Party +subsequently comes to have reason to believe that such information was subject +to an obligation of confidence of any kind when originally received; or -(e) Feedback provided by Licensee or a representative of Licensee. +(e) Feedback provided by Licensee or a representative of Licensee. -6.2 Confidentiality Obligations. +6.2 Confidentiality Obligations. -(a) Each Party will, in its capacity as a Receiving Party: (i) not use or -reproduce Confidential Information of the Disclosing Party for any purpose, -other than as may be reasonably necessary for the exercise of its rights or -the performance of its obligations set out in this Agreement; and (ii) not -disclose, provide access to, transfer or otherwise make available any -Confidential Information of the Disclosing Party to any third party except as +(a) Each Party will, in its capacity as a Receiving Party: (i) not use or +reproduce Confidential Information of the Disclosing Party for any purpose, +other than as may be reasonably necessary for the exercise of its rights or the +performance of its obligations set out in this Agreement; and (ii) not +disclose, provide access to, transfer or otherwise make available any +Confidential Information of the Disclosing Party to any third party except as expressly permitted in this Agreement. -(b) Each Party may, in its capacity as a Receiving Party, disclose -Confidential Information of the Disclosing Party: (i) if and to the extent -required by a governmental authority or otherwise as required by applicable -law, provided that the Receiving Party must first give the Disclosing Party -notice of such compelled disclosure (except where prohibited by applicable -law from doing so) and must use commercially reasonable efforts to provide -the Disclosing Party with an opportunity to take such steps as it desires to -challenge or contest such disclosure or seek a protective order. Thereafter, -the Receiving Party may disclose the Confidential Information of the -Disclosing Party, but only to the extent required by applicable law and -subject to any protective order that applies to such disclosure; and (ii) to: -(A) its accountants, internal and external auditors and other professional -advisors if and to the extent that such persons need to know such -Confidential Information in order to provide the applicable professional -advisory services relating to the Receiving Party; and (B) employees of the -Receiving Party and its subcontractors if and to the extent that such persons -need to know such Confidential Information to perform their respective -obligations under this Agreement; - -provided that any such person is aware of the provisions of this Section 6.2 -and has entered into a written agreement with the Receiving Party that -includes confidentiality obligations in respect of such Confidential -Information of the Disclosing Party that are no less stringent than those -contained in this Section 6.2. - -6.3 Consent to Injunctive Relief. Any unauthorized use or disclosure of -the Confidential Information of SOLACE, its affiliates or licensors may cause -irreparable harm and significant injury to SOLACE that would be difficult to -ascertain or quantify; accordingly Licensee agrees that SOLACE will have the -right to seek and obtain injunctive or other equitable relief to enforce the -terms of this Agreement and without limiting any other rights or remedies -that SOLACE may have. +(b) Each Party may, in its capacity as a Receiving Party, disclose Confidential +Information of the Disclosing Party: (i) if and to the extent required by a +governmental authority or otherwise as required by applicable law, provided +that the Receiving Party must first give the Disclosing Party notice of such +compelled disclosure (except where prohibited by applicable law from doing so) +and must use commercially reasonable efforts to provide the Disclosing Party +with an opportunity to take such steps as it desires to challenge or contest +such disclosure or seek a protective order. Thereafter, the Receiving Party +may disclose the Confidential Information of the Disclosing Party, but only to +the extent required by applicable law and subject to any protective order that +applies to such disclosure; and (ii) to: (A) its accountants, internal and +external auditors and other professional advisors if and to the extent that +such persons need to know such Confidential Information in order to provide the +applicable professional advisory services relating to the Receiving Party; and +(B) employees of the Receiving Party and its subcontractors if and to the +extent that such persons need to know such Confidential Information to perform +their respective obligations under this Agreement; + +provided that any such person is aware of the provisions of this Section 6.2 +and has entered into a written agreement with the Receiving Party that includes +confidentiality obligations in respect of such Confidential Information of the +Disclosing Party that are no less stringent than those contained in this +Section 6.2. + +6.3 Consent to Injunctive Relief. Any unauthorized use or disclosure of the +Confidential Information of SOLACE, its affiliates or licensors may cause +irreparable harm and significant injury to SOLACE that would be difficult to +ascertain or quantify; accordingly Licensee agrees that SOLACE will have the +right to seek and obtain injunctive or other equitable relief to enforce the +terms of this Agreement and without limiting any other rights or remedies that +SOLACE may have. 7 WARRANTY AND DISCLAIMER OF WARRANTIES. -7.1 Warranty. SOLACE warrants that the Software will materially comply -with the Documentation during the Subscription Term. If the Software does -not materially conform with the warranty in the prior sentence, provided that -Licensee is in compliance with the terms of this Agreement, and all -Subscription Fees are fully-paid up, SOLACE will provide the support to -Licensee in respect to the applicable Software to the extent set out in -SOLACE's then current Support and Maintenance Terms, and the provision of -support to correct the non-compliance with the warranty in this Section will -be Licensee's sole and exclusive remedy in the event of non-compliance with -the warranty in this Section by SOLACE. All other support will be dependent -on the plan procured by Licensee, as defined in the Support and Maintenance -Terms. - -7.2 Disclaimers. - -a) EXCEPT AS SET OUT IN SECTION 7.1, THE PRODUCTS AND SUPPORT THAT MAY -BE PROVIDED BY SOLACE UNDER THIS AGREEMENT, IS PROVIDED 'AS-IS' AND 'AS +7.1 Warranty. SOLACE warrants that the Software will materially comply with +the Documentation during the Subscription Term. If the Software does not +materially conform with the warranty in the prior sentence, provided that +Licensee is in compliance with the terms of this Agreement, and all +Subscription Fees are fully-paid up, SOLACE will provide the support to +Licensee in respect to the applicable Software to the extent set out in +SOLACE's then current Support and Maintenance Terms, and the provision of +support to correct the non-compliance with the warranty in this Section will be +Licensee's sole and exclusive remedy in the event of non-compliance with the +warranty in this Section by SOLACE. All other support will be dependent on the +plan procured by Licensee, as defined in the Support and Maintenance Terms. + +7.2 Disclaimers. + +(a) EXCEPT AS SET OUT IN SECTION 7.1, THE PRODUCTS AND SUPPORT THAT MAY BE +PROVIDED BY SOLACE UNDER THIS AGREEMENT, IS PROVIDED 'AS-IS' AND 'AS AVAILABLE'. -(b) Except as set out in Section 7.1, the Products and support are -without any additional warranties of any kind, whether express, implied, -collateral, statutory or otherwise. SOLACE does not warrant or make any -representations regarding the use, or the results of the use, of the Products -in terms of its correctness, accuracy, reliability, or otherwise. - -(c) SOLACE does not represent or warrant that the functionality of the -Products will meet Licensee requirements, or that the operation of the -Products will be uninterrupted or error-free, or that the Products or any -service enabled by the use of the Software will always be available, or that -defects in the Products will be corrected. - -(d) TO THE MAXIMUM EXTENT PERMITTED UNDER APPLICABLE LAW, SOLACE ON ITS -OWN BEHALF AND ON BEHALF OF ITS AFFILIATES AND LICENSOR(S) EXPRESSLY -DISCLAIMS ALL WARRANTIES AND CONDITIONS, WHETHER EXPRESS, IMPLIED, STATUTORY -OR OTHERWISE, INCLUDING ANY IMPLIED WARRANTIES, AND CONDITIONS OF -MERCHANTABLE QUALITY, MERCHANTABILITY, QUALITY, FITNESS FOR A PARTICULAR -PURPOSE, AND NON-INFRINGEMENT. - -(e) Some jurisdictions do not allow the exclusion of implied warranties, -so exclusions in this Article 7 will apply only to the extent permitted by +(b) Except as set out in Section 7.1, the Products and support are without any +additional warranties of any kind, whether express, implied, collateral, +statutory or otherwise. SOLACE does not warrant or make any representations +regarding the use, or the results of the use, of the Products in terms of its +correctness, accuracy, reliability, or otherwise. + +(c) SOLACE does not represent or warrant that the functionality of the Products +will meet Licensee requirements, or that the operation of the Products will be +uninterrupted or error-free, or that the Products or any service enabled by +the use of the Software will always be available, or that defects in the +Products will be corrected. + +(d) TO THE MAXIMUM EXTENT PERMITTED UNDER APPLICABLE LAW, SOLACE ON ITS OWN +BEHALF AND ON BEHALF OF ITS AFFILIATES AND LICENSOR(S) EXPRESSLY DISCLAIMS ALL +WARRANTIES AND CONDITIONS, WHETHER EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, +INCLUDING ANY IMPLIED WARRANTIES, AND CONDITIONS OF MERCHANTABLE QUALITY, +MERCHANTABILITY, QUALITY, FITNESS FOR A PARTICULAR PURPOSE, AND +NON-INFRINGEMENT. + +(e) Some jurisdictions do not allow the exclusion of implied warranties, so +exclusions in this Article 7 will apply only to the extent permitted by applicable law. 8 LICENSEE INDEMNITY AND EXCLUSION. -8.1 Licensee Indemnity. +8.1 Licensee Indemnity. -(a) Without limiting SOLACE's rights and remedies under this Agreement, -Licensee will indemnify, defend and hold SOLACE, its licensors, affiliates or -any of their respective directors, officers, employees or agents (together, -the "Solace Indemnitees") harmless from and against any and all third party -Claims and Losses incurred or otherwise suffered by each SOLACE Indemnitee +(a) Without limiting SOLACE's rights and remedies under this Agreement, +Licensee will indemnify, defend and hold SOLACE, its licensors, affiliates or +any of their respective directors, officers, employees or agents (together, the +"Solace Indemnitees") harmless from and against any and all third party +Claims and Losses incurred or otherwise suffered by each SOLACE Indemnitee arising out of, resulting from or related to: -(i) any use, reproduction or distribution of the Products -(notwithstanding the restrictions and obligations in this Agreement), as -modified or integrated by Licensee in Licensee application, which causes an -infringement or misappropriation of any Intellectual Property Right, -publicity or privacy right of any third parties arising in any jurisdiction -anywhere in the world, except and solely to the extent such infringement is -caused by the unmodified Software, or portions thereof, as supplied to -Licensee by SOLACE under this Agreement; or -(ii) any use, downloading, distribution, installation, storage, execution, -or transfer of the Products in breach of this Agreement. - -(b) SOLACE may enforce the indemnity under this Article 8 on behalf of -any or all of the SOLACE Indemnitees. Licensee may only bring a Claim -against SOLACE and not any SOLACE Indemnitees under this Agreement. - -8.2 SOLACE Indemnity. - -(a) SOLACE will defend Licensee from and against any and all Claims by a -third party incurred or otherwise suffered by Licensee arising out of, -resulting from or related to a Claim that the Products licensed pursuant to -Section 2.1 infringe or misappropriate third party copyright or patent rights -in Canada or the United States of America, and indemnity Licensee from any -damages awarded by a court of final determination. - -(b) Without limitation, Section 8.2 will not be applicable and SOLACE -will not be liable to defend a Claim to the extent that such Claim is based -on: (i) Licensee's use of the Products after SOLACE notifies Licensee to -discontinue using them; (ii) Licensee combining the Products with non-SOLACE -services, products, programs or data; or (iii) Licensee altering or modifying -the Products. - -(c) If SOLACE receives information concerning an infringement or -misappropriation Claim related to the Products, SOLACE may, at its expense -and without obligation to do so, either: (i) procure the Intellectual -Property Rights or other right(s) to continue to use the Product; or (ii) -replace or modify the Product to make it non-infringing; or (iii) immediately -terminate this Agreement on written notice to Licensee, in which case SOLACE -will refund to Licensee, on a pro-rata basis, any pre-paid fees in respect to -such Product from the date of such termination to the end of the then current -Subscription Term for such Product; and this Section 8.2(c) states the sole -and exclusive remedy of Licensee and the entire liability of SOLACE for third -party infringement claims and actions. - -8.3 Indemnification Procedures. Each Party's obligations under this -Article 8 are contingent on all of the following: (i) the Party seeking the -indemnity (the "Indemnified Party") must notify the other Party (the -"Indemnifying Party"), in a timely manner and in writing of the Claim; (ii) -the Indemnified Party must give the Indemnifying Party sole control over -defense and settlement of the Claim; (iii) the Indemnified Party must provide -the Indemnifying Party with reasonable information and assistance, at the -Indemnifying Party's request, as needed in defending the Claim (the -Indemnifying Party will reimburse the Indemnified Party for reasonable -expenses that the Indemnified Party incurs in providing that assistance). -The Indemnified Party may choose to have its counsel, monitor or participate -in the defense of such a Claim provided that the Indemnified Party will be -responsible for the cost of its own counsel and the Indemnifying Party's -obligations in this Article 8 do not extend to the Indemnified Party's legal -costs should it wish to exercise such right. The Indemnifying Party will not -be responsible for any settlement made by the Indemnified Party without its -prior written consent. The Indemnifying Party may not settle or publicize -any Claim without the Indemnified Party's prior written consent. +(i) any use, reproduction or distribution of the Products (notwithstanding the +restrictions and obligations in this Agreement), as modified or integrated by +Licensee in Licensee application, which causes an infringement or +misappropriation of any Intellectual Property Right, publicity or privacy right +of any third parties arising in any jurisdiction anywhere in the world, except +and solely to the extent such infringement is caused by the unmodified +Software, or portions thereof, as supplied to Licensee by SOLACE under this +Agreement; or +(ii) any use, downloading, distribution, installation, storage, execution, or +transfer of the Products in breach of this Agreement. + +(b) SOLACE may enforce the indemnity under this Article 8 on behalf of any or +all of the SOLACE Indemnitees. Licensee may only bring a Claim against SOLACE +and not any SOLACE Indemnitees under this Agreement. + +8.2 SOLACE Indemnity. + +(a) SOLACE will defend Licensee from and against any and all Claims by a third +party incurred or otherwise suffered by Licensee arising out of, resulting from +or related to a Claim that the Products licensed pursuant to Section 2.1 +infringe or misappropriate third party copyright or patent rights in Canada or +the United States of America, and indemnity Licensee from any damages awarded +by a court of final determination. + +(b) Without limitation, Section 8.2 will not be applicable and SOLACE will not +be liable to defend a Claim to the extent that such Claim is based on: (i) +Licensee's use of the Products after SOLACE notifies Licensee to discontinue +using them; (ii) Licensee combining the Products with non-SOLACE services, +products, programs or data; or (iii) Licensee altering or modifying the +Products. + +(c) If SOLACE receives information concerning an infringement or +misappropriation Claim related to the Products, SOLACE may, at its expense and +without obligation to do so, either: (i) procure the Intellectual Property +Rights or other right(s) to continue to use the Product; or (ii) replace or +modify the Product to make it non-infringing; or (iii) immediately terminate +this Agreement on written notice to Licensee, in which case SOLACE will refund +to Licensee, on a pro-rata basis, any pre-paid fees in respect to such Product +from the date of such termination to the end of the then current Subscription +Term for such Product; and this Section 8.2(c) states the sole and exclusive +remedy of Licensee and the entire liability of SOLACE for third party +infringement claims and actions. + +8.3 Indemnification Procedures. Each Party's obligations under this Article +8 are contingent on all of the following: (i) the Party seeking the indemnity +(the "Indemnified Party") must notify the other Party (the +"Indemnifying Party"), in a timely manner and in writing of the Claim; +(ii) the Indemnified Party must give the Indemnifying Party sole control over +defense and settlement of the Claim; (iii) the Indemnified Party must provide +the Indemnifying Party with reasonable information and assistance, at the +Indemnifying Party's request, as needed in defending the Claim (the +Indemnifying Party will reimburse the Indemnified Party for reasonable expenses +that the Indemnified Party incurs in providing that assistance). The +Indemnified Party may choose to have its counsel, monitor or participate in the +defense of such a Claim provided that the Indemnified Party will be responsible +for the cost of its own counsel and the Indemnifying Party's obligations in +this Article 8 do not extend to the Indemnified Party's legal costs should +it wish to exercise such right. The Indemnifying Party will not be responsible +for any settlement made by the Indemnified Party without its prior written +consent. The Indemnifying Party may not settle or publicize any Claim without +the Indemnified Party's prior written consent. 9 LIMITATIONS OF LIABILITY. -9.1 Definition and Limitations of Liability. - -(a) In this Agreement: "Claim" means any actual, threatened or potential -civil, criminal, administrative, regulatory, arbitral or investigative -demand, allegation, action, suit, investigation or proceeding or any other -claim or demand; and "Losses" means any and all damages, fines, penalties, -deficiencies, losses, liabilities (including settlements and judgments), -costs and expenses (including interest, court costs, reasonable fees and -expenses of lawyers, accountants and other experts and professionals or other -reasonable fees and expenses of litigation or other proceedings or of any -Claim, default or assessment). - -(b) SUBJECT TO SECTION 9.1(d), TO THE FULLEST EXTENT PERMITTED BY -APPLICABLE LAW, UNDER NO CIRCUMSTANCES WILL SOLACE INDEMNITEES BE LIABLE FOR -(A) ANY INDIRECT, INCIDENTAL, SPECIAL, PUNITIVE, EXEMPLARY OR CONSEQUENTIAL -DAMAGES; OR (B) ANY DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS -INTERRUPTION, OR LOSS OF BUSINESS INFORMATION, IN EACH CASE, ARISING OUT OF -OR IN CONNECTION WITH THIS AGREEMENT, INCLUDING ANY DOWNLOAD, INSTALLATION OR -USE OF, OR INABILITY TO USE, THE PRODUCTS; EVEN IF SUCH DAMAGES WERE -FORESEEABLE, AND REGARDLESS OF WHETHER THE SOLACE INDEMNITIEES HAVE BEEN -ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -(c) SUBJECT TO SECTION 9.1(d), TO THE FULLEST EXTENT PERMITTED BY -APPLICABLE LAW, IN NO EVENT WILL SOLACE INDEMNITEES' TOTAL AGGREGATE -LIABILITY IN RESPECT OF THIS AGREEMENT, INCLUDING THE PRODUCTS AND ANY -SERVICES THAT MAY BE PROVIDED HEREUNDER, FOR ANY AND ALL LOSSES AND CLAIMS -EXCEED THE AMOUNTS PAID TO SOLACE IN THE 12 MONTHS IMMEDIATELY PRECEDING THE -EVENT GIVING RISE TO THE CLAIM. - -(d) Certain Damages Not Excluded or Limited. NOTWITHSTANDING THE -FOREGOING, SECTIONS 9.1 (b) AND (c) DO NOT APPLY TO (I) DAMAGES ARISING FROM -A PARTY'S BREACH OF ITS CONFIDENTIALITY OBLIGATIONS HEREUNDER, (II) -INDEMNIFICATION CLAIMS, (III) DAMAGES ARISING FROM INFRINGEMENT OF A PARTY'S -INTELLECTUAL PROPERTY RIGHTS; (IV) ANY CLAIMS FOR NON-PAYMENT, (V) FRAUD OR -WILLFUL MISCONDUCT, OR (VI) BODILY INJURY OR DEATH. - -(e) This Article 9 will apply irrespective of the nature of the cause of -action, demand or Claim, including, breach of contract (including fundamental -breach), negligence (including gross negligence), tort or any other legal -theory, and will survive a fundamental breach or breaches of this Agreement -or of any remedy contained herein. - -10 TERM AND TERMINATION. - -10.1 Term and Renewal. This Agreement will be effective from the Effective -Date and will continue until the expiry of the Subscription Term set out in -the Order or the Agreement terminates in accordance with its terms. Subject -to payment of the applicable Software Fees, Software Subscriptions shall -automatically renew for additional periods equal to the expiring Subscription -Term or one (1) year (whichever is shorter), unless either party gives the -other notice of non-renewal at least thirty (30) days prior to the end of the -then-current Subscription Term. The Subscription Fees during any automatic +9.1 Definition and Limitations of Liability. + +(a) In this Agreement: "Claim" means any actual, threatened or potential +civil, criminal, administrative, regulatory, arbitral or investigative demand, +allegation, action, suit, investigation or proceeding or any other claim or +demand; and "Losses" means any and all damages, fines, penalties, +deficiencies, losses, liabilities (including settlements and judgments), costs +and expenses (including interest, court costs, reasonable fees and expenses of +lawyers, accountants and other experts and professionals or other reasonable +fees and expenses of litigation or other proceedings or of any Claim, default +or assessment). + +(b) SUBJECT TO SECTION 9.1(d), TO THE FULLEST EXTENT PERMITTED BY APPLICABLE +LAW, UNDER NO CIRCUMSTANCES WILL SOLACE INDEMNITEES BE LIABLE FOR (A) ANY +INDIRECT, INCIDENTAL, SPECIAL, PUNITIVE, EXEMPLARY OR CONSEQUENTIAL DAMAGES; OR +(B) ANY DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, OR LOSS OF +BUSINESS INFORMATION, IN EACH CASE, ARISING OUT OF OR IN CONNECTION WITH THIS +AGREEMENT, INCLUDING ANY DOWNLOAD, INSTALLATION OR USE OF, OR INABILITY TO USE, +THE PRODUCTS; EVEN IF SUCH DAMAGES WERE FORESEEABLE, AND REGARDLESS OF WHETHER +THE SOLACE INDEMNITIEES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +(c) SUBJECT TO SECTION 9.1(d), TO THE FULLEST EXTENT PERMITTED BY APPLICABLE +LAW, IN NO EVENT WILL SOLACE INDEMNITEES' TOTAL AGGREGATE LIABILITY IN +RESPECT OF THIS AGREEMENT, INCLUDING THE PRODUCTS AND ANY SERVICES THAT MAY BE +PROVIDED HEREUNDER, FOR ANY AND ALL LOSSES AND CLAIMS EXCEED THE AMOUNTS PAID +TO SOLACE IN THE 12 MONTHS IMMEDIATELY PRECEDING THE EVENT GIVING RISE TO THE +CLAIM. + +(d) Certain Damages Not Excluded or Limited. NOTWITHSTANDING THE FOREGOING, +SECTIONS 9.1 (b) AND (c) DO NOT APPLY TO (I) DAMAGES ARISING FROM A PARTY'S +BREACH OF ITS CONFIDENTIALITY OBLIGATIONS HEREUNDER, (II) INDEMNIFICATION +CLAIMS, (III) DAMAGES ARISING FROM INFRINGEMENT OF A PARTY'S INTELLECTUAL +PROPERTY RIGHTS; (IV) ANY CLAIMS FOR NON-PAYMENT, (V) FRAUD OR WILLFUL +MISCONDUCT, OR (VI) BODILY INJURY OR DEATH. + +(e) This Article 9 will apply irrespective of the nature of the cause of +action, demand or Claim, including, breach of contract (including fundamental +breach), negligence (including gross negligence), tort or any other legal +theory, and will survive a fundamental breach or breaches of this Agreement or +of any remedy contained herein. + +10 TERM AND TERMINATION. + +10.1 Term and Renewal. This Agreement will be effective from the Effective Date +and will continue until the expiry of the Subscription Term set out in the +Order or the Agreement terminates in accordance with its terms. Subject to +payment of the applicable Software Fees, Software Subscriptions shall +automatically renew for additional periods equal to the expiring Subscription +Term or one (1) year (whichever is shorter), unless either party gives the +other notice of non-renewal at least thirty (30) days prior to the end of the +then-current Subscription Term. The Subscription Fees during any automatic renewal term will be as set forth in the applicable Order. -10.2 Termination for Cause. A party may terminate this Agreement for cause -(i) upon 30 days' written notice to the other party of a material breach if -such breach remains uncured at the expiration of such period, or (ii) if the -other party becomes the subject of a petition in bankruptcy or any other -proceeding relating to insolvency, receivership, liquidation or assignment -for the benefit of creditors. - -10.3 Termination by SOLACE. SOLACE may terminate this Agreement for cause -with immediate effect on written notice if Licensee commits a breach of -Articles 4 or 5 by Licensee. - -10.4 Termination of Sample Application and Evaluation Software Release -Licenses for Convenience by SOLACE. SOLACE may terminate the licenses in -respect to the Sample Applications, Evaluation Software Releases, and any -other Products that may be licensed by SOLACE on a trial basis, at any time -for convenience, upon written notice to Licensee. - -10.5 Termination of Licenses of Trial Software. Subject to Section 10.4, -if any Software is licensed for use by a Licensee on a trial basis, the -license to use such Software during a trial period will continue for such -duration set out in an Order. - -10.6 Effects of Termination. Upon termination or expiry of this Agreement -or specific licenses granted hereunder for any reason, and without limiting -SOLACE's other rights or remedies under this Agreement: (a) Licensee must -permanently delete or destroy, or otherwise purge, all copies (electronic or -otherwise) of the applicable Products from Licensee's systems, and any other -Confidential Information of SOLACE, in Licensee's possession or control, and, -if requested by SOLACE, certify the same, and the license and other rights -granted to Licensee in this Agreement will terminate; (b) termination or -expiration of this Agreement or an individual Subscription will result in -termination of any applicable Support and Maintenance Services; and (c) -Licensee will not receive a return of any pre-paid fees in respect to the -applicable Products, on a pro-rata basis or otherwise, except where expressly +10.2 Termination for Cause. A party may terminate this Agreement for cause (i) +upon 30 days' written notice to the other party of a material breach if such +breach remains uncured at the expiration of such period, or (ii) if the other +party becomes the subject of a petition in bankruptcy or any other proceeding +relating to insolvency, receivership, liquidation or assignment for the benefit +of creditors. + +10.3 Termination by SOLACE. SOLACE may terminate this Agreement for cause with +immediate effect on written notice if Licensee commits a breach of Articles 4 +or 5 by Licensee. + +10.4 Termination of Sample Application and Evaluation Software Release Licenses +for Convenience by SOLACE. SOLACE may terminate the licenses in respect to the +Sample Applications, Evaluation Software Releases, and any other Products that +may be licensed by SOLACE on a trial basis, at any time for convenience, upon +written notice to Licensee. + +10.5 Termination of Licenses of Trial Software. Subject to Section 10.4, if any +Software is licensed for use by a Licensee on a trial basis, the license to use +such Software during a trial period will continue for such duration set out in +an Order. + +10.6 Effects of Termination. Upon termination or expiry of this Agreement or +specific licenses granted hereunder for any reason, and without limiting +SOLACE's other rights or remedies under this Agreement: (a) Licensee must +permanently delete or destroy, or otherwise purge, all copies (electronic or +otherwise) of the applicable Products from Licensee's systems, and any other +Confidential Information of SOLACE, in Licensee's possession or control, +and, if requested by SOLACE, certify the same, and the license and other rights +granted to Licensee in this Agreement will terminate; (b) termination or +expiration of this Agreement or an individual Subscription will result in +termination of any applicable Support and Maintenance Services; and (c) +Licensee will not receive a return of any pre-paid fees in respect to the +applicable Products, on a pro-rata basis or otherwise, except where expressly stated in this Agreement. -10.7 Survival. Neither the expiration nor the earlier termination of this -Agreement will release either of the Parties from any obligation or liability -that accrued prior to such expiration or termination. The provisions of this -Agreement requiring performance or fulfilment after the expiration or earlier -termination of this Agreement, including Articles 4, 5, 5, 7, 9, 8, 9, 10, -11, 12, and 13, and such other provisions as are necessary for the -interpretation thereof and any other provisions hereof, the nature and intent -of which is to survive termination or expiration of this Agreement, will -survive the expiration or earlier termination of this Agreement. +10.7 Survival. Neither the expiration nor the earlier termination of this +Agreement will release either of the Parties from any obligation or liability +that accrued prior to such expiration or termination. The provisions of this +Agreement requiring performance or fulfilment after the expiration or earlier +termination of this Agreement, including Articles 4, 5, 7, 8, 9, 10, 11, 12, +and 13, and such other provisions as are necessary for the interpretation +thereof and any other provisions hereof, the nature and intent of which is to +survive termination or expiration of this Agreement, will survive the +expiration or earlier termination of this Agreement. 11 AUDIT AND REMEDIATION -11.1 Audit. During the term of this Agreement and for two years -thereafter, SOLACE or any internal or external audit representative acting on -behalf of SOLACE (the "SOLACE Audit Representatives") will have the right, -and Licensee will provide access to SOLACE Audit Representatives during -regular business hours and upon reasonable prior written notice to Licensee, -to audit and inspect on a mutually agreed upon date and location any system -or facility or part of a system or facility to which Licensee has downloaded -the Software or is receiving any services (or both) in order to verify the -performance by Licensee of its obligations under this Agreement, including -the Licensee's usage of the Products in accordance with the restrictions and -terms in this Agreement. - -11.2 Remediation. Without limiting SOLACE's rights and remedies under this -Agreement, if an audit conducted pursuant to this Agreement reveals any -error, deficiency or other failure to perform on the part of Licensee -including use of the Software contrary to the licenses in this Agreement or -installed on systems, computers or processors for which the Licensee has not -paid applicable Subscription Fees: (a) Licensee will immediately pay to -SOLACE any fees due and payable for Software used in breach of the -restrictions in this Agreement, plus interest at the lesser of: (i) the rate -of 1.5 percent per month compounded monthly (19.562 percent per annum); or -(ii) the maximum rate allowed by applicable law, in each case, on the amount -outstanding from the date when payment is due until the date payment in full -is received by SOLACE; and (b) pursue any other right or remedy SOLACE may -have under this Agreement. +11.1 Audit. During the term of this Agreement and for two years thereafter, +SOLACE or any internal or external audit representative acting on behalf of +SOLACE (the "SOLACE Audit Representatives") will have the right, and +Licensee will provide access to SOLACE Audit Representatives during regular +business hours and upon reasonable prior written notice to Licensee, to audit +and inspect on a mutually agreed upon date and location any system or facility +or part of a system or facility to which Licensee has downloaded the Software +or is receiving any services (or both) in order to verify the performance by +Licensee of its obligations under this Agreement, including the Licensee's +usage of the Products in accordance with the restrictions and terms in this +Agreement. + +11.2 Remediation. Without limiting SOLACE's rights and remedies under this +Agreement, if an audit conducted pursuant to this Agreement reveals any error, +deficiency or other failure to perform on the part of Licensee including use of +the Software contrary to the licenses in this Agreement or installed on +systems, computers or processors for which the Licensee has not paid applicable +Subscription Fees: (a) Licensee will immediately pay to SOLACE any fees due and +payable for Software used in breach of the restrictions in this Agreement, plus +interest at the lesser of: (i) the rate of 1.5 percent per month compounded +monthly (19.562 percent per annum); or (ii) the maximum rate allowed by +applicable law, in each case, on the amount outstanding from the date when +payment is due until the date payment in full is received by SOLACE; and (b) +pursue any other right or remedy SOLACE may have under this Agreement. 12 EXPORT COMPLIANCE ASSURANCES -(a) All Products obtained from SOLACE are subject to the export control -and economic sanctions laws and regulations of Canada, including the Exports -and Import Permits Act, R.S.C. 1985, c. E-19, Area Control List, Export -Control List, and the United States, including the Export Administration -Regulations ("EAR", 15 CFR 730 et seq., http://www.bis.doc.gov/) administered -by the Department of Commerce, Bureau of Industry and Security, and the -Foreign Asset Control Regulations (31 CFR 500 et seq., -http://www.treas.gov/offices/enforcement/ofac/) administered by the -Department of Treasury, Office of Foreign Assets Control ("OFAC"), each as -may be amended and updated from time to time. - -(b) Licensee will not, and will ensure that Licensee will not directly or -indirectly export, re-export, transfer or release (collectively, "export") -any Products to any destination, person, entity or end use prohibited or -restricted under Canadian or US law, or the laws of the jurisdiction in which -Licensee is resident or in which Licensee uses the Products, without prior -government or regulatory authorization to the extent required by applicable -laws and regulations. - -(c) The US government maintains embargoes and sanctions against the -countries listed in Country Groups E:1/2 of the EAR (Supplement 1 to part -740), including, as at the Effective Date, Cuba, Iran, North Korea, Sudan and -Syria, as amended from time to time. Licensee will not directly or -indirectly employ any Product received from SOLACE in missile technology, -sensitive nuclear or chemical biological weapons activities, or in any manner -knowingly transfer any Product to any party for any such end use. Licensee -will not export Products listed in Supplement 2 to part 744 of the EAR for -military end-uses, as defined in part 744.21, to the People's Republic of -China. Licensee will not transfer any Product to any party listed on any of -the denied parties lists or specially designated nationals lists maintained -under said regulations without appropriate US government authorization to the -extent required by regulation. Licensee acknowledge that other countries may -have trade laws pertaining to import, use, export or distribution of -Products, and that compliance with same is Licensee responsibility. - -(d) Licensee may not use the Products if Licensee is barred from -receiving the Products under the laws of Canada, the United States or any -other country including the country in which Licensee are resident or in -which Licensee use the Products. +(a) All Products obtained from SOLACE are subject to the export control and +economic sanctions laws and regulations of Canada, including the Exports and +Import Permits Act, R.S.C. 1985, c. E-19, Area Control List, Export Control +List, and the United States, including the Export Administration Regulations +("EAR", 15 CFR 730 et seq., http://www.bis.doc.gov/) administered by the +Department of Commerce, Bureau of Industry and Security, and the Foreign Asset +Control Regulations (31 CFR 500 et seq., +http://www.treas.gov/offices/enforcement/ofac/) administered by the Department +of Treasury, Office of Foreign Assets Control ("OFAC"), each as may be +amended and updated from time to time. + +(b) Licensee will not, and will ensure that Licensee will not directly or +indirectly export, re-export, transfer or release (collectively, +"export") any Products to any destination, person, entity or end use +prohibited or restricted under Canadian or US law, or the laws of the +jurisdiction in which Licensee is resident or in which Licensee uses the +Products, without prior government or regulatory authorization to the extent +required by applicable laws and regulations. + +(c) The US government maintains embargoes and sanctions against the countries +listed in Country Groups E:1/2 of the EAR (Supplement 1 to part 740), +including, as at the Effective Date, Cuba, Iran, North Korea, Sudan and Syria, +as amended from time to time. Licensee will not directly or indirectly employ +any Product received from SOLACE in missile technology, sensitive nuclear or +chemical biological weapons activities, or in any manner knowingly transfer any +Product to any party for any such end use. Licensee will not export Products +listed in Supplement 2 to part 744 of the EAR for military end-uses, as defined +in part 744.21, to the People's Republic of China. Licensee will not +transfer any Product to any party listed on any of the denied parties lists or +specially designated nationals lists maintained under said regulations without +appropriate US government authorization to the extent required by regulation. +Licensee acknowledge that other countries may have trade laws pertaining to +import, use, export or distribution of Products, and that compliance with same +is Licensee responsibility. + +(d) Licensee may not use the Products if Licensee is barred from receiving the +Products under the laws of Canada, the United States or any other country +including the country in which Licensee are resident or in which Licensee use +the Products. 13 GENERAL -13.1 U.S. Government Users. If Licensee are acting on behalf of an agency -or instrumentality of the U.S. federal government, the Product, as -applicable, are "commercial computer software" and "commercial computer -software documentation" developed exclusively at private expense by SOLACE. -Pursuant to FAR 12.212 or DFARS 227 7202 and their successors, as applicable, -use, reproduction and disclosure of the Products is governed by the terms of +13.1 U.S. Government Users. If Licensee are acting on behalf of an agency or +instrumentality of the U.S. federal government, the Product, as applicable, are +"commercial computer software" and "commercial computer software +documentation" developed exclusively at private expense by SOLACE Pursuant +to FAR 12.212 or DFARS 227 7202 and their successors, as applicable, use, +reproduction and disclosure of the Products is governed by the terms of this +Agreement. + +13.2 Entire Agreement. This Agreement, and the agreements and other documents +required to be delivered pursuant to this Agreement, constitute the entire and +exclusive agreement between SOLACE and Licensee, and sets out all the +covenants, promises, warranties, representations, conditions and agreements +between the Parties in connection with the subject matter of this Agreement, +and supersedes all prior agreements (whether written or oral, pre-contractual +or otherwise) and other communications between SOLACE and Licensee. There are +no covenants, promises, warranties, representations, conditions or other +agreements, whether oral or written, pre-contractual or otherwise, express, +implied or collateral, whether statutory or otherwise, between the Parties in +connection with the subject matter of this Agreement except as specifically set +forth in this Agreement and any document required to be delivered pursuant to this Agreement. -13.2 Entire Agreement. This Agreement, and the agreements and other -documents required to be delivered pursuant to this Agreement, constitute the -entire and exclusive agreement between SOLACE and Licensee, and sets out all -the covenants, promises, warranties, representations, conditions and -agreements between the Parties in connection with the subject matter of this -Agreement, and supersedes all prior agreements (whether written or oral, -pre-contractual or otherwise) and other communications between SOLACE and -Licensee. There are no covenants, promises, warranties, representations, -conditions or other agreements, whether oral or written, pre-contractual or -otherwise, express, implied or collateral, whether statutory or otherwise, -between the Parties in connection with the subject matter of this Agreement -except as specifically set forth in this Agreement and any document required -to be delivered pursuant to this Agreement. - -13.3 Amendments. This Agreement may be modified only by a written -amendment agreed to by both Licensee and SOLACE, except that SOLACE may -modify the Documentation from time to time, provided that SOLACE does not -materially lessen the description of the functionality of the Products as a -result of such modification. - -13.4 English Language. This Agreement is entered into solely in the -English language, and if for any reason any other language version is -prepared by any Party, it will be solely for convenience and the English -version will govern and control in all respects. If Licensee are located in -the province of Quebec, Canada, the following applies: The Parties hereby -confirm they have requested this Agreement and all related documents be -prepared in English. Les parties ont exigé que le présent contrat et tous -les documents connexes soient rédigés en anglais. - -13.5 Waiver. To be effective, any waiver by a Party of any of its rights -or any other Party's obligations under this Agreement must be made in a -writing signed by the Party to be charged with the waiver. No failure or -forbearance by any Party to insist upon or enforce performance by any other -Party of any of the provisions of this Agreement or to exercise any rights or -remedies under this Agreement or otherwise at law or in equity will be -construed as a waiver or relinquishment to any extent of such Party's right -to assert or rely upon any such provision, right, or remedy in that or any -other instance; rather, the same will be and remain in full force and effect. - A Party's waiver of a breach of any term will not be a waiver of any -subsequent breach of the same or another term. - -13.6 Cumulative Rights. The rights of each Party hereunder are cumulative -and no exercise or enforcement by a Party of any right or remedy hereunder -will preclude the exercise or enforcement by such Party of any other right or -remedy hereunder or which such Party is otherwise entitled by law to enforce. - -13.7 Severability. If, in any jurisdiction, any provision of this -Agreement or its application to any Party or circumstance is restricted, -prohibited or unenforceable, the provision will, as to that jurisdiction, be -ineffective only to the extent of the restriction, prohibition or -unenforceability without invalidating the remaining provisions of this -Agreement and without affecting the validity or enforceability of such -provision in any other jurisdiction, or without affecting its application to -other Parties or circumstances. - -13.8 Assignment. SOLACE may assign this Agreement or any of the benefits, -rights or obligations under this Agreement without the prior written consent -of the Licensee. Licensee may not assign this Agreement or any of the -benefits, rights or obligations under this Agreement without the prior -written consent of SOLACE. Any attempt by Licensee to so assign or transfer -is null and void. If SOLACE does consent to an assignment of this Agreement, -the transferee/assignee must be acceptable to SOLACE and agree to the terms -and conditions of this Agreement. - -13.9 Further Assurances. The Parties will, with reasonable diligence, do -all things and provide all such reasonable assurances as may be required to -consummate the transactions contemplated by this Agreement, and each Party -will provide such further documents or instruments required by any other -Party as may be reasonably necessary or desirable to effect the purpose of -this Agreement and carry out its provisions. - -13.10 Governing Law and Jurisdiction. This Agreement is governed and -interpreted in accordance with the laws of the Province of Ontario and the -laws of Canada applicable therein, without giving effect to its conflict of -laws provisions. Any Claim arising out of or related to this Agreement must -be brought exclusively in a federal or provincial court located in Ottawa, -Canada, and Licensee hereby consents to the jurisdiction and venue of such -courts. Each of the Parties irrevocably waives, to the fullest extent it may -effectively do so, the defence of an inconvenient forum to the maintenance of -such action, application or proceeding. The Parties will not raise any -objection to the venue of any action, application, reference or other -proceeding arising out of or related to this Agreement in the federal or -provincial courts sitting in Ottawa, including the objection that the -proceedings have been brought in an inconvenient forum. A final judgment in -any such action, application or proceeding is conclusive and may be enforced -in other jurisdictions by suit on the judgment or in any other manner -specified by law. The United Nations Convention on Contracts for the -International Sale of Goods is expressly disclaimed and will not apply. +13.3 Amendments. This Agreement may be modified only by a written amendment +agreed to by both Licensee and SOLACE, except that SOLACE may modify the +Documentation from time to time, provided that SOLACE does not materially +lessen the description of the functionality of the Products as a result of such +modification. + +13.4 English Language. This Agreement is entered into solely in the English +language, and if for any reason any other language version is prepared by any +Party, it will be solely for convenience and the English version will govern +and control in all respects If Licensee are located in the province of +Quebec, Canada, the following applies: The Parties hereby confirm they have +requested this Agreement and all related documents be prepared in English Les +parties ont exig� que le pr�sent contrat et tous les documents connexes soient +r�dig�s en anglais. + +13.5 Waiver. To be effective, any waiver by a Party of any of its rights or any +other Party's obligations under this Agreement must be made in a writing +signed by the Party to be charged with the waiver. No failure or forbearance +by any Party to insist upon or enforce performance by any other Party of any of +the provisions of this Agreement or to exercise any rights or remedies under +this Agreement or otherwise at law or in equity will be construed as a waiver +or relinquishment to any extent of such Party's right to assert or rely upon +any such provision, right, or remedy in that or any other instance; rather, the +same will be and remain in full force and effect. A Party's waiver of a +breach of any term will not be a waiver of any subsequent breach of the same or +another term. + +13.6 Cumulative Rights. The rights of each Party hereunder are cumulative and +no exercise or enforcement by a Party of any right or remedy hereunder will +preclude the exercise or enforcement by such Party of any other right or remedy +hereunder or which such Party is otherwise entitled by law to enforce. + +13.7 Severability. If, in any jurisdiction, any provision of this Agreement or +its application to any Party or circumstance is restricted, prohibited or +unenforceable, the provision will, as to that jurisdiction, be ineffective only +to the extent of the restriction, prohibition or unenforceability without +invalidating the remaining provisions of this Agreement and without affecting +the validity or enforceability of such provision in any other jurisdiction, or +without affecting its application to other Parties or circumstances. + +13.8 Assignment. SOLACE may assign this Agreement or any of the benefits, +rights or obligations under this Agreement without the prior written consent of +the Licensee. Licensee may not assign this Agreement or any of the benefits, +rights or obligations under this Agreement without the prior written consent of +SOLACE. Any attempt by Licensee to so assign or transfer is null and void. If +SOLACE does consent to an assignment of this Agreement, the transferee/assignee +must be acceptable to SOLACE and agree to the terms and conditions of this +Agreement. + +13.9 Further Assurances. The Parties will, with reasonable diligence, do all +things and provide all such reasonable assurances as may be required to +consummate the transactions contemplated by this Agreement, and each Party will +provide such further documents or instruments required by any other Party as +may be reasonably necessary or desirable to effect the purpose of this +Agreement and carry out its provisions. + +13.10 Governing Law and Jurisdiction. This Agreement is governed and +interpreted in accordance with the laws of the Province of Ontario and the laws +of Canada applicable therein, without giving effect to its conflict of laws +provisions. Any Claim arising out of or related to this Agreement must be +brought exclusively in a federal or provincial court located in Ottawa, Canada, +and Licensee hereby consents to the jurisdiction and venue of such courts. +Each of the Parties irrevocably waives, to the fullest extent it may +effectively do so, the defence of an inconvenient forum to the maintenance of +such action, application or proceeding. The Parties will not raise any +objection to the venue of any action, application, reference or other +proceeding arising out of or related to this Agreement in the federal or +provincial courts sitting in Ottawa, including the objection that the +proceedings have been brought in an inconvenient forum. A final judgment in +any such action, application or proceeding is conclusive and may be enforced in +other jurisdictions by suit on the judgment or in any other manner specified by +law. The United Nations Convention on Contracts for the International Sale of +Goods is expressly disclaimed and will not apply. diff --git a/version.go b/version.go index 517096e1..5ac4c498 100644 --- a/version.go +++ b/version.go @@ -16,4 +16,4 @@ package main -const version = "0.9.0" +const version = "0.9.1"