diff --git a/.github/workflows/broker-build-test.yml b/.github/workflows/broker-build-test.yml new file mode 100644 index 00000000..2a664695 --- /dev/null +++ b/.github/workflows/broker-build-test.yml @@ -0,0 +1,158 @@ +name: Test Provider triggered by a broker build +# 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. +# broker builds are triggered by Jenkins from a broker release branch with an example pattern of 10.9.1 + +on: + push: + branches-ignore: + - dev* + - v* + - main + +jobs: + build: + name: Build & test provider from broker build + runs-on: ubuntu-latest + steps: + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.23" + + - name: Check out code + uses: actions/checkout@v4 + + - name: Checkout generator + uses: actions/checkout@v4 + with: + repository: SolaceDev/broker-terraform-code-generator + token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT + path: broker-terraform-code-generator + ref: "main" + + - name: Build and install generator + run: | + pushd broker-terraform-code-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-code-generator software-provider all + popd + + - name: Check changed files + uses: tj-actions/verify-changed-files@v17 + id: check-changed-files + with: + files: | + !broker-terraform-code-generator + !version.go + + - name: Run step only when no change detected + if: steps.check-changed-files.outputs.files_changed == 'false' + run: | + echo "No changes detected, skipping further steps" + + - name: List changed files - from now on all tests are run only if there were changes + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + echo "Changed files: ${{ steps.check-changed-files.outputs.changed_files }}" + echo ******** Excluding MarkdownDescription: + git diff -I MarkdownDescription + echo ******** Including MarkdownDescription: + git diff + + - name: Set up Terraform latest + if: steps.check-changed-files.outputs.files_changed == 'true' + uses: hashicorp/setup-terraform@v2 + with: + terraform_wrapper: false + + - name: Setup Test broker + if: steps.check-changed-files.outputs.files_changed == 'true' + 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:latest + while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done + + - name: Run acceptance test + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + make vet + make testacc + + - name: Use local provider + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + echo " + provider_installation { + dev_overrides { + \"registry.terraform.io/solaceproducts/solacebroker\" = \"${HOME}/go/bin\" + } + direct {} + }" > ~/.terraformrc + + - name: Build provider + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + make test-coverage + make install + ls ~/go/bin + terraform-provider-solacebroker -h + + - name: Run provider test - create custom messageVPN with large config + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + pushd ci/broker_vpn_test + # Create + terraform plan + terraform apply -auto-approve + sleep 1 + popd + + - name: Run generate test - generate complete large config file for custom messageVPN file + if: steps.check-changed-files.outputs.files_changed == 'true' + 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.test test messageVpn.tf + cat messageVpn.tf + + - name: Run provider test - delete large config + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + pushd ci/broker_vpn_test + terraform plan + terraform destroy -auto-approve + sleep 1 + popd + + - name: Test state upgrade + if: steps.check-changed-files.outputs.files_changed == 'true' + run: | + pushd ci/state_upgrade + bash -c "terraform plan &> results.out" || echo "Expecting terraform plan to fail" + cat results.out | grep "Found deprecated state key 'deprecated_att" + cp terraform.tfstate terraform.tfstate.bak + sed -i '/deprecated_att/d' terraform.tfstate # remove deprecated non-null attributes from state + terraform plan | grep "3 to add" + terraform apply -auto-approve | grep "Apply complete" + # GH actions fails on following commands, need to investigate. Passes locally. + # diff terraform.tfstate terraform.tfstate.bak > diff.out + # ls -l + # cat diff.out + # grep "> \"schema_version\": 0," diff.out | wc -l | grep 3 # verify schema has been upgraded + # grep "> \"deprecated1\": null," diff.out # verify deprecated has been removed + # grep "> \"deprecated2\": null," diff.out # verify deprecated has been removed + # grep "< \"clear_percent\": 20," diff.out # verify string has been converted to number + # grep "< \"egress_enabled\": true," diff.out # verify string has been converted to bool + # terraform destroy -auto-approve + popd diff --git a/.github/workflows/cli-test-pipeline.yml b/.github/workflows/cli-test-pipeline.yml index 70502b7d..f2002c51 100644 --- a/.github/workflows/cli-test-pipeline.yml +++ b/.github/workflows/cli-test-pipeline.yml @@ -10,7 +10,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22" + go-version: "1.23" - name: Check out code uses: actions/checkout@v4 @@ -22,7 +22,7 @@ jobs: 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.8.1.126" + --env system_scaling_maxconnectioncount="1000" --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.9.1.115" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Use local provider @@ -121,7 +121,7 @@ jobs: - name: Create custom messageVPN with large config run: | - pushd ci/broker_vpn_test + pushd ci/bigtest # Create terraform plan terraform apply -auto-approve @@ -132,7 +132,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.test test messageVpn.tf cat messageVpn.tf - # also confirm comment is generated when ancillary object is refereced + # also confirm comment is generated when ancillary object is referenced cat messageVpn.tf | grep depends_on - name: Generate some resources( only msg_vpn_queue) for custom messageVPN file diff --git a/.github/workflows/core-pipeline-dev.yml b/.github/workflows/core-pipeline-dev.yml index bc2f7253..9f8f64cd 100644 --- a/.github/workflows/core-pipeline-dev.yml +++ b/.github/workflows/core-pipeline-dev.yml @@ -4,8 +4,9 @@ name: Build Terraform Provider in Development phase on: push: - branches-ignore: - - main + branches: + - dev* + - v* jobs: build: @@ -15,7 +16,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22" + go-version: "1.23" - name: Check out code uses: actions/checkout@v4 @@ -72,7 +73,7 @@ jobs: fi - name: Check changed files - uses: tj-actions/verify-changed-files@v17 + uses: tj-actions/verify-changed-files@v20 id: check-changed-files with: files: | diff --git a/.github/workflows/core-pipeline-main-branch-only.yml b/.github/workflows/core-pipeline-main-branch-only.yml index 995e556e..e56b605b 100644 --- a/.github/workflows/core-pipeline-main-branch-only.yml +++ b/.github/workflows/core-pipeline-main-branch-only.yml @@ -13,7 +13,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22" + go-version: "1.23" - name: Check out code uses: actions/checkout@v4 diff --git a/.github/workflows/daily-sanity-main.yml b/.github/workflows/daily-sanity-main.yml new file mode 100644 index 00000000..b310dea4 --- /dev/null +++ b/.github/workflows/daily-sanity-main.yml @@ -0,0 +1,60 @@ +name: Daily sanity main +# Uses solace/solace-pubsub-standard:edge image + +on: + schedule: + - cron: "0 5 * * *" + +jobs: + build: + name: Daily test + runs-on: ubuntu-latest + steps: + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: "1.23" + + - name: Check out code + uses: actions/checkout@v4 + with: + ref: main + + - 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:edge + while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done + + - name: Set up Terraform latest - public + uses: hashicorp/setup-terraform@v3 + with: + terraform_wrapper: true + + - name: Run provider test - create custom messageVPN with large config + run: | + pushd ci/broker_vpn_test + terraform init + $(find .terraform/ | grep terraform-provider) version + # Create + terraform plan + terraform apply -auto-approve + sleep 1 + popd + + - name: Run generate test - generate complete large config file for custom messageVPN file + run: | + pushd ci/broker_vpn_test + SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=admin $(find .terraform/ | grep terraform-provider) generate --url=http://localhost:8080 solacebroker_msg_vpn.test test messageVpn.tf + cat messageVpn.tf + rm messageVpn.tf + popd + + - name: Run provider test - delete large config + run: | + pushd ci/broker_vpn_test + terraform plan + terraform destroy -auto-approve + sleep 1 + popd diff --git a/.github/workflows/prep-internal-release.yml b/.github/workflows/prep-internal-release.yml index d43cb4bb..4dcec8ae 100644 --- a/.github/workflows/prep-internal-release.yml +++ b/.github/workflows/prep-internal-release.yml @@ -2,10 +2,14 @@ on: workflow_dispatch: inputs: + prev_branch_name: + description: 'Prev branch name, must start with v' + required: true + default: 'v0.1.0-rc.1' release_branch_name: description: 'Release branch name, must start with v' required: true - default: 'v0.1.0-rc.1' + default: 'v0.1.0-rc.2' jobs: @@ -16,7 +20,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22" + go-version: "1.23" - name: Checkout the code uses: actions/checkout@v2 @@ -92,12 +96,26 @@ jobs: export WS_PROJECTNAME="${{ github.event.repository.name }}" java -jar ci/whitesource/wss-unified-agent.jar -c ci/whitesource/whitesource-agent.config -d . - - name: Create the release branch - uses: peterjgrainger/action-create-branch@v2.4.0 + - name: Create release branch starting point env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - branch: "${{ github.event.inputs.release_branch_name }}" + run: | + git fetch + git push origin refs/remotes/origin/${{ github.event.inputs.prev_branch_name }}:refs/heads/${{ github.event.inputs.release_branch_name }} + + - name: Create PR to release branch + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + CURRENT_BRANCH=${GITHUB_REF_NAME} + gh pr create -B ${{ github.event.inputs.release_branch_name }} --title "New release ${{ github.event.inputs.release_branch_name }}" --body 'Created by Github action' + + # - 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 != '' diff --git a/.github/workflows/provider-acceptance-test.yml b/.github/workflows/provider-acceptance-test.yml index 5431dfa6..0647b3c8 100644 --- a/.github/workflows/provider-acceptance-test.yml +++ b/.github/workflows/provider-acceptance-test.yml @@ -11,7 +11,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22" + go-version: "1.23" - name: Check out code uses: actions/checkout@v4 diff --git a/.github/workflows/provider-test-pipeline.yml b/.github/workflows/provider-test-pipeline.yml index 70c463ae..f51da1ee 100644 --- a/.github/workflows/provider-test-pipeline.yml +++ b/.github/workflows/provider-test-pipeline.yml @@ -10,7 +10,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22" + go-version: "1.23" - name: Check out code uses: actions/checkout@v4 @@ -22,7 +22,7 @@ jobs: 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 \ - --env system_scaling_maxconnectioncount="1000" --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.8.1.126" + --env system_scaling_maxconnectioncount="1000" --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.9.1.115" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Use local provider diff --git a/.github/workflows/verify-registry-release.yml b/.github/workflows/verify-registry-release.yml index 2e34d838..5bc8399a 100644 --- a/.github/workflows/verify-registry-release.yml +++ b/.github/workflows/verify-registry-release.yml @@ -20,7 +20,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22" + go-version: "1.23" - name: Check out code uses: actions/checkout@v4 @@ -29,7 +29,7 @@ jobs: 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.8.1.126" + --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.9.1.115" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Set up Terraform latest - public diff --git a/.gitignore b/.gitignore index d19d1d03..90ca1f81 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,5 @@ test __debug* bin dist -vendor \ No newline at end of file +vendor +broker-terraform-code-generator \ No newline at end of file diff --git a/Makefile b/Makefile index cf01b3c3..cd830342 100644 --- a/Makefile +++ b/Makefile @@ -47,3 +47,16 @@ clean: ## Remove previous build .PHONY: help: ## Display this help screen @grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' + +.PHONY: +generate-code: ## Generate latest code from SEMP API spec + @if [ ! -d "broker-terraform-code-generator" ]; then \ + git clone https://github.com/SolaceDev/broker-terraform-code-generator.git; \ + fi + @cd broker-terraform-code-generator && git pull ; \ + go mod tidy; \ + go install .; \ + ls ~/go/bin | grep broker-terraform-code-generator + @cd internal/broker/generated; \ + rm ./*; \ + SEMP_V2_SWAGGER_CONFIG_EXTENDED_JSON="../../../ci/swagger_spec/$(shell ls ci/swagger_spec)" ~/go/bin/broker-terraform-code-generator software-provider all; diff --git a/ci/bigtest/test.tf b/ci/bigtest/test.tf index a6d87e78..d2fc6edf 100644 --- a/ci/bigtest/test.tf +++ b/ci/bigtest/test.tf @@ -439,6 +439,7 @@ resource "solacebroker_msg_vpn_bridge_remote_msg_vpn" "msg_vpn_bridge_remote_msg 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 = "" # not providing this attribute shall not cause a fail remote_msg_vpn_location = "192.168.1.1:1234" remote_msg_vpn_name = "default" client_username = "test" @@ -674,6 +675,7 @@ resource "solacebroker_msg_vpn_jndi_connection_factory" "msg_vpn_jndi_connection transport_send_buffer_size = 65533 transport_tcp_no_delay_enabled = false xa_enabled = true + messaging_payload_compression_level = 5 } resource "solacebroker_msg_vpn_jndi_queue" "msg_vpn_jndi_queue" { @@ -836,7 +838,7 @@ resource "solacebroker_msg_vpn_queue" "msg_vpn_queue" { max_msg_spool_usage = 9999 max_redelivery_count = 9 max_ttl = 9 - owner = "test" + owner = "#kafka/tx/test" partition_count = 1 partition_rebalance_delay = 6 partition_rebalance_max_handoff_time = 4 @@ -979,6 +981,8 @@ resource "solacebroker_msg_vpn_rest_delivery_point_rest_consumer" "msg_vpn_rest_ retry_delay = 4 tls_cipher_suite_list = "default" tls_enabled = true + authentication_oauth_client_proxy_name = "test" + authentication_oauth_jwt_proxy_name = "test" } resource "solacebroker_msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim" "msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim" { diff --git a/ci/swagger_spec/semp-v2-swagger-config-extended.10.8.1.126.vm.json b/ci/swagger_spec/semp-v2-swagger-config-extended.10.9.1.115.vm.json similarity index 96% rename from ci/swagger_spec/semp-v2-swagger-config-extended.10.8.1.126.vm.json rename to ci/swagger_spec/semp-v2-swagger-config-extended.10.9.1.115.vm.json index 58211791..99362c50 100644 --- a/ci/swagger_spec/semp-v2-swagger-config-extended.10.8.1.126.vm.json +++ b/ci/swagger_spec/semp-v2-swagger-config-extended.10.9.1.115.vm.json @@ -450,7 +450,7 @@ "type": "boolean", "x-accessLevels": { "get": "global/read-only", - "patch": "global/read-write" + "patch": "global/admin" }, "x-autoDisable": [], "x-configSyncDefault": false, @@ -2059,7 +2059,7 @@ "x-writeOnly": false }, "tlsServerCertContent": { - "description": "The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. The default value is `\"\"`.", + "description": "The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`.", "maxLength": 32768, "minLength": 0, "type": "string", @@ -2082,7 +2082,7 @@ "x-writeOnly": true }, "tlsServerCertPassword": { - "description": "The password for the server certificate used for TLS connections. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. The default value is `\"\"`.", + "description": "The password for the server certificate used for TLS connections. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`.", "maxLength": 512, "minLength": 0, "type": "string", @@ -3135,7 +3135,7 @@ "x-writeOnly": false }, "authenticationBasicPassword": { - "description": "The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. 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 via config-sync. The default value is `\"\"`.", + "description": "The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may 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 `\"\"`.", "maxLength": 128, "minLength": 0, "type": "string", @@ -3188,7 +3188,7 @@ "x-writeOnly": false }, "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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", @@ -3236,7 +3236,7 @@ "x-writeOnly": false }, "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. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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", @@ -3944,7 +3944,7 @@ "DmrClusterLink": { "properties": { "authenticationBasicPassword": { - "description": "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. 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 via config-sync. The default value is `\"\"`.", + "description": "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may 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 `\"\"`.", "maxLength": 128, "minLength": 0, "type": "string", @@ -8168,7 +8168,7 @@ "x-writeOnly": false }, "replicationBridgeAuthenticationBasicPassword": { - "description": "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. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "description": "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", "maxLength": 128, "minLength": 0, "type": "string", @@ -8195,7 +8195,7 @@ "x-writeOnly": true }, "replicationBridgeAuthenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. The default value is `\"\"`. Available since 2.9.", + "description": "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`. Available since 2.9.", "maxLength": 32768, "minLength": 0, "type": "string", @@ -8218,7 +8218,7 @@ "x-writeOnly": true }, "replicationBridgeAuthenticationClientCertPassword": { - "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. The default value is `\"\"`. Available since 2.9.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`. Available since 2.9.", "maxLength": 512, "minLength": 0, "type": "string", @@ -8418,7 +8418,7 @@ "x-writeOnly": false }, "replicationEnabledQueueBehavior": { - "description": "The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are:\n\n
\n\"fail-on-existing-queue\" - The data replication queue must not already exist.\n\"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail.\n\"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications.\n\n", + "description": "The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are:\n\n
\n\"fail-on-existing-queue\" - The data replication queue must not already exist.\n\"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail.\n\"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications.\n\n", "enum": [ "fail-on-existing-queue", "force-use-existing-queue", @@ -10944,7 +10944,7 @@ "x-writeOnly": false }, "clientSecret": { - "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. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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", @@ -12348,7 +12348,7 @@ "x-writeOnly": false }, "tokenIntrospectionPassword": { - "description": "The password to use when logging into the token introspection URI. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", + "description": "The password to use when logging into the token introspection URI. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthProviders replaced by authenticationOauthProfiles.", "maxLength": 64, "minLength": 0, "type": "string", @@ -12704,7 +12704,7 @@ "x-writeOnly": false }, "orderAfterAuthorizationGroupName": { - "description": "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. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", + "description": "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", "maxLength": 256, "minLength": 1, "type": "string", @@ -12729,7 +12729,7 @@ "x-writeOnly": true }, "orderBeforeAuthorizationGroupName": { - "description": "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. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", + "description": "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", "maxLength": 256, "minLength": 1, "type": "string", @@ -12963,7 +12963,7 @@ "x-writeOnly": false }, "remoteAuthenticationBasicPassword": { - "description": "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. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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 Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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": 128, "minLength": 0, "type": "string", @@ -12992,7 +12992,7 @@ "x-writeOnly": true }, "remoteAuthenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 `\"\"`. Available since 2.9.", + "description": "The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since 2.9.", "maxLength": 32768, "minLength": 0, "type": "string", @@ -13017,7 +13017,7 @@ "x-writeOnly": true }, "remoteAuthenticationClientCertPassword": { - "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 `\"\"`. Available since 2.9.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since 2.9.", "maxLength": 512, "minLength": 0, "type": "string", @@ -13415,7 +13415,7 @@ "x-writeOnly": false }, "password": { - "description": "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. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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 Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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": 128, "minLength": 0, "type": "string", @@ -17265,7 +17265,7 @@ "x-writeOnly": false }, "password": { - "description": "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. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 128, "minLength": 0, "type": "string", @@ -21858,6 +21858,32 @@ "x-sensitive": false, "x-writeOnly": false }, + "messagingPayloadCompressionLevel": { + "description": "The level of compression to apply to the message payload, from 1 (least compression) to 9 (most compression). A value of 0 means no compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.42.", + "format": "int32", + "maximum": 9, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "vpn", + "x-default": 0, + "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-sensitive": false, + "x-writeOnly": false + }, "messagingTextInXmlPayloadEnabled": { "description": "Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.", "type": "boolean", @@ -22646,7 +22672,7 @@ "MsgVpnKafkaReceiver": { "properties": { "authenticationBasicPassword": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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", @@ -22702,7 +22728,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. 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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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", @@ -22727,7 +22753,7 @@ "x-writeOnly": true }, "authenticationClientCertPassword": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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", @@ -22755,7 +22781,7 @@ "x-writeOnly": true }, "authenticationKerberosKeytabContent": { - "description": "The base64-encoded content of this User Principal's keytab. 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 `\"\"`. Available since 2.40.", + "description": "The base64-encoded content of this User Principal's keytab. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since 2.40.", "maxLength": 2048, "minLength": 0, "type": "string", @@ -22926,7 +22952,7 @@ "x-writeOnly": false }, "authenticationOauthClientSecret": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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", @@ -23042,7 +23068,7 @@ "x-writeOnly": false }, "authenticationScramPassword": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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", @@ -23762,7 +23788,7 @@ "MsgVpnKafkaSender": { "properties": { "authenticationBasicPassword": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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", @@ -23818,7 +23844,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. 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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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", @@ -23843,7 +23869,7 @@ "x-writeOnly": true }, "authenticationClientCertPassword": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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", @@ -23871,7 +23897,7 @@ "x-writeOnly": true }, "authenticationKerberosKeytabContent": { - "description": "The base64-encoded content of this User Principal's keytab. 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 `\"\"`. Available since 2.40.", + "description": "The base64-encoded content of this User Principal's keytab. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since 2.40.", "maxLength": 2048, "minLength": 0, "type": "string", @@ -24042,7 +24068,7 @@ "x-writeOnly": false }, "authenticationOauthClientSecret": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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", @@ -24158,7 +24184,7 @@ "x-writeOnly": false }, "authenticationScramPassword": { - "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 `\"\"`.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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", @@ -25032,7 +25058,7 @@ "type": "string" }, "sequencedTopicsUri": { - "description": "The URI of this Message VPN's collection of Sequenced Topic objects.", + "description": "The URI of this Message VPN's collection of Sequenced Topic objects. Deprecated since 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", "type": "string" }, "telemetryProfilesUri": { @@ -26303,7 +26329,7 @@ "MsgVpnProxy": { "properties": { "authenticationBasicPassword": { - "description": "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "description": "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", "maxLength": 64, "minLength": 0, "type": "string", @@ -29862,7 +29888,7 @@ "x-writeOnly": false }, "headerValue": { - "description": "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. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 2000, "minLength": 0, "type": "string", @@ -30288,7 +30314,7 @@ "x-writeOnly": false }, "authenticationAwsSecretAccessKey": { - "description": "The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", + "description": "The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.26.", "maxLength": 64, "minLength": 0, "type": "string", @@ -30337,7 +30363,7 @@ "x-writeOnly": false }, "authenticationClientCertContent": { - "description": "The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 `\"\"`. Available since 2.9.", + "description": "The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since 2.9.", "maxLength": 32768, "minLength": 0, "type": "string", @@ -30362,7 +30388,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 `\"\"`. Available since 2.9.", + "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since 2.9.", "maxLength": 512, "minLength": 0, "type": "string", @@ -30390,7 +30416,7 @@ "x-writeOnly": true }, "authenticationHttpBasicPassword": { - "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. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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": 128, "minLength": 0, "type": "string", @@ -30475,7 +30501,7 @@ "x-writeOnly": false }, "authenticationHttpHeaderValue": { - "description": "The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", + "description": "The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.15.", "maxLength": 2100, "minLength": 0, "pattern": "^[ -~\\t]*$", @@ -30526,6 +30552,31 @@ "x-sensitive": false, "x-writeOnly": false }, + "authenticationOauthClientProxyName": { + "description": "The name of the proxy to use. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.42.", + "maxLength": 32, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", + "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-sensitive": false, + "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 `\"\"`. Available since 2.19.", "maxLength": 200, @@ -30554,7 +30605,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 `\"\"`. Available since 2.19.", + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", "maxLength": 512, "minLength": 0, "type": "string", @@ -30580,7 +30631,7 @@ "x-writeOnly": true }, "authenticationOauthClientTokenEndpoint": { - "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. 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 `\"\"`. Available since 2.19.", + "description": "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.19.", "maxLength": 2048, "minLength": 0, "type": "string", @@ -30634,8 +30685,33 @@ "x-sensitive": false, "x-writeOnly": false }, + "authenticationOauthJwtProxyName": { + "description": "The name of the proxy to use. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.42.", + "maxLength": 32, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", + "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-sensitive": false, + "x-writeOnly": false + }, "authenticationOauthJwtSecretKey": { - "description": "The OAuth secret key used to sign the token request JWT. 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 `\"\"`. Available since 2.21.", + "description": "The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.21.", "maxLength": 4096, "minLength": 0, "type": "string", @@ -31508,7 +31584,7 @@ "MsgVpnSequencedTopic": { "properties": { "msgVpnName": { - "description": "The name of the Message VPN.", + "description": "The name of the Message VPN. Deprecated since 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", "maxLength": 32, "minLength": 1, "pattern": "^[^*?]+$", @@ -31517,7 +31593,7 @@ "get": "vpn/read-only" }, "x-autoDisable": [], - "x-deprecated": false, + "x-deprecated": true, "x-identifying": true, "x-identifyingDirect": false, "x-opaque": false, @@ -31530,7 +31606,7 @@ "x-writeOnly": false }, "sequencedTopic": { - "description": "Topic for applying sequence numbers.", + "description": "Topic for applying sequence numbers. Deprecated since 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", "maxLength": 250, "minLength": 1, "type": "string", @@ -31538,7 +31614,7 @@ "get": "vpn/read-only" }, "x-autoDisable": [], - "x-deprecated": false, + "x-deprecated": true, "x-identifying": true, "x-identifyingDirect": true, "x-opaque": false, @@ -32906,7 +32982,7 @@ "MsgVpnTopicEndpoint": { "properties": { "accessType": { - "description": "The access type for delivering messages to consumer flows bound to the Topic Endpoint. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n\n Available since 2.4.", + "description": "The access type for delivering messages to consumer flows bound to the Topic Endpoint. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egressEnabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.\n\n Available since 2.4.", "enum": [ "exclusive", "non-exclusive" @@ -34045,7 +34121,7 @@ "MsgVpnTopicEndpointTemplate": { "properties": { "accessType": { - "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n\n", + "description": "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n
\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.\n\n", "enum": [ "exclusive", "non-exclusive" @@ -35317,7 +35393,7 @@ "x-writeOnly": false }, "clientSecret": { - "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. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "description": "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", "maxLength": 512, "minLength": 0, "type": "string", @@ -37236,7 +37312,7 @@ "Proxy": { "properties": { "authenticationBasicPassword": { - "description": "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "description": "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", "maxLength": 64, "minLength": 0, "type": "string", @@ -38312,7 +38388,7 @@ }, "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": "2.41" + "version": "2.42" }, "parameters": { "countQuery": { @@ -38421,7 +38497,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|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:---|:---:\nauthBruteForceProtectionEnabled|global/read-write\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.", + "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:---|:---:\nauthBruteForceProtectionEnabled|global/admin\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": [ { @@ -38986,7 +39062,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|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.", + "description": "Replace a Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -39537,7 +39613,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|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.", + "description": "Replace a Client Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -40084,7 +40160,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|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.", + "description": "Replace a Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -40442,7 +40518,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -40842,7 +40918,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -41475,7 +41551,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|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.", + "description": "Replace a Link object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -42588,7 +42664,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -42911,7 +42987,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|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.", + "description": "Replace a Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -43274,7 +43350,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -45313,7 +45389,7 @@ "x-supportedInSempDirect": false }, "put": { - "description": "Replace a Realm object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nKerberos Realm.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nkdcAddress||||x\nkerberosRealmName|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.40.", + "description": "Replace a Realm object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\n\nKerberos Realm.\n\n\nAttribute|Identifying|Const|Read-Only|Auto-Disable\n:---|:---:|:---:|:---:|:---:\nkdcAddress||||x\nkerberosRealmName|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.40.", "operationId": "replaceMsgVpnAuthenticationKerberosRealm", "parameters": [ { @@ -45684,7 +45760,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|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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -46591,7 +46667,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|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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -46962,7 +47038,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|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.", + "description": "Replace an Authorization Group object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -47354,7 +47430,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|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.", + "description": "Replace a Bridge object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -47835,7 +47911,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|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.", + "description": "Replace a Remote Message VPN object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -48815,7 +48891,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -49221,7 +49297,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -49864,7 +49940,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|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.", + "description": "Replace a Client Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -50235,7 +50311,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|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.", + "description": "Replace a Client Username object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -50885,7 +50961,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\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.", + "description": "Replace a Distributed Cache object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -51291,7 +51367,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|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.", + "description": "Replace a Cache Cluster object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -52353,7 +52429,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -53031,7 +53107,7 @@ "x-supportedInSempDirect": true }, "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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -53402,7 +53478,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -53773,7 +53849,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -54144,7 +54220,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -54515,7 +54591,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\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|\nauthenticationKerberosKeytabContent||||x|x|\nauthenticationKerberosKeytabFileName|||||x|\nauthenticationKerberosServiceName|||||x|\nauthenticationKerberosUserPrincipalName|||||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|authenticationKerberosKeytabContent|authenticationKerberosKeytabFileName, authenticationKerberosUserPrincipalName\nMsgVpnKafkaReceiver|authenticationKerberosKeytabFileName|authenticationKerberosKeytabContent, authenticationKerberosUserPrincipalName\nMsgVpnKafkaReceiver|authenticationKerberosUserPrincipalName|authenticationKerberosKeytabContent, authenticationKerberosKeytabFileName\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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|\nauthenticationKerberosKeytabContent||||x|x|\nauthenticationKerberosKeytabFileName|||||x|\nauthenticationKerberosServiceName|||||x|\nauthenticationKerberosUserPrincipalName|||||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|authenticationKerberosKeytabContent|authenticationKerberosKeytabFileName, authenticationKerberosUserPrincipalName\nMsgVpnKafkaReceiver|authenticationKerberosKeytabFileName|authenticationKerberosKeytabContent, authenticationKerberosUserPrincipalName\nMsgVpnKafkaReceiver|authenticationKerberosUserPrincipalName|authenticationKerberosKeytabContent, authenticationKerberosKeytabFileName\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": [ { @@ -54921,7 +54997,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|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.", + "description": "Replace a Topic Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -55299,7 +55375,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\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|\nauthenticationKerberosKeytabContent||||x|x|\nauthenticationKerberosKeytabFileName|||||x|\nauthenticationKerberosServiceName|||||x|\nauthenticationKerberosUserPrincipalName|||||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|authenticationKerberosKeytabContent|authenticationKerberosKeytabFileName, authenticationKerberosUserPrincipalName\nMsgVpnKafkaSender|authenticationKerberosKeytabFileName|authenticationKerberosKeytabContent, authenticationKerberosUserPrincipalName\nMsgVpnKafkaSender|authenticationKerberosUserPrincipalName|authenticationKerberosKeytabContent, authenticationKerberosKeytabFileName\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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|\nauthenticationKerberosKeytabContent||||x|x|\nauthenticationKerberosKeytabFileName|||||x|\nauthenticationKerberosServiceName|||||x|\nauthenticationKerberosUserPrincipalName|||||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|authenticationKerberosKeytabContent|authenticationKerberosKeytabFileName, authenticationKerberosUserPrincipalName\nMsgVpnKafkaSender|authenticationKerberosKeytabFileName|authenticationKerberosKeytabContent, authenticationKerberosUserPrincipalName\nMsgVpnKafkaSender|authenticationKerberosUserPrincipalName|authenticationKerberosKeytabContent, authenticationKerberosKeytabFileName\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": [ { @@ -55705,7 +55781,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|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.", + "description": "Replace a Queue Binding object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -56083,7 +56159,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -56475,7 +56551,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|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.", + "description": "Replace an MQTT Session object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -56923,7 +56999,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -57308,7 +57384,7 @@ "x-supportedInSempDirect": true }, "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|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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -57679,7 +57755,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -58050,7 +58126,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|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.", + "description": "Replace a Queue object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -58686,7 +58762,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -59322,7 +59398,7 @@ "x-supportedInSempDirect": true }, "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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -59693,7 +59769,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|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.", + "description": "Replace a REST Delivery Point object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -60099,7 +60175,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -60547,7 +60623,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|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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -61002,7 +61078,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -61422,7 +61498,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|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.", + "description": "Replace a REST Consumer object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -62079,7 +62155,8 @@ }, "/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\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.", + "deprecated": true, + "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|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\nsequencedTopic|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.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", "operationId": "getMsgVpnSequencedTopics", "parameters": [ { @@ -62141,7 +62218,8 @@ "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\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.", + "deprecated": true, + "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|Deprecated\n:---|:---:|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x|x\nsequencedTopic|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.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", "operationId": "createMsgVpnSequencedTopic", "parameters": [ { @@ -62202,7 +62280,8 @@ }, "/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}": { "delete": { - "description": "Delete a Sequenced Topic object. The deletion 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\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.", + "deprecated": true, + "description": "Delete a Sequenced Topic object. The deletion 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\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.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", "operationId": "deleteMsgVpnSequencedTopic", "parameters": [ { @@ -62253,7 +62332,8 @@ "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\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.", + "deprecated": true, + "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|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\nsequencedTopic|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.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", "operationId": "getMsgVpnSequencedTopic", "parameters": [ { @@ -62614,7 +62694,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -63285,7 +63365,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -63970,7 +64050,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -64341,7 +64421,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|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.", + "description": "Replace a Topic Endpoint object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -64672,7 +64752,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|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\nproxyName|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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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\nproxyName|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": [ { @@ -65030,7 +65110,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\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.", + "description": "Replace a Group Access Level object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -65430,7 +65510,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -66035,7 +66115,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -66633,7 +66713,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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": [ { @@ -67196,7 +67276,7 @@ "x-supportedInSempDirect": true }, "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 OAuth Provider, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||x|x\nproxyName|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.41.", + "description": "Replace a Proxy object. Any attribute missing from the request will be set to its default value, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a OAuth Provider, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||x|x\nproxyName|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.41.", "operationId": "replaceProxy", "parameters": [ { @@ -67565,7 +67645,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\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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods).\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/cmd/generate.go b/cmd/generate.go index 4a78ee2a..5cde258e 100644 --- a/cmd/generate.go +++ b/cmd/generate.go @@ -46,7 +46,7 @@ This is not a Terraform command. You can download the provider binary and execut Example: SOLACEBROKER_USERNAME=adminuser SOLACEBROKER_PASSWORD=pass \ - terraform-provider-solacebroker generate --url=https://localhost:8080 solacebroker_msg_vpn.myvpn test vpn-config.tf + terraform-provider-solacebroker generate --url=http://localhost:8080 solacebroker_msg_vpn.myvpn test vpn-config.tf This command will create a file vpn-config.tf that contains a resource definition for the 'test' message VPN and any child objects on the broker, assuming the appropriate broker credentials were set in environment variables. The message VPN resource address in the generated configuration will be 'solacebroker_msg_vpn.myvpn'.`, @@ -184,7 +184,7 @@ The message VPN resource address in the generated configuration will be 'solaceb func init() { rootCmd.AddCommand(generateCmd) - generateCmd.PersistentFlags().String("url", "http://localhost:8080", "Broker base URL") + generateCmd.PersistentFlags().String("url", "http://localhost:8080", "Broker base URL, for example https://mybroker.example.org:
"exclusive" - Exclusive delivery of messages to the first bound consumer flow. -"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion. +"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.Available since SEMP API version 2.4. - `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`. diff --git a/docs/data-sources/msg_vpn_topic_endpoint_template.md b/docs/data-sources/msg_vpn_topic_endpoint_template.md index 2fc9823e..04543ecf 100644 --- a/docs/data-sources/msg_vpn_topic_endpoint_template.md +++ b/docs/data-sources/msg_vpn_topic_endpoint_template.md @@ -34,7 +34,7 @@ This has been available since SEMP API version 2.14.
"exclusive" - Exclusive delivery of messages to the first bound consumer flow. -"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion. +"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.- `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`. - `dead_msg_queue` (String) The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"#DEAD_MSG_QUEUE"`. diff --git a/docs/guides/provider.md b/docs/guides/provider.md index df1a4ab8..2d6a4a2e 100644 --- a/docs/guides/provider.md +++ b/docs/guides/provider.md @@ -86,6 +86,8 @@ Generally, changing a "required" attribute requires the replace of any resource ## Importing Resources +Import shall be used to take resources you have created by some other means and bring them under Terraform management. + When [importing a resource](https://developer.hashicorp.com/terraform/cli/commands/import) to Terraform, an [ID or import identifier](https://developer.hashicorp.com/terraform/language/import#import-id) is required. Use the navigation to the left to look up the provider import identifier for the required resource. We recommend using the following procedure to import a resource: diff --git a/docs/index.md b/docs/index.md index 35b81bb4..e2643f86 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,10 +41,13 @@ terraform { } } -# Configure the provider +# Configure the provider provider "solacebroker" { + # Event broker management user credentials username = "admin" password = "admin" + # The base URL of the PubSub+ event broker, + # for example https://mybroker.example.org:
"internal" - Use locally configured password. "none" - No authentication.-- `authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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_content` (String, Sensitive) The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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_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`. -- `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_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `""`. - `direct_only_enabled` (Boolean) Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The default value is `false`. Note that this attribute requires replacement of the resource when updated. - `enabled` (Boolean) Enable or disable the Cluster. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `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`. diff --git a/docs/resources/dmr_cluster_link.md b/docs/resources/dmr_cluster_link.md index 925eb317..b71582f0 100644 --- a/docs/resources/dmr_cluster_link.md +++ b/docs/resources/dmr_cluster_link.md @@ -36,7 +36,7 @@ The import identifier for this resource is `{dmr_cluster_name}/{remote_node_name ### Optional -- `authentication_basic_password` (String, Sensitive) The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. 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 via config-sync. The default value is `""`. +- `authentication_basic_password` (String, Sensitive) The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may 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 `""`. - `authentication_scheme` (String) The authentication scheme to be used by the Link which initiates connections to the remote node. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may 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 `"basic"`. The allowed values and their meaning are:
diff --git a/docs/resources/msg_vpn.md b/docs/resources/msg_vpn.md index 67e0cfa5..f8bae1e7 100644 --- a/docs/resources/msg_vpn.md +++ b/docs/resources/msg_vpn.md @@ -134,9 +134,9 @@ Changes to this attribute are synchronized to HA mates and replication sites via - `mqtt_retain_max_memory` (Number) The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. 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.11. - `replication_ack_propagation_interval_msg_count` (Number) The acknowledgment (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`. - `replication_bridge_authentication_basic_client_username` (String) The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. -- `replication_bridge_authentication_basic_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 via config-sync. The default value is `""`. -- `replication_bridge_authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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`). The default value is `""`. Available since SEMP API version 2.9. -- `replication_bridge_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`). The default value is `""`. Available since SEMP API version 2.9. +- `replication_bridge_authentication_basic_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. +- `replication_bridge_authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `""`. Available since SEMP API version 2.9. +- `replication_bridge_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `""`. Available since SEMP API version 2.9. - `replication_bridge_authentication_scheme` (String) The authentication scheme for the replication Bridge in the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"basic"`. The allowed values and their meaning are:@@ -149,7 +149,7 @@ Changes to this attribute are synchronized to HA mates and replication sites via - `replication_bridge_tls_enabled` (Boolean) Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `replication_bridge_unidirectional_client_profile_name` (String) The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"#client-profile"`. - `replication_enabled` (Boolean) Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. -- `replication_enabled_queue_behavior` (String, Sensitive) The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. 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 via config-sync. The default value is `"fail-on-existing-queue"`. The allowed values and their meaning are: +- `replication_enabled_queue_behavior` (String, Sensitive) The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"fail-on-existing-queue"`. The allowed values and their meaning are:"fail-on-existing-queue" - The data replication queue must not already exist. diff --git a/docs/resources/msg_vpn_authentication_oauth_profile.md b/docs/resources/msg_vpn_authentication_oauth_profile.md index 91dc6ce6..7650d343 100644 --- a/docs/resources/msg_vpn_authentication_oauth_profile.md +++ b/docs/resources/msg_vpn_authentication_oauth_profile.md @@ -43,7 +43,7 @@ The import identifier for this resource is `{msg_vpn_name}/{oauth_profile_name}` Available since SEMP API version 2.32. - `client_id` (String) The OAuth client id. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `client_required_type` (String) The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"JWT"`. -- `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`). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `client_validate_type_enabled` (Boolean) Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `disconnect_on_token_expiration_enabled` (Boolean) Enable or disable the disconnection of clients when their tokens expire. Changing this value does not affect existing clients, only new client connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `enabled` (Boolean) Enable or disable the OAuth profile. 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_authorization_group.md b/docs/resources/msg_vpn_authorization_group.md index 39bcef6a..2d7316dc 100644 --- a/docs/resources/msg_vpn_authorization_group.md +++ b/docs/resources/msg_vpn_authorization_group.md @@ -36,5 +36,5 @@ The import identifier for this resource is `{msg_vpn_name}/{authorization_group_ - `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`. -- `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. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable. diff --git a/docs/resources/msg_vpn_bridge.md b/docs/resources/msg_vpn_bridge.md index 48c4b635..fab78594 100644 --- a/docs/resources/msg_vpn_bridge.md +++ b/docs/resources/msg_vpn_bridge.md @@ -43,9 +43,9 @@ The import identifier for this resource is `{msg_vpn_name}/{bridge_name}/{bridge - `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`. - `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_basic_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`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 `""`. Available since SEMP API version 2.9. -- `remote_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 `""`. Available since SEMP API version 2.9. +- `remote_authentication_basic_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.9. +- `remote_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.9. - `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:-- `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_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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. diff --git a/docs/resources/msg_vpn_proxy.md b/docs/resources/msg_vpn_proxy.md index 776bc8e5..6631e10c 100644 --- a/docs/resources/msg_vpn_proxy.md +++ b/docs/resources/msg_vpn_proxy.md @@ -33,7 +33,7 @@ The import identifier for this resource is `{msg_vpn_name}/{proxy_name}`, where ### Optional -- `authentication_basic_password` (String, Sensitive) The password to use with basic authentication. 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 via config-sync. The default value is `""`. +- `authentication_basic_password` (String, Sensitive) The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `authentication_basic_username` (String) The username to use with basic authentication. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `authentication_scheme` (String) The authentication scheme used to connect to the proxy. 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/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 b4f3beb4..79c677f6 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 @@ -35,4 +35,4 @@ The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_ ### 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 `""`. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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_rest_delivery_point_rest_consumer.md b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md index 4d941d7e..9e948a01 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md +++ b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md @@ -36,20 +36,22 @@ The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_ - `authentication_aws_access_key_id` (String) The AWS access key id. 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.26. - `authentication_aws_region` (String) The AWS region id. 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.26. -- `authentication_aws_secret_access_key` (String, Sensitive) The AWS secret access key. 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 `""`. Available since SEMP API version 2.26. +- `authentication_aws_secret_access_key` (String, Sensitive) The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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.26. - `authentication_aws_service` (String) The AWS service id. 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.26. -- `authentication_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 `""`. Available since SEMP API version 2.9. -- `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 `""`. Available since SEMP API version 2.9. -- `authentication_http_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_client_cert_content` (String, Sensitive) The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.9. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.9. +- `authentication_http_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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_http_basic_username` (String) The username that the REST Consumer will use to login to the REST host. Normally a username is only configured when basic authentication is selected 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 `""`. - `authentication_http_header_name` (String) The authentication header name. 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.15. -- `authentication_http_header_value` (String, Sensitive) The authentication header value. 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 `""`. Available since SEMP API version 2.15. +- `authentication_http_header_value` (String, Sensitive) The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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.15. - `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 `""`. Available since SEMP API version 2.19. +- `authentication_oauth_client_proxy_name` (String) The name of the proxy to use. Leave empty for no proxy. 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.42. - `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 `""`. Available since SEMP API version 2.19. -- `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 `""`. Available since SEMP API version 2.19. -- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. 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 `""`. Available since SEMP API version 2.19. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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. +- `authentication_oauth_client_token_endpoint` (String) The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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. - `authentication_oauth_client_token_expiry_default` (Number) The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `900`. Available since SEMP API version 2.30. -- `authentication_oauth_jwt_secret_key` (String, Sensitive) The OAuth secret key used to sign the token request JWT. 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 `""`. Available since SEMP API version 2.21. +- `authentication_oauth_jwt_proxy_name` (String) The name of the proxy to use. Leave empty for no proxy. 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.42. +- `authentication_oauth_jwt_secret_key` (String, Sensitive) The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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.21. - `authentication_oauth_jwt_token_endpoint` (String) The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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.21. - `authentication_oauth_jwt_token_expiry_default` (Number) The default expiry time for a token, in seconds. Only used when the token endpoint does not return an expiry time. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `900`. Available since SEMP API version 2.30. - `authentication_scheme` (String) The authentication scheme used by the REST Consumer to login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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: diff --git a/docs/resources/msg_vpn_sequenced_topic.md b/docs/resources/msg_vpn_sequenced_topic.md index bb381a71..630039eb 100644 --- a/docs/resources/msg_vpn_sequenced_topic.md +++ b/docs/resources/msg_vpn_sequenced_topic.md @@ -5,7 +5,7 @@ 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. 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. + This has been deprecated since SEMP API version 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature. The import identifier for this resource is {msg_vpn_name}/{sequenced_topic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- @@ -17,7 +17,7 @@ A Sequenced Topic is a topic subscription for which any matching messages receiv 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. +This has been deprecated since SEMP API version 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature. The import identifier for this resource is `{msg_vpn_name}/{sequenced_topic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -28,5 +28,5 @@ The import identifier for this resource is `{msg_vpn_name}/{sequenced_topic}`, w ### Required -- `msg_vpn_name` (String) The name of the Message VPN. -- `sequenced_topic` (String) Topic for applying sequence numbers. +- `msg_vpn_name` (String, Deprecated) The name of the Message VPN. Deprecated since SEMP API version 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature. +- `sequenced_topic` (String, Deprecated) Topic for applying sequence numbers. Deprecated since SEMP API version 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature. diff --git a/docs/resources/msg_vpn_topic_endpoint.md b/docs/resources/msg_vpn_topic_endpoint.md index 407e29d2..cddf4382 100644 --- a/docs/resources/msg_vpn_topic_endpoint.md +++ b/docs/resources/msg_vpn_topic_endpoint.md @@ -37,7 +37,7 @@ The import identifier for this resource is `{msg_vpn_name}/{topic_endpoint_name}diff --git a/docs/resources/msg_vpn_bridge_remote_msg_vpn.md b/docs/resources/msg_vpn_bridge_remote_msg_vpn.md index 6ecc7b1b..20df0459 100644 --- a/docs/resources/msg_vpn_bridge_remote_msg_vpn.md +++ b/docs/resources/msg_vpn_bridge_remote_msg_vpn.md @@ -47,7 +47,7 @@ The import identifier for this resource is `{msg_vpn_name}/{bridge_name}/{bridge - `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`. -- `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`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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_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 `""`. - `remote_msg_vpn_interface` (String) The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, `remote_msg_vpn_location` must not be a virtual router name. - `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`. diff --git a/docs/resources/msg_vpn_client_username.md b/docs/resources/msg_vpn_client_username.md index 1ba07f7b..8d114a40 100644 --- a/docs/resources/msg_vpn_client_username.md +++ b/docs/resources/msg_vpn_client_username.md @@ -37,5 +37,5 @@ The import identifier for this resource is `{msg_vpn_name}/{client_username}`, w - `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`. -- `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 `""`. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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`. diff --git a/docs/resources/msg_vpn_jndi_connection_factory.md b/docs/resources/msg_vpn_jndi_connection_factory.md index 771c70b3..6ec0487f 100644 --- a/docs/resources/msg_vpn_jndi_connection_factory.md +++ b/docs/resources/msg_vpn_jndi_connection_factory.md @@ -58,6 +58,7 @@ The import identifier for this resource is `{msg_vpn_name}/{connection_factory_n - `messaging_default_dmq_eligible_enabled` (Boolean) Enable or disable whether messages sent by the Publisher (Producer) are Dead Message Queue (DMQ) eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `messaging_default_eliding_eligible_enabled` (Boolean) Enable or disable whether messages sent by the Publisher (Producer) are Eliding eligible by default. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `messaging_jmsx_user_id_enabled` (Boolean) Enable or disable inclusion (adding or replacing) of the JMSXUserID property in 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 `false`. +- `messaging_payload_compression_level` (Number) The level of compression to apply to the message payload, from 1 (least compression) to 9 (most compression). A value of 0 means no compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since SEMP API version 2.42. - `messaging_text_in_xml_payload_enabled` (Boolean) Enable or disable encoding of JMS text messages in Publisher (Producer) messages as XML payload. When disabled, JMS text messages are encoded as a binary attachment. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `transport_compression_level` (Number) The ZLIB compression level for the connection to the broker. The value "0" means no compression, and the value "-1" means the compression level is specified in the JNDI Properties file. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. - `transport_connect_retry_count` (Number) The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value "0" means a single attempt (no retries), and the value "-1" means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. diff --git a/docs/resources/msg_vpn_kafka_receiver.md b/docs/resources/msg_vpn_kafka_receiver.md index 423f3375..7e0d9078 100644 --- a/docs/resources/msg_vpn_kafka_receiver.md +++ b/docs/resources/msg_vpn_kafka_receiver.md @@ -33,17 +33,17 @@ The import identifier for this resource is `{msg_vpn_name}/{kafka_receiver_name} ### Optional -- `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_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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_kerberos_keytab_content` (String, Sensitive) The base64-encoded content of this User Principal's keytab. 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 `""`. Available since SEMP API version 2.40. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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_kerberos_keytab_content` (String, Sensitive) The base64-encoded content of this User Principal's keytab. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.40. - `authentication_kerberos_keytab_file_name` (String) The name of this User Principal's keytab file. Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.40. - `authentication_kerberos_service_name` (String) The Kerberos service name of the remote Kafka broker, not including /hostname@REALM. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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.40. - `authentication_kerberos_user_principal_name` (String) The Kerberos user principal name of the Kafka Receiver. This must include the @<REALM> suffix. Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.40. - `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_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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: @@ -61,7 +61,7 @@ The import identifier for this resource is `{msg_vpn_name}/{kafka_receiver_name} "sha-256" - SHA-2 256 bits. "sha-512" - SHA-2 512 bits.-- `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_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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. diff --git a/docs/resources/msg_vpn_kafka_sender.md b/docs/resources/msg_vpn_kafka_sender.md index 88899a18..e228bc9f 100644 --- a/docs/resources/msg_vpn_kafka_sender.md +++ b/docs/resources/msg_vpn_kafka_sender.md @@ -33,17 +33,17 @@ The import identifier for this resource is `{msg_vpn_name}/{kafka_sender_name}`, ### Optional -- `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_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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_kerberos_keytab_content` (String, Sensitive) The base64-encoded content of this User Principal's keytab. 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 `""`. Available since SEMP API version 2.40. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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_kerberos_keytab_content` (String, Sensitive) The base64-encoded content of this User Principal's keytab. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.40. - `authentication_kerberos_keytab_file_name` (String) The name of this User Principal's keytab file. Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.40. - `authentication_kerberos_service_name` (String) The Kerberos service name of the remote Kafka broker, not including /hostname@REALM. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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.40. - `authentication_kerberos_user_principal_name` (String) The Kerberos user principal name of the Kafka Sender. This must include the @<REALM> suffix. Modifying this attribute while the object (or the 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 `""`. Available since SEMP API version 2.40. - `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_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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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: @@ -61,7 +61,7 @@ The import identifier for this resource is `{msg_vpn_name}/{kafka_sender_name}`, "sha-256" - SHA-2 256 bits. "sha-512" - SHA-2 512 bits."exclusive" - Exclusive delivery of messages to the first bound consumer flow. -"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion. +"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.Available since SEMP API version 2.4. - `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`. diff --git a/docs/resources/msg_vpn_topic_endpoint_template.md b/docs/resources/msg_vpn_topic_endpoint_template.md index 8153d670..8bf75aae 100644 --- a/docs/resources/msg_vpn_topic_endpoint_template.md +++ b/docs/resources/msg_vpn_topic_endpoint_template.md @@ -37,7 +37,7 @@ The import identifier for this resource is `{msg_vpn_name}/{topic_endpoint_templ"exclusive" - Exclusive delivery of messages to the first bound consumer flow. -"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion. +"non-exclusive" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.- `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`. - `dead_msg_queue` (String) The name of the Dead Message Queue (DMQ). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"#DEAD_MSG_QUEUE"`. diff --git a/docs/resources/oauth_profile.md b/docs/resources/oauth_profile.md index 490ec639..8b61e0ac 100644 --- a/docs/resources/oauth_profile.md +++ b/docs/resources/oauth_profile.md @@ -47,7 +47,7 @@ The import identifier for this resource is `{oauth_profile_name}`, where {<at - `client_redirect_uri` (String) The OAuth redirect URI. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `client_required_type` (String) The required value for the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"JWT"`. - `client_scope` (String) The OAuth scope. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"openid email"`. -- `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`). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. +- `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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `client_validate_type_enabled` (Boolean) Enable or disable verification of the TYP field in the ID token header. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `default_global_access_level` (String) The default global access level for this OAuth profile. 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/resources/proxy.md b/docs/resources/proxy.md index 18d5f422..b9f0b04b 100644 --- a/docs/resources/proxy.md +++ b/docs/resources/proxy.md @@ -35,7 +35,7 @@ The import identifier for this resource is `{proxy_name}`, where {<attribute& ### Optional -- `authentication_basic_password` (String, Sensitive) The password to use with basic authentication. 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 via config-sync. The default value is `""`. +- `authentication_basic_password` (String, Sensitive) The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `authentication_basic_username` (String) The username to use with basic authentication. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `authentication_scheme` (String) The authentication scheme used to connect to the proxy. 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/examples/sampleconfig.tf b/examples/sampleconfig.tf index 0bf0b56e..1087260f 100644 --- a/examples/sampleconfig.tf +++ b/examples/sampleconfig.tf @@ -6,10 +6,13 @@ terraform { } } -# Configure the provider +# Configure the provider provider "solacebroker" { + # Event broker management user credentials username = "admin" password = "admin" + # The base URL of the PubSub+ event broker, + # for example https://mybroker.example.org:url = "http://localhost:8080" } diff --git a/go.mod b/go.mod index 6c171461..f65bc0ee 100644 --- a/go.mod +++ b/go.mod @@ -1,6 +1,6 @@ module terraform-provider-solacebroker -go 1.22.4 +go 1.23.2 require ( github.com/hashicorp/go-retryablehttp v0.7.7 @@ -37,7 +37,7 @@ require ( github.com/containerd/log v0.1.0 // indirect github.com/cpuguy83/dockercfg v0.3.1 // indirect github.com/distribution/reference v0.5.0 // indirect - github.com/docker/docker v25.0.5+incompatible // indirect + github.com/docker/docker v25.0.6+incompatible // indirect github.com/docker/go-connections v0.5.0 // indirect github.com/docker/go-units v0.5.0 // indirect github.com/fatih/color v1.17.0 // indirect @@ -122,7 +122,7 @@ require ( golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect google.golang.org/appengine v1.6.8 // indirect google.golang.org/genproto/googleapis/rpc v0.0.0-20240610135401-a8a62080eff3 // indirect - google.golang.org/grpc v1.64.0 // indirect + google.golang.org/grpc v1.64.1 // indirect google.golang.org/protobuf v1.34.2 // indirect gopkg.in/yaml.v2 v2.4.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect diff --git a/go.sum b/go.sum index ade347a2..000a63a6 100644 --- a/go.sum +++ b/go.sum @@ -53,8 +53,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/distribution/reference v0.5.0 h1:/FUIFXtfc/x2gpa5/VGfiGLuOIdYa1t65IKK2OFGvA0= github.com/distribution/reference v0.5.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E= -github.com/docker/docker v25.0.5+incompatible h1:UmQydMduGkrD5nQde1mecF/YnSbTOaPeFIeP5C4W+DE= -github.com/docker/docker v25.0.5+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk= +github.com/docker/docker v25.0.6+incompatible h1:5cPwbwriIcsua2REJe8HqQV+6WlWc1byg2QSXzBxBGg= +github.com/docker/docker v25.0.6+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk= github.com/docker/go-connections v0.5.0 h1:USnMq7hx7gwdVZq1L49hLXaFtUdTADjXGp+uj1Br63c= github.com/docker/go-connections v0.5.0/go.mod h1:ov60Kzw0kKElRwhNs9UlUHAE/F9Fe6GLaXnqyDdmEXc= github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4= @@ -406,8 +406,8 @@ google.golang.org/genproto/googleapis/api v0.0.0-20240318140521-94a12d6c2237 h1: google.golang.org/genproto/googleapis/api v0.0.0-20240318140521-94a12d6c2237/go.mod h1:Z5Iiy3jtmioajWHDGFk7CeugTyHtPvMHA4UTmUkyalE= google.golang.org/genproto/googleapis/rpc v0.0.0-20240610135401-a8a62080eff3 h1:9Xyg6I9IWQZhRVfCWjKK+l6kI0jHcPesVlMnT//aHNo= google.golang.org/genproto/googleapis/rpc v0.0.0-20240610135401-a8a62080eff3/go.mod h1:EfXuqaE1J41VCDicxHzUDm+8rk+7ZdXzHV0IhO/I6s0= -google.golang.org/grpc v1.64.0 h1:KH3VH9y/MgNQg1dE7b3XfVK0GsPSIzJwdF617gUSbvY= -google.golang.org/grpc v1.64.0/go.mod h1:oxjF8E3FBnjp+/gVFYdWacaLDx9na1aqy9oovLpxQYg= +google.golang.org/grpc v1.64.1 h1:LKtvyfbX3UGVPFcGqJ9ItpVWW6oN/2XqTxfAnwRRXiA= +google.golang.org/grpc v1.64.1/go.mod h1:hiQF4LFZelK2WKaP6W0L92zGHtiQdZxk8CrSdvyjeP0= 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.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg= diff --git a/internal/broker/generated/Broker.go b/internal/broker/generated/Broker.go index 994f3329..527e9b33 100644 --- a/internal/broker/generated/Broker.go +++ b/internal/broker/generated/Broker.go @@ -2002,7 +2002,7 @@ func init() { BaseType: broker.String, SempName: "tlsServerCertContent", TerraformName: "tls_server_cert_content", - MarkdownDescription: "The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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`). The default value is `\"\"`.", + MarkdownDescription: "The PEM formatted content for the server certificate used for TLS connections. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -2016,7 +2016,7 @@ func init() { BaseType: broker.String, SempName: "tlsServerCertPassword", TerraformName: "tls_server_cert_password", - MarkdownDescription: "The password for the server certificate used for TLS connections. 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`). The default value is `\"\"`.", + MarkdownDescription: "The password for the server certificate used for TLS connections. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`.", Sensitive: true, Requires: []string{"tls_server_cert_content"}, Type: types.StringType, diff --git a/internal/broker/generated/DmrCluster.go b/internal/broker/generated/DmrCluster.go index 82b9b76e..ecdae3eb 100644 --- a/internal/broker/generated/DmrCluster.go +++ b/internal/broker/generated/DmrCluster.go @@ -49,7 +49,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - MarkdownDescription: "The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. 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 via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password used to authenticate incoming Cluster Links when using basic internal authentication. The same password is also used by outgoing Cluster Links if a per-Link password is not configured. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may 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 `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -76,7 +76,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertContent", TerraformName: "authentication_client_cert_content", - MarkdownDescription: "The PEM formatted content for the client certificate used to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 to login to the remote node. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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, @@ -100,7 +100,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. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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, diff --git a/internal/broker/generated/DmrClusterLink.go b/internal/broker/generated/DmrClusterLink.go index 1694539c..621ad2a5 100644 --- a/internal/broker/generated/DmrClusterLink.go +++ b/internal/broker/generated/DmrClusterLink.go @@ -39,7 +39,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - MarkdownDescription: "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. 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 via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password used to authenticate with the remote node when using basic internal authentication. If this per-Link password is not configured, the Cluster's password is used instead. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may 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 `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, diff --git a/internal/broker/generated/MsgVpn.go b/internal/broker/generated/MsgVpn.go index d6c5caa5..13aeb02e 100644 --- a/internal/broker/generated/MsgVpn.go +++ b/internal/broker/generated/MsgVpn.go @@ -1927,7 +1927,7 @@ func init() { BaseType: broker.String, SempName: "replicationBridgeAuthenticationBasicPassword", TerraformName: "replication_bridge_authentication_basic_password", - MarkdownDescription: "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 via config-sync. The default value is `\"\"`.", + MarkdownDescription: "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", Sensitive: true, Requires: []string{"replication_bridge_authentication_basic_client_username"}, Type: types.StringType, @@ -1945,7 +1945,7 @@ func init() { BaseType: broker.String, SempName: "replicationBridgeAuthenticationClientCertContent", TerraformName: "replication_bridge_authentication_client_cert_content", - MarkdownDescription: "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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`). The default value is `\"\"`. Available since SEMP API version 2.9.", + MarkdownDescription: "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`. Available since SEMP API version 2.9.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -1959,7 +1959,7 @@ func init() { BaseType: broker.String, SempName: "replicationBridgeAuthenticationClientCertPassword", TerraformName: "replication_bridge_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`). The default value is `\"\"`. Available since SEMP API version 2.9.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). The default value is `\"\"`. Available since SEMP API version 2.9.", Sensitive: true, Requires: []string{"replication_bridge_authentication_client_cert_content"}, Type: types.StringType, @@ -2060,7 +2060,7 @@ func init() { BaseType: broker.String, SempName: "replicationEnabledQueueBehavior", TerraformName: "replication_enabled_queue_behavior", - MarkdownDescription: "The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. 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 via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are:\n\n \n\"fail-on-existing-queue\" - The data replication queue must not already exist.\n\"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail.\n\"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications.\n\n", + MarkdownDescription: "The behavior to take when enabling replication for the Message VPN, depending on the existence of the replication Queue. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"fail-on-existing-queue\"`. The allowed values and their meaning are:\n\n\n\"fail-on-existing-queue\" - The data replication queue must not already exist.\n\"force-use-existing-queue\" - The data replication queue must already exist. Any data messages on the Queue will be forwarded to interested applications. IMPORTANT: Before using this mode be certain that the messages are not stale or otherwise unsuitable to be forwarded. This mode can only be specified when the existing queue is configured the same as is currently specified under replication configuration otherwise the enabling of replication will fail.\n\"force-recreate-queue\" - The data replication queue must already exist. Any data messages on the Queue will be discarded. IMPORTANT: Before using this mode be certain that the messages on the existing data replication queue are not needed by interested applications.\n\n", Sensitive: true, Requires: []string{"replication_enabled"}, Type: types.StringType, diff --git a/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go b/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go index cb0e6199..67867742 100644 --- a/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go +++ b/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go @@ -90,7 +90,7 @@ func init() { BaseType: broker.String, SempName: "clientSecret", TerraformName: "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`). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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, diff --git a/internal/broker/generated/MsgVpnAuthorizationGroup.go b/internal/broker/generated/MsgVpnAuthorizationGroup.go index fba7d26a..7d56cb6a 100644 --- a/internal/broker/generated/MsgVpnAuthorizationGroup.go +++ b/internal/broker/generated/MsgVpnAuthorizationGroup.go @@ -107,7 +107,7 @@ func init() { BaseType: broker.String, SempName: "orderAfterAuthorizationGroupName", TerraformName: "order_after_authorization_group_name", - MarkdownDescription: "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.", + MarkdownDescription: "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", Sensitive: true, ConflictsWith: []string{"order_before_authorization_group_name"}, Type: types.StringType, @@ -124,7 +124,7 @@ func init() { BaseType: broker.String, SempName: "orderBeforeAuthorizationGroupName", TerraformName: "order_before_authorization_group_name", - MarkdownDescription: "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.", + MarkdownDescription: "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is not applicable.", Sensitive: true, ConflictsWith: []string{"order_after_authorization_group_name"}, Type: types.StringType, diff --git a/internal/broker/generated/MsgVpnBridge.go b/internal/broker/generated/MsgVpnBridge.go index 3c5f9d1f..0f85dddd 100644 --- a/internal/broker/generated/MsgVpnBridge.go +++ b/internal/broker/generated/MsgVpnBridge.go @@ -128,7 +128,7 @@ func init() { BaseType: broker.String, SempName: "remoteAuthenticationBasicPassword", TerraformName: "remote_authentication_basic_password", - MarkdownDescription: "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`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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 Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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{"remote_authentication_basic_client_username"}, Type: types.StringType, @@ -146,7 +146,7 @@ func init() { BaseType: broker.String, SempName: "remoteAuthenticationClientCertContent", TerraformName: "remote_authentication_client_cert_content", - MarkdownDescription: "The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 `\"\"`. Available since SEMP API version 2.9.", + MarkdownDescription: "The PEM formatted content for the client certificate used by the Bridge to login to the remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since SEMP API version 2.9.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -160,7 +160,7 @@ func init() { BaseType: broker.String, SempName: "remoteAuthenticationClientCertPassword", TerraformName: "remote_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 `\"\"`. Available since SEMP API version 2.9.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since SEMP API version 2.9.", Sensitive: true, Requires: []string{"remote_authentication_client_cert_content"}, Type: types.StringType, diff --git a/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go b/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go index e5f4eaa7..912eeb51 100644 --- a/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go +++ b/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go @@ -153,7 +153,7 @@ func init() { BaseType: broker.String, SempName: "password", TerraformName: "password", - MarkdownDescription: "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`). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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 Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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{"client_username"}, Type: types.StringType, diff --git a/internal/broker/generated/MsgVpnClientUsername.go b/internal/broker/generated/MsgVpnClientUsername.go index 31773931..ac44b3b5 100644 --- a/internal/broker/generated/MsgVpnClientUsername.go +++ b/internal/broker/generated/MsgVpnClientUsername.go @@ -117,7 +117,7 @@ func init() { BaseType: broker.String, SempName: "password", TerraformName: "password", - MarkdownDescription: "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 `\"\"`.", + MarkdownDescription: "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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, diff --git a/internal/broker/generated/MsgVpnJndiConnectionFactory.go b/internal/broker/generated/MsgVpnJndiConnectionFactory.go index f65180bc..399efbd5 100644 --- a/internal/broker/generated/MsgVpnJndiConnectionFactory.go +++ b/internal/broker/generated/MsgVpnJndiConnectionFactory.go @@ -286,6 +286,19 @@ func init() { Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, Default: false, }, + { + BaseType: broker.Int64, + SempName: "messagingPayloadCompressionLevel", + TerraformName: "messaging_payload_compression_level", + MarkdownDescription: "The level of compression to apply to the message payload, from 1 (least compression) to 9 (most compression). A value of 0 means no compression. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since SEMP API version 2.42.", + Type: types.Int64Type, + TerraformType: tftypes.Number, + Converter: broker.IntegerConverter{}, + Int64Validators: []validator.Int64{ + int64validator.Between(0, 9), + }, + Default: 0, + }, { BaseType: broker.Bool, SempName: "messagingTextInXmlPayloadEnabled", diff --git a/internal/broker/generated/MsgVpnKafkaReceiver.go b/internal/broker/generated/MsgVpnKafkaReceiver.go index 175fdbeb..3c6dc558 100644 --- a/internal/broker/generated/MsgVpnKafkaReceiver.go +++ b/internal/broker/generated/MsgVpnKafkaReceiver.go @@ -39,7 +39,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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, @@ -70,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. 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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, @@ -84,7 +84,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertPassword", TerraformName: "authentication_client_cert_password", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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, @@ -102,7 +102,7 @@ func init() { BaseType: broker.String, SempName: "authenticationKerberosKeytabContent", TerraformName: "authentication_kerberos_keytab_content", - MarkdownDescription: "The base64-encoded content of this User Principal's keytab. 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 `\"\"`. Available since SEMP API version 2.40.", + MarkdownDescription: "The base64-encoded content of this User Principal's keytab. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since SEMP API version 2.40.", Sensitive: true, Requires: []string{"authentication_kerberos_keytab_file_name", "authentication_kerberos_user_principal_name"}, Type: types.StringType, @@ -197,7 +197,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientSecret", TerraformName: "authentication_oauth_client_secret", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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, @@ -251,7 +251,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramPassword", TerraformName: "authentication_scram_password", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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, diff --git a/internal/broker/generated/MsgVpnKafkaSender.go b/internal/broker/generated/MsgVpnKafkaSender.go index 14541af2..3a77958e 100644 --- a/internal/broker/generated/MsgVpnKafkaSender.go +++ b/internal/broker/generated/MsgVpnKafkaSender.go @@ -39,7 +39,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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, @@ -70,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. 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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, @@ -84,7 +84,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertPassword", TerraformName: "authentication_client_cert_password", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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, @@ -102,7 +102,7 @@ func init() { BaseType: broker.String, SempName: "authenticationKerberosKeytabContent", TerraformName: "authentication_kerberos_keytab_content", - MarkdownDescription: "The base64-encoded content of this User Principal's keytab. 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 `\"\"`. Available since SEMP API version 2.40.", + MarkdownDescription: "The base64-encoded content of this User Principal's keytab. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since SEMP API version 2.40.", Sensitive: true, Requires: []string{"authentication_kerberos_keytab_file_name", "authentication_kerberos_user_principal_name"}, Type: types.StringType, @@ -197,7 +197,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientSecret", TerraformName: "authentication_oauth_client_secret", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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, @@ -251,7 +251,7 @@ func init() { BaseType: broker.String, SempName: "authenticationScramPassword", TerraformName: "authentication_scram_password", - 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 `\"\"`.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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, diff --git a/internal/broker/generated/MsgVpnProxy.go b/internal/broker/generated/MsgVpnProxy.go index 5e2bc9d4..295de393 100644 --- a/internal/broker/generated/MsgVpnProxy.go +++ b/internal/broker/generated/MsgVpnProxy.go @@ -38,7 +38,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - MarkdownDescription: "The password to use with basic authentication. 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 via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go index 714a81b2..4aece01c 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go @@ -53,7 +53,7 @@ func init() { BaseType: broker.String, SempName: "headerValue", TerraformName: "header_value", - MarkdownDescription: "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 `\"\"`.", + MarkdownDescription: "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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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, diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go index 36273a31..5b61a6a4 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go @@ -66,7 +66,7 @@ func init() { BaseType: broker.String, SempName: "authenticationAwsSecretAccessKey", TerraformName: "authentication_aws_secret_access_key", - MarkdownDescription: "The AWS secret access key. 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 `\"\"`. Available since SEMP API version 2.26.", + MarkdownDescription: "The AWS secret access key. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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.26.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -93,7 +93,7 @@ func init() { BaseType: broker.String, SempName: "authenticationClientCertContent", TerraformName: "authentication_client_cert_content", - MarkdownDescription: "The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. 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 `\"\"`. Available since SEMP API version 2.9.", + MarkdownDescription: "The PEM formatted content for the client certificate that the REST Consumer will present to the REST host. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since SEMP API version 2.9.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -107,7 +107,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 `\"\"`. Available since SEMP API version 2.9.", + 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 [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the 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 `\"\"`. Available since SEMP API version 2.9.", Sensitive: true, Requires: []string{"authentication_client_cert_content"}, Type: types.StringType, @@ -125,7 +125,7 @@ func init() { BaseType: broker.String, SempName: "authenticationHttpBasicPassword", TerraformName: "authentication_http_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. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to 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_http_basic_username"}, Type: types.StringType, @@ -174,7 +174,7 @@ func init() { BaseType: broker.String, SempName: "authenticationHttpHeaderValue", TerraformName: "authentication_http_header_value", - MarkdownDescription: "The authentication header value. 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 `\"\"`. Available since SEMP API version 2.15.", + MarkdownDescription: "The authentication header value. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). 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.15.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -198,6 +198,19 @@ func init() { }, Default: "", }, + { + BaseType: broker.String, + SempName: "authenticationOauthClientProxyName", + TerraformName: "authentication_oauth_client_proxy_name", + MarkdownDescription: "The name of the proxy to use. Leave empty for no proxy. 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.42.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 32), + }, + Default: "", + }, { BaseType: broker.String, SempName: "authenticationOauthClientScope", @@ -215,7 +228,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 `\"\"`. Available since SEMP API version 2.19.", + MarkdownDescription: "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, @@ -229,7 +242,7 @@ func init() { BaseType: broker.String, SempName: "authenticationOauthClientTokenEndpoint", TerraformName: "authentication_oauth_client_token_endpoint", - MarkdownDescription: "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. 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 `\"\"`. Available since SEMP API version 2.19.", + MarkdownDescription: "The OAuth token endpoint URL that the REST Consumer will use to request a token for login to the REST host. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -251,11 +264,24 @@ func init() { }, Default: 900, }, + { + BaseType: broker.String, + SempName: "authenticationOauthJwtProxyName", + TerraformName: "authentication_oauth_jwt_proxy_name", + MarkdownDescription: "The name of the proxy to use. Leave empty for no proxy. 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.42.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 32), + }, + Default: "", + }, { BaseType: broker.String, SempName: "authenticationOauthJwtSecretKey", TerraformName: "authentication_oauth_jwt_secret_key", - MarkdownDescription: "The OAuth secret key used to sign the token request JWT. 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 `\"\"`. Available since SEMP API version 2.21.", + MarkdownDescription: "The OAuth secret key used to sign the token request JWT. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. 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.21.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, diff --git a/internal/broker/generated/MsgVpnSequencedTopic.go b/internal/broker/generated/MsgVpnSequencedTopic.go index 596da20b..9805a367 100644 --- a/internal/broker/generated/MsgVpnSequencedTopic.go +++ b/internal/broker/generated/MsgVpnSequencedTopic.go @@ -28,7 +28,7 @@ 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\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\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 SEMP API version 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}", PostPathTemplate: "/msgVpns/{msgVpnName}/sequencedTopics", @@ -38,11 +38,12 @@ func init() { BaseType: broker.String, SempName: "msgVpnName", TerraformName: "msg_vpn_name", - MarkdownDescription: "The name of the Message VPN.", + MarkdownDescription: "The name of the Message VPN. Deprecated since SEMP API version 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", Identifying: true, Required: true, ReadOnly: true, RequiresReplace: true, + Deprecated: true, Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, @@ -55,10 +56,11 @@ func init() { BaseType: broker.String, SempName: "sequencedTopic", TerraformName: "sequenced_topic", - MarkdownDescription: "Topic for applying sequence numbers.", + MarkdownDescription: "Topic for applying sequence numbers. Deprecated since SEMP API version 2.42. Primarily used by SolCache-RS which has been replaced by the Replay feature.", Identifying: true, Required: true, RequiresReplace: true, + Deprecated: true, Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, diff --git a/internal/broker/generated/MsgVpnTopicEndpoint.go b/internal/broker/generated/MsgVpnTopicEndpoint.go index e7b96671..3dbe02f2 100644 --- a/internal/broker/generated/MsgVpnTopicEndpoint.go +++ b/internal/broker/generated/MsgVpnTopicEndpoint.go @@ -39,7 +39,7 @@ func init() { BaseType: broker.String, SempName: "accessType", TerraformName: "access_type", - MarkdownDescription: "The access type for delivering messages to consumer flows bound to the Topic Endpoint. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egress_enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n\n Available since SEMP API version 2.4.", + MarkdownDescription: "The access type for delivering messages to consumer flows bound to the Topic Endpoint. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as egress_enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.\n\n Available since SEMP API version 2.4.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, diff --git a/internal/broker/generated/MsgVpnTopicEndpointTemplate.go b/internal/broker/generated/MsgVpnTopicEndpointTemplate.go index 818598f7..d588d28a 100644 --- a/internal/broker/generated/MsgVpnTopicEndpointTemplate.go +++ b/internal/broker/generated/MsgVpnTopicEndpointTemplate.go @@ -39,7 +39,7 @@ func init() { BaseType: broker.String, SempName: "accessType", TerraformName: "access_type", - MarkdownDescription: "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin (if partition count is zero) or partitioned (if partition count is non-zero) fashion.\n\n", + MarkdownDescription: "The access type for delivering messages to consumer flows. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"exclusive\"`. The allowed values and their meaning are:\n\n\n\"exclusive\" - Exclusive delivery of messages to the first bound consumer flow.\n\"non-exclusive\" - Non-exclusive delivery of messages to bound consumer flows in a round-robin fashion.\n\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, diff --git a/internal/broker/generated/OauthProfile.go b/internal/broker/generated/OauthProfile.go index 94c08983..fe4bf4c9 100644 --- a/internal/broker/generated/OauthProfile.go +++ b/internal/broker/generated/OauthProfile.go @@ -116,7 +116,7 @@ func init() { BaseType: broker.String, SempName: "clientSecret", TerraformName: "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`). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The OAuth client secret. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, diff --git a/internal/broker/generated/Proxy.go b/internal/broker/generated/Proxy.go index 588b2061..38d9aa7e 100644 --- a/internal/broker/generated/Proxy.go +++ b/internal/broker/generated/Proxy.go @@ -38,7 +38,7 @@ func init() { BaseType: broker.String, SempName: "authenticationBasicPassword", TerraformName: "authentication_basic_password", - MarkdownDescription: "The password to use with basic authentication. 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 via config-sync. The default value is `\"\"`.", + MarkdownDescription: "The password to use with basic authentication. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions [here](https://docs.solace.com/Admin/SEMP/SEMP-API-Archit.htm#HTTP_Methods). Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", Sensitive: true, Type: types.StringType, TerraformType: tftypes.String, diff --git a/internal/broker/generated/VersionDetails.go b/internal/broker/generated/VersionDetails.go index 01196d99..5674e6fe 100644 --- a/internal/broker/generated/VersionDetails.go +++ b/internal/broker/generated/VersionDetails.go @@ -19,7 +19,7 @@ package generated import "terraform-provider-solacebroker/internal/broker" const BasePath = "/SEMP/v2/config" -const SempVersion = "2.41" +const SempVersion = "2.42" const Platform = "VMR" func init() { diff --git a/internal/semp/client.go b/internal/semp/client.go index 3635c683..a0ae4868 100644 --- a/internal/semp/client.go +++ b/internal/semp/client.go @@ -101,6 +101,7 @@ func NewClient(url string, insecure_skip_verify bool, providerClient bool, optio tr := &http.Transport{ TLSClientConfig: &tls.Config{InsecureSkipVerify: insecure_skip_verify}, MaxIdleConnsPerHost: 10, + Proxy: http.ProxyFromEnvironment, } retryClient := retryablehttp.NewClient() retryClient.HTTPClient.Transport = tr diff --git a/templates/guides/provider.md b/templates/guides/provider.md index df1a4ab8..2d6a4a2e 100644 --- a/templates/guides/provider.md +++ b/templates/guides/provider.md @@ -86,6 +86,8 @@ Generally, changing a "required" attribute requires the replace of any resource ## Importing Resources +Import shall be used to take resources you have created by some other means and bring them under Terraform management. + When [importing a resource](https://developer.hashicorp.com/terraform/cli/commands/import) to Terraform, an [ID or import identifier](https://developer.hashicorp.com/terraform/language/import#import-id) is required. Use the navigation to the left to look up the provider import identifier for the required resource. We recommend using the following procedure to import a resource: diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 31e1b3d4..5a5858ff 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -39,6 +39,27 @@ The minimum required PubSub+ Software Event Broker version is 10.4. -> 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. +## HTTP Proxy Support + +This provider supports the use of HTTP proxies through environment variables. + +The environment variables for HTTP proxy configuration are: +* `HTTP_PROXY`: Use to set the proxy when `http://` protocol is specified in the target broker URL in the provider configuration. +* `HTTPS_PROXY`: Use to set the proxy when secure `https://` protocol is specified in the target broker URL in the provider configuration. +* `NO_PROXY`: Comma separated list of broker address domains that should bypass the proxy. + +To set the proxy, specify the proxy protocol, FQDN address and port. If `https://` proxy protocol is specified then secure TLS connection will be used between the provider and the proxy. Username and password can be optionally specified for proxy authorization. + +Examples: +```shell +# Plain text connection to the target broker via proxy +HTTP_PROXY=http://proxy:port +# Set up TLS tunnel from the provider through the proxy server to reach the broker via secure connection. Note the 'http' proxy protocol specified. +HTTPS_PROXY=http://proxy:port +# As above, additionally uses proxy authentication and secure TLS connection from the provider to the proxy server +HTTPS_PROXY=https://username:password@proxy:port +``` + # Release Notes and History For detailed release notes and release history, see [this link](https://products.solace.com/download/DSEMP_TERRAFORM_SW_BROKER_PROVIDER_RN) and the Releases section in the [Provider GitHub repository](https://github.com/SolaceProducts/terraform-provider-solacebroker/releases). diff --git a/version.go b/version.go index b6d02509..3c9300ba 100644 --- a/version.go +++ b/version.go @@ -16,4 +16,4 @@ package main -const version = "1.0.1" +const version = "1.1.0"